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.

Sign up for GitHub

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

Jump to bottom

[docs] Add the slots concept introduction page #13881

Merged
merged 43 commits into from
Sep 4, 2024
Merged

[docs] Add the slots concept introduction page #13881

merged 43 commits into from
Sep 4, 2024

Conversation

flaviendelangle
Copy link
Member

@flaviendelangle flaviendelangle commented Jul 18, 2024 •
edited
Loading

Closes #13354
Doc preview

Todo

  • Add PropsFromSlot to charts and tree view
  • Create the issues to add module augmentation on every package

@flaviendelangle flaviendelangle added the docs Improvements or additions to the documentation label Jul 18, 2024
@flaviendelangle flaviendelangle self-assigned this Jul 18, 2024
@mui-bot
Copy link

mui-bot commented Jul 18, 2024 •
edited
Loading

Deploy preview: https://deploy-preview-13881--material-ui-x.netlify.app/

Updated pages:

Generated by 🚫 dangerJS against 4cba94a

@flaviendelangle flaviendelangle mentioned this pull request Jul 24, 2024
Merged
flaviendelangle
flaviendelangle commented Jul 24, 2024
View reviewed changes
docs/data/data-grid/components/components.md
## Slot props

To override default props or pass custom props to slot components, use the `slotProps` prop.
## Custom slot props with TypeScript
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 kept the module augmentation doc here for now because only the grid has it so it felt weird to movie it fully to the shared page.

docs/data/pages.ts
@@ -21,6 +20,13 @@ const pages: MuiPage[] = [
{ pathname: `/x/introduction/roadmap` },
],
},
{
pathname: '/x/common-features-group',
Copy link
Member Author

Choose a reason for hiding this comment

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

Do we have other pages to move here?
It felt weird to me to put this in "Introduction", which is why I chose to create a new folder

Copy link
Member

Choose a reason for hiding this comment

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

Maybe the loacalization. Even if it's not yet supported for chart

Copy link
Member Author

Choose a reason for hiding this comment

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

Might make sense at some point indeed
I was thinking about existing pages, but for new pages it's definitely a good candidate once we have at least 3 sets of components supporting it.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 25, 2024
@github-actions GitHub Actions
Copy link

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

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 26, 2024
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Aug 19, 2024
@github-actions GitHub Actions
Copy link

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

@github-actions github-actions bot added PR: out-of-date The pull request has merge conflicts and can't be merged and removed PR: out-of-date The pull request has merge conflicts and can't be merged labels Aug 19, 2024
@github-actions GitHub Actions
Copy link

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

@flaviendelangle flaviendelangle mentioned this pull request Sep 2, 2024
Closed
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Sep 2, 2024
@flaviendelangle flaviendelangle merged commit d7e51c0 into mui:master Sep 4, 2024
18 checks passed
@flaviendelangle flaviendelangle deleted the docs-slots branch September 4, 2024 10:01
This was referenced Sep 27, 2024
Open
Open
Open
arthurbalduini pushed a commit to arthurbalduini/mui-x that referenced this pull request Sep 30, 2024
@flaviendelangle @cherniavskii @LukasTy
[docs] Add the slots concept introduction page (mui#13881)
37e35f1 
Signed-off-by: Flavien DELANGLE <flaviendelangle@gmail.com>
Co-authored-by: Andrew Cherniavskii <andrew.cherniavskii@gmail.com>
Co-authored-by: Lukas Tyla <llukas.tyla@gmail.com>
This was referenced Oct 3, 2024
Open
Open
Open
@mbreadmachine mbreadmachine mentioned this pull request Oct 5, 2024
Closed
This was referenced Oct 5, 2024
Open
Open
Open
@mbreadmachine mbreadmachine mentioned this pull request Oct 6, 2024
Closed
This was referenced Oct 25, 2024
Open
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@LukasTy LukasTy LukasTy approved these changes

@alexfauquette alexfauquette alexfauquette approved these changes

@cherniavskii cherniavskii cherniavskii approved these changes

@joserodolfofreitas joserodolfofreitas Awaiting requested review from joserodolfofreitas

@samuelsycamore samuelsycamore Awaiting requested review from samuelsycamore

Assignees

@flaviendelangle flaviendelangle

Labels
docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[docs] Create a new page to introduce the concept of slots and slotProps
6 participants
@flaviendelangle @mui-bot @LukasTy @cherniavskii @alexfauquette @samuelsycamore