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][joy-ui] Revise the Drawer page #38988

Merged
merged 8 commits into from
Sep 25, 2023

Conversation

danilo-leal
Copy link
Contributor

@danilo-leal danilo-leal commented Sep 15, 2023

Mostly a few increments and corrections here and there, as well as some demo tweaks.
Got some questions along the way that I'll drop as comments!

https://deploy-preview-38988--material-ui.netlify.app/joy-ui/react-drawer/

@danilo-leal danilo-leal added docs Improvements or additions to the documentation component: drawer This is the name of the generic UI component, not the React module! package: joy-ui Specific to @mui/joy labels Sep 15, 2023
@danilo-leal danilo-leal self-assigned this Sep 15, 2023
@mui-bot
Copy link

mui-bot commented Sep 15, 2023

Netlify deploy preview

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against bf13669

docs/data/joy/components/drawer/drawer.md Show resolved Hide resolved
docs/data/joy/components/drawer/drawer.md Outdated Show resolved Hide resolved
The Drawer can be cancelled by clicking the overlay or pressing the Esc key.
It closes when an item is selected, handled by controlling the `open` prop.
The Drawer can be closed by clicking on the overlay or pressing the <kbd>Esc</kbd> key.
It will also close if an item inside of it is selected, which can be controlled by the `open` prop.

{{"demo": "DrawerBasic.js"}}

## Customization
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@siriwatknp + @samuelsycamore should we say something / add a demo about modal vs. non-modal Drawers? I've seen plenty of use cases for both out there in the wild.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think that's a good idea!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mnajdova Is there anything specific we should do to get a non-modal Drawer? (Image Notion's comment drawer as an example of it).

docs/data/joy/components/drawer/drawer.md Outdated Show resolved Hide resolved
Copy link
Contributor

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

One more thing that I'm not able to add a suggestion for: I think we should add Modal Close and Dialog Content to the API reference section, since they're both mentioned here.

docs/data/joy/components/drawer/drawer.md Outdated Show resolved Hide resolved
docs/data/joy/components/drawer/drawer.md Outdated Show resolved Hide resolved
docs/data/joy/components/drawer/drawer.md Outdated Show resolved Hide resolved
docs/data/joy/components/drawer/drawer.md Outdated Show resolved Hide resolved
docs/data/joy/components/drawer/drawer.md Outdated Show resolved Hide resolved
docs/data/joy/components/drawer/drawer.md Outdated Show resolved Hide resolved
docs/data/joy/components/drawer/drawer.md Outdated Show resolved Hide resolved
docs/data/joy/components/drawer/drawer.md Show resolved Hide resolved
docs/data/joy/components/drawer/drawer.md Outdated Show resolved Hide resolved
docs/data/joy/components/drawer/drawer.md Outdated Show resolved Hide resolved
@danilo-leal
Copy link
Contributor Author

Woo, thanks a ton for the reviews @samuelsycamore! I'll need either @mnajdova or @siriwatknp's help in adding these components to the API section ⎯ couldn't figure out how to do it 😅

@danilo-leal danilo-leal merged commit bbd2837 into mui:master Sep 25, 2023
9 checks passed
@danilo-leal danilo-leal deleted the drawer-doc-revision branch September 25, 2023 10:25
@samuelsycamore
Copy link
Contributor

Just realized we forgot to add an Anatomy section to this page! 🤦‍♂️ We can come back to it in another PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: drawer This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy
Projects
Status: Recently completed
Development

Successfully merging this pull request may close these issues.

4 participants