[docs-infra] Demo overflow strategy
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 99.1k
- Forks
- 32.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 106
Description
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. https://github.com/mui/mui-x/pull/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 https://github.com/mui/material-ui/pull/23263 is fixed.
What are our options? 💡
- No change:
overflow: autolike in Base UI introduction demo + no overflow on the other demos - No overflow on all the demos
overflow: autoeverywhere + a warning in the console that flags the demo with a scrollbar + a prop to disable the overflow.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the Base UI introduction demo's overflow behavior with the other demos, then read #39225 and the referenced Material UI issues and pull requests. The work is complete when the project has a decided demo overflow strategy, including how required overflow and problematic mobile layouts are handled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100