Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Cleanup the doc pages of the community pickers #7339

Merged

Conversation

flaviendelangle
Copy link
Member

@flaviendelangle flaviendelangle commented Dec 29, 2022

A lot of small changes to unify the doc of the Date Picker, Time Picker and Date Time Picker.
I'll keep the Date Range Picker for later, as it needs a Date Range Calendar dedicated page.

The Date Picker page still have 2 demos I'd like to move to other pages (the helper text and the custom input one).
But I think this PR is big enough as it is.

@flaviendelangle flaviendelangle self-assigned this Dec 29, 2022
@flaviendelangle flaviendelangle added docs Improvements or additions to the documentation component: pickers This is the name of the generic UI component, not the React module! labels Dec 29, 2022
@mui-bot
Copy link

mui-bot commented Dec 29, 2022

Messages
📖 Netlify deploy preview: https://deploy-preview-7339--material-ui-x.netlify.app/

These are the results for the performance tests:

Test case Unit Min Max Median Mean σ
Filter 100k rows ms 633.8 1,505.7 633.8 980.2 291.826
Sort 100k rows ms 722.5 1,461.7 722.5 1,074.08 283.485
Select 100k rows ms 209.6 324.2 309.1 275.22 50.333
Deselect 100k rows ms 159.6 384.8 311.3 296.18 77.104

Generated by 🚫 dangerJS against c1492ed

@@ -6,7 +6,7 @@ import { Unstable_StaticNextDatePicker as StaticNextDatePicker } from '@mui/x-da
export default function StaticDatePickerDemo() {
return (
<LocalizationProvider dateAdapter={AdapterDayjs}>
<StaticNextDatePicker displayStaticWrapperAs="desktop" />
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that we have dedicated pages for the view components, I think that the static demos should display the toolbar, otherwise the diff between the two components is hard to understand.

docs/data/date-pickers/fields/fields.md Show resolved Hide resolved
@flaviendelangle flaviendelangle marked this pull request as ready for review December 29, 2022 11:21
Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work aligning the different docs together! 🚀 💯

We could consider also having component word here as well 🤔
Same applies to the time picker doc.
Screenshot 2022-12-30 at 09 15 03

docs/data/date-pickers/date-picker/date-picker.md Outdated Show resolved Hide resolved
docs/data/date-pickers/date-picker/date-picker.md Outdated Show resolved Hide resolved
docs/data/date-pickers/date-picker/date-picker.md Outdated Show resolved Hide resolved
docs/data/date-pickers/time-picker/time-picker.md Outdated Show resolved Hide resolved
docs/data/date-pickers/time-picker/time-picker.md Outdated Show resolved Hide resolved
Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me overall the new approach shown on date picker page seems like the most cohesive and if it were my decision—I'd go forth with updating other pages.
But we could also possibly wait/ask for @joserodolfofreitas opinion on this refactor/restructure. 🤔

docs/data/date-pickers/date-picker/date-picker.md Outdated Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented Jan 3, 2023

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 3, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 3, 2023
Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM other than those few nitpicks with time picker page/demos and the still unanswered question with position: 'relative'... 🙈

docs/data/date-pickers/time-picker/time-picker.md Outdated Show resolved Hide resolved
docs/data/date-pickers/time-picker/TimePickerViews.js Outdated Show resolved Hide resolved
@flaviendelangle flaviendelangle merged commit d67fa0b into mui:next Jan 4, 2023
@flaviendelangle flaviendelangle deleted the communiy-pickers-doc-cleanup branch January 4, 2023 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: pickers This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants