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] Add support for API pages of unstable components #6981

Merged
merged 2 commits into from
Nov 24, 2022

Conversation

flaviendelangle
Copy link
Member

@flaviendelangle flaviendelangle commented Nov 24, 2022

Fixes #6695

@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 Nov 24, 2022
@flaviendelangle flaviendelangle self-assigned this Nov 24, 2022
const projectsWithThisComponent = allProjectsName.filter((projectName) => {
const currenetProject = projects.get(projectName) as Project;
const symbol = currenetProject.exports[reactApi.name];
reactApi.packages = Array.from(projects.keys())
Copy link
Member Author

Choose a reason for hiding this comment

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

This modification allow to have the correct import with Unstable_ on the api page

Copy link
Member

Choose a reason for hiding this comment

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

You probably meant this modification? 🤔

Copy link
Member Author

Choose a reason for hiding this comment

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

The whole block

We need to get the symbol (otherwise we have no import at all on the api page) and we need to pass the name of the export (otherwise the import would not have the Unstable_ prefix)

@@ -4,27 +4,91 @@

## Components

- [DateCalendar](/x/api/date-pickers/date-calendar/)
### Pickers
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 the unstable components and ordered everything because it was becoming impossible to read

@mui-bot
Copy link

mui-bot commented Nov 24, 2022

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

These are the results for the performance tests:

Test case Unit Min Max Median Mean σ
Filter 100k rows ms 654.5 947.8 814.4 791.9 99.251
Sort 100k rows ms 642.2 1,068 642.2 923.92 151.655
Select 100k rows ms 202.8 300.7 229.5 244.62 39.446
Deselect 100k rows ms 156.3 295.5 161.2 195.52 53.633

Generated by 🚫 dangerJS against dacd584

@flaviendelangle flaviendelangle marked this pull request as ready for review November 24, 2022 10:45
const projectsWithThisComponent = allProjectsName.filter((projectName) => {
const currenetProject = projects.get(projectName) as Project;
const symbol = currenetProject.exports[reactApi.name];
reactApi.packages = Array.from(projects.keys())
Copy link
Member

Choose a reason for hiding this comment

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

You probably meant this modification? 🤔

docs/src/modules/components/ApiPage.js Show resolved Hide resolved
@flaviendelangle flaviendelangle merged commit 522b138 into mui:next Nov 24, 2022
@flaviendelangle flaviendelangle deleted the unstable-doc branch November 24, 2022 12:46
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.

[docs] The nested imports from X should be named imports on api page
3 participants