[MenuRoot] Remove wrong default value from docs #549
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
sai6855
requested review from
atomiks,
colmtuite and
michaldudak
as code owners
Netlify deploy preview |
zannager
added
component: menu
michaldudak
reviewed
Aug 26, 2024
| @@ -139,8 +139,6 @@ namespace MenuRoot { | |||
| delay?: number; | |||
| /** | |||
| * Whether the menu popup opens when the trigger is hovered after the provided `delay`. | |||
| * | |||
| * @default nested | |||
There was a problem hiding this comment.
I used to have such a prop in one of the previous implementation attempts and forgot to remove the @default annotation. We can add in plain text that by default openOnHover is set on nested menus.
There was a problem hiding this comment.
michaldudak
reviewed
Aug 27, 2024
| @@ -139,6 +139,7 @@ namespace MenuRoot { | |||
| delay?: number; | |||
| /** | |||
| * Whether the menu popup opens when the trigger is hovered after the provided `delay`. | |||
| * By default, openOnHover is set to `true` for nested menus. | |||
There was a problem hiding this comment.
Suggested change
| * By default, openOnHover is set to `true` for nested menus. | |
| * By default, `openOnHover` is set to `true` for nested menus. |
michaldudak
approved these changes
Aug 27, 2024
|
Thanks! |
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.
I was looking at source code of Menu and docs, docs says default value of
openOnHoverprop isnestedbutnestedvalue is not defined in code and even ifopenOnHoverprop is defined asnestedfollowing code (see line 27) would be illogical asopenOnHoverPropwill always be true. hence i removed default prop asnestedfrom docs.base-ui/packages/mui-base/src/Menu/Root/MenuRoot.tsx
Lines 21 to 30 in 919d9ca
Before:
After
Preview:
https://deploy-preview-549--base-ui.netlify.app/base-ui/react-menu/components-api/#menu-root-props