search

mui / mui-x

MUI X: Build complex and data-rich applications using a growing list of advanced React components, like the Data Grid, Date and Time Pickers, Charts, and more!
https://mui.com/x/
3.92k stars 1.2k forks source link

Allow API documentation page render wider for wider screens #9559

Open namiskuukkel opened 1 year ago

namiskuukkel commented 1 year ago

Duplicates

Latest version

Summary 💡

The API documentation content layout could be made wider for wider screens so more content would be visible at a time, instead of wide white margins on the sides.

Examples 🌈

This is an example of DateField API page with the site as it is and with the content at 1200px width. You can see that on the wider version the documentation there are four more properties visible on one view. Normal image With added width image

Motivation 🔦

When I go through API documentations I get frustrated with the page scrolling as for more complicated components the APIs get really long. For my usual use cases of taking a quick overall look of a component or scrolling the documentation page to look for a certain property it would be user friendly to have more content visible at a time. Now I just see lots of white margin although I would have space available to show me more information.

Order ID 💳 (optional)

No response

namiskuukkel commented 1 year ago

Forgot this from Motivation: Long and narrow description paragraph is hard to read, compared to wider text.

alexfauquette commented 1 year ago

We are currently working on it. If you have feedbacks on the ongoing effort, please feel free to ad them in the PR #9187

https://deploy-preview-9187--material-ui-x.netlify.app/x/api/data-grid/data-grid/