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-infra] Demo overflow strategy #39344

Open
oliviertassinari opened this issue Oct 8, 2023 · 0 comments
Open

[docs-infra] Demo overflow strategy #39344

oliviertassinari opened this issue Oct 8, 2023 · 0 comments
Labels
discussion scope: docs-infra Specific to the docs-infra product

Comments

@oliviertassinari
Copy link
Member

oliviertassinari commented Oct 8, 2023

What's the problem? 🤔

Today, the Base UI introduction demo uses a different overflow strategy than the rest of the page. See #39225.

It's relatively frequent for a demo to break the mobile layout, e.g. mui/mui-x#10455 recently. Today, when this happens, it's quite easy to spot, the whole page is broken. So it's great because it's easy to identify. Now, it's also not so great because it breaks the whole docs experience, it's not isolated to one demo that is broken.

What are the requirements? ❓

Some demos need to overflow their container, e.g. https://mui.com/material-ui/react-autocomplete/#combo-box can't have an overflow property today, not until the root problem of #23263 is fixed.

What are our options? 💡

  1. No change: overflow: auto like in Base UI introduction demo + no overflow on the other demos
  2. No overflow on all the demos
  3. overflow: auto everywhere + a warning in the console that flags the demo with a scrollbar + a prop to disable the overflow.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion scope: docs-infra Specific to the docs-infra product
Projects
Status: Backlog
Development

No branches or pull requests

1 participant