[docs] Improve Base UI table of contents for APIs #39412
Merged
+95
−32
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ZeeshanTamboli
added
docs
Netlify deploy previewhttps://deploy-preview-39412--material-ui.netlify.app/ Bundle size report |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
github-actions
bot
added
the
PR: out-of-date
|
Yeah, the horizontal scroll on the useAutocomplete page isn't ideal. I went looking for other cases of it in the Material UI Component API docs and couldn't find any instances of headers that were wide enough to break it the way "unstable_isActiveElementInListbox" does. Maybe we could resolve it with a |
1 task
danilo-leal
approved these changes
Oct 12, 2023
github-actions
bot
removed
the
PR: out-of-date
|
@danilo-leal Great job on the horizontal scroll fix! I've resolved conflicts by pulling changes from #38265 and #39417, and I'm confident it's ready for merging. |
mnajdova
pushed a commit
to mnajdova/material-ui
that referenced
this pull request
Oct 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Include properties in the table of contents for both the Base UI component APIs and hooks APIs. I find it helpful to have quick navigation to view properties using the right-side table of contents, especially when there are many properties. This feature is already present in Material UI and Joy UI.
Before: https://deploy-preview-39406--material-ui.netlify.app/base-ui/react-autocomplete/hooks-api/#use-autocomplete
After: https://deploy-preview-39412--material-ui.netlify.app/base-ui/react-autocomplete/hooks-api/#use-autocomplete
Example for multiple hooks APIs - https://deploy-preview-39412--material-ui.netlify.app/base-ui/react-menu/hooks-api/#use-menu-import