[Doc] Add documentation for the Menu component #7907
Merged
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
Member
fzaninotto
commented
Jun 28, 2022
fzaninotto
commented
fzaninotto
commented
Jun 28, 2022
| @@ -47,17 +50,25 @@ const App = () => ( | |||
| | `appBar` | Optional | `Component` | - | A React component rendered at the top of the layout | | |||
| | `className` | Optional | `string` | - | Passed to the root `<div>` component | | |||
| | `error` | Optional | `Component` | - | A React component rendered in the content area in case of error | | |||
| | `sidebar` | Optional | `Component` | - | A React component rendered at the side of the screen | | |||
There was a problem hiding this comment.
Even if the sidebar prop exists, I see no reason to use it, so let's make it a private API. menu, on the other side, is the preferred way to set a custom menu, so it should be documented.
fzaninotto
commented
Jun 28, 2022
| export const Menu = (props: MenuProps) => { | ||
| const resources = useResourceDefinitions(); | ||
| const getResourceLabel = useGetResourceLabel(); | ||
| const createPath = useCreatePath(); | ||
| const { | ||
| hasDashboard, | ||
| dense, |
There was a problem hiding this comment.
passed as rest props to the root component, a mui MenuList
fzaninotto
commented
Jun 28, 2022
| @@ -84,14 +105,18 @@ Menu.propTypes = { | |||
| hasDashboard: PropTypes.bool, | |||
| }; | |||
|
|
|||
| // re-export MenuItem commponents for convenience | |||
| Menu.Item = MenuItemLink; | |||
There was a problem hiding this comment.
This is technically a new feature but I think it's really minor, plus it's backwards compatible.
fzaninotto
commented
Jun 28, 2022
| @@ -137,17 +137,16 @@ export const MenuItemLink = forwardRef((props: MenuItemLinkProps, ref) => { | |||
| ); | |||
| }); | |||
|
|
|||
| interface Props { | |||
There was a problem hiding this comment.
This change is required to let TS compile the Menu component after it reexports the MenuItem component.
antoinefricker
approved these changes
Jun 29, 2022
slax57
requested changes
Jun 29, 2022
Co-authored-by: Jean-Baptiste Kaiser <jb@marmelab.com>
slax57
approved these changes
Jun 29, 2022
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.