[docs] Refactor Pickers Localization documentation sections
#11989
Conversation
LukasTy
added
docs
|
Deploy preview: https://deploy-preview-11989--material-ui-x.netlify.app/ Updated pages: |
| @@ -32,11 +32,14 @@ Learn more about the _Controlled and uncontrolled_ pattern in the [React documen | |||
|
|
|||
| {{"demo": "CustomDateFormat.js"}} | |||
|
|
|||
| :::info | |||
There was a problem hiding this comment.
IMHO this demo should either not exist or be inside the "Localization" section below
THis would help people understand that the custom date format is part of the the Localization in our doc
There was a problem hiding this comment.
Initially, I was leaning towards that direction, but then I thought that the various custom formats for different components (date, time, and date-time) have lots of examples. If we want to provide at least a similar amount of demos in the Custom format section, it would be huge. 🤯
That's why I decided to keep the separate section. 🤔
WDYT?
Would moving those Customize the <x> format sections as sub-sections of Localization make more sense to you?
There was a problem hiding this comment.
@flaviendelangle I've moved the Customize the format sections as subsections of Localization.
Let me know what you think. 😉
There was a problem hiding this comment.
I can be a good trade-off 👌
There was a problem hiding this comment.
This can be a great use-case for a switch like github does it on their webhook documentation:
There was a problem hiding this comment.
In the sense that you could provide a few options to select formats and then the fields will use that. WDYT?
There was a problem hiding this comment.
That is a great suggestion, I'll explore that option. 👌
There was a problem hiding this comment.
@michelengelen I've explored that possibility but felt that the increased complexity and worse demo code readability didn't help. 🤔
If we wanted it to be useful, we'd need to have an elaborate demo with code preview. 🙈
I think that for starters this improvement should be useful enough. 🤞
| @@ -32,11 +32,14 @@ Learn more about the _Controlled and uncontrolled_ pattern in the [React documen | |||
|
|
|||
| {{"demo": "CustomDateFormat.js"}} | |||
|
|
|||
| :::info | |||
There was a problem hiding this comment.
I can be a good trade-off 👌
LukasTy
added
the
needs cherry-pick
LukasTy
changed the title
Localization documentation sectionsLocalization documentation sections
Resolve topics discussed in https://mui-org.slack.com/archives/C04U3R2V9UK/p1707325208275059
Localization&Validationsection in all Picker component pagesCustomize the <x> formatsections to theCustom formatdocumentation sectiondefaultValueinstead ofcontrolled valueValidationsection copyright consistentLocalizationsection copyright