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] Complet instructions for pickers installation in readme #4852

Merged
merged 4 commits into from
May 13, 2022

Conversation

alexfauquette
Copy link
Member

Fix #4849

@mui-bot
Copy link

mui-bot commented May 12, 2022

These are the results for the performance tests:

Test case Unit Min Max Median Mean σ
Filter 100k rows ms 252.3 460.7 343.2 362.12 73.912
Sort 100k rows ms 441 875.4 741.7 710.02 145.558
Select 100k rows ms 123.7 172.8 163.7 152.8 19.256
Deselect 100k rows ms 99.8 197.2 147.2 142.72 31.97

Generated by 🚫 dangerJS against 4f5e20b

@alexfauquette alexfauquette self-assigned this May 12, 2022
@@ -26,6 +26,45 @@ This component has the following peer dependencies that you will need to install
},
```

You need to provide a date-library that is used by the pickers by setting the `dateAdapter` to an adapter of your choosing.

We currently support 4 different date-libraries:
Copy link
Member

Choose a reason for hiding this comment

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

I think this statement is misleading (even if we already have it in the doc)

We re-export 4 adapters, and I guess we can say that we officially support only those 4 and that the others can be considered as less safe.

But we have users on Moment Hijiri, Moment Jalaali, Date Fns Jalali and JS Joda.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm even wondering why are we re-exporting those Adapters? It would be easier to say that we use @date-io adapters and let developers import the adapter from date-io

Copy link
Member

Choose a reason for hiding this comment

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

Probably so that people only have one package to install.
It was already the case in material-ui-pickers

I guess that's something we could revise in the future

Copy link
Member Author

Choose a reason for hiding this comment

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

I added a sentence to notify the other libraries supported by @date-io

I noticed that adapters are in the dependencies. So I assume installing @mui/x-date-picker also install the 4 @date-io/xxx package.

The next instruction should not be npm install @date-io/date-fns but npm install date-fns

@alexfauquette alexfauquette merged commit f90a012 into mui:master May 13, 2022
@alexfauquette alexfauquette deleted the readme-installation branch May 13, 2022 13:51
alexfauquette added a commit to alexfauquette/mui-x that referenced this pull request Aug 26, 2022
@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Jan 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[pickers] Instructions for installing the package are not complete on the README
4 participants