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 accordion coming soon page #36279

Merged
merged 10 commits into from
Mar 28, 2023

Conversation

siriwatknp
Copy link
Member

@siriwatknp siriwatknp commented Feb 21, 2023

@siriwatknp siriwatknp added docs Improvements or additions to the documentation design: joy This is about Joy Design, please involve a visual or UX designer in the process package: joy-ui Specific to @mui/joy and removed design: joy This is about Joy Design, please involve a visual or UX designer in the process labels Feb 21, 2023
@mui-bot
Copy link

mui-bot commented Feb 21, 2023

Netlify deploy preview

Bundle size report

No bundle size changes

Generated by 🚫 dangerJS against 44ff8b4

@siriwatknp siriwatknp marked this pull request as ready for review February 23, 2023 06:18
@siriwatknp
Copy link
Member Author

@samuelsycamore what do you think about the structure of the page?

https://deploy-preview-36279--material-ui.netlify.app/joy-ui/react-accordion/

Copy link
Member

@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.

Great idea @siriwatknp !

docs/data/joy/components/accordion/accordion.md Outdated Show resolved Hide resolved
docs/data/joy/components/accordion/accordion.md Outdated Show resolved Hide resolved
docs/data/joy/components/accordion/accordion.md Outdated Show resolved Hide resolved
docs/data/joy/components/accordion/accordion.md Outdated Show resolved Hide resolved
docs/data/joy/components/accordion/accordion.md Outdated Show resolved Hide resolved
docs/data/joy/components/accordion/accordion.md Outdated Show resolved Hide resolved
docs/data/joy/components/accordion/accordion.md Outdated Show resolved Hide resolved
docs/data/joy/components/accordion/accordion.md Outdated Show resolved Hide resolved
docs/data/joy/components/accordion/accordion.md Outdated Show resolved Hide resolved
siriwatknp and others added 4 commits February 24, 2023 13:03
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Signed-off-by: Siriwat K <siriwatkunaporn@gmail.com>
@siriwatknp
Copy link
Member Author

@samuelsycamore could you do a final review?

This document shows how construct an accordion with existing Joy UI components combined with popular headless UI libraries.
:::

If you're in need of a Joy UI Accordion, please upvote [this issue](https://github.com/mui/material-ui/issues/36281) to help us prioritize the next batch of new components.
Copy link
Member

@oliviertassinari oliviertassinari Mar 21, 2023

Choose a reason for hiding this comment

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

What do you think about following the same frame as https://mui.com/x/react-data-grid/pivoting/ only so that developer can recognize the pattern? Humm, not sure.

Actually, much better: we could connect this with https://github.com/mui/material-ui/pull/36279/files#r1143883693, it could be one warning callout with 3 small paragraphs:

  1. Not ready
  2. Upvote to make it move faster
  3. Can't wait? recreate it with other headless libraries

👌


<p class="description">Accordions let users show and hide sections of related content on a page.</p>

:::success
Copy link
Member

@oliviertassinari oliviertassinari Mar 21, 2023

Choose a reason for hiding this comment

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

I'm a bit confused by the callout type. https://www.notion.so/mui-org/Callouts-and-their-usage-in-the-docs-7e709a02c72142cd8b1a0829861435c5 I would expect success as all is great, but the fact that it's not built-in makes me weigh a bit more toward info or even better warning to match/hint to the color in the side nav:

Screenshot 2023-03-21 at 20 19 35

This document shows how construct an accordion with existing Joy UI components combined with popular headless UI libraries.
:::

If you're in need of a Joy UI Accordion, please upvote [this issue](https://github.com/mui/material-ui/issues/36281) to help us prioritize the next batch of new components.
Copy link
Member

Choose a reason for hiding this comment

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

To be more specific?

Suggested change
If you're in need of a Joy UI Accordion, please upvote [this issue](https://github.com/mui/material-ui/issues/36281) to help us prioritize the next batch of new components.
If you're in need of a Joy UI Accordion, please upvote [issue #36281](https://github.com/mui/material-ui/issues/36281) to help us prioritize the next batch of new components.

@danilo-leal
Copy link
Contributor

@siriwatknp & @samuelsycamore I've pushed some changes in the direction that Olivier steered this PR in (which I think it's great!). Let me know what y'all think ⎯ in the meantime, I'll create a similar PR to this one for the Snackbar component.

@oliviertassinari
Copy link
Member

oliviertassinari commented Mar 21, 2023

Fair enough, I guess the yellow/orange makes more sense for deprecated APIs like in https://mui.com/system/styles/basics/.

Screenshot 2023-03-22 at 00 02 42

Comment on lines +13 to +14
💡 The Joy UI Accordion component is still in development.
If you're in need of it, please upvote [**this issue**](https://github.com/mui/material-ui/issues/36281) to help us prioritize the next batch of new components.
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
💡 The Joy UI Accordion component is still in development.
If you're in need of it, please upvote [**this issue**](https://github.com/mui/material-ui/issues/36281) to help us prioritize the next batch of new components.
💡 The Joy UI Accordion component is still in development.
If you're in need of it, please upvote [**this issue**](https://github.com/mui/material-ui/issues/36281) to help us prioritize the next batch of new components.
Or you can use the Accordion component from headless libraries and leverage the Joy UI theme. See [examples](integration-with-headless-ui-libraries) below.

How about this? @danilo-leal @oliviertassinari @samuelsycamore

Copy link
Contributor

Choose a reason for hiding this comment

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

I've done some tweaking exactly on this part! I think it works having the first two sentences in an info callout. Let me know what you think! 👉 https://deploy-preview-36279--material-ui.netlify.app/joy-ui/react-accordion/

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

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

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

It looks great to me! 🎉

Signed-off-by: Siriwat K <siriwatkunaporn@gmail.com>
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Mar 28, 2023
@siriwatknp siriwatknp merged commit 3877755 into mui:master Mar 28, 2023
@oliviertassinari
Copy link
Member

oliviertassinari commented Apr 5, 2023

When I land on the page, the current style makes me want to click on the page that aren't built yet, would a grey color make more sense (for the list item too)?

Radix UI

Screenshot 2023-07-19 at 02 41 55

https://web.archive.org/web/20220119003827/https://www.radix-ui.com/docs/primitives/overview/getting-started

Material UI

Screenshot 2023-04-05 at 23 13 00

It might also be better with a shorter text:

Screenshot 2023-04-05 at 23 17 23

MUI X:

Screenshot 2023-04-05 at 23 17 52

Screenshot 2023-04-05 at 23 18 23

@danilo-leal
Copy link
Contributor

@oliviertassinari yeah ⎯ good call about the color! In hindsight, it's definitely grabbing too much attention for something that, indeed, isn't available yet. Let me tackle that! Wouldn't change the copy, though. Those components are not really a "work in progress" yet ⎯ they could be, but not necessarily.

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 package: joy-ui Specific to @mui/joy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants