The PositionAnchor to use for the menu. Here's the default value for the anchor:
BELOW_CENTER_ANCHOR
TOP_RIGHT_ANCHOR
TOP_INNER_RIGHT_ANCHOR
Boolean if the transition should occur immediately once the component
mounts if the TransitionOptions.transitionIn is true
An optional className to be merged with the transition classes.
Boolean if the menu should close instead of repositioning itself if the browser window is resized.
Boolean if the menu should close if the page is scrolled. The default behavior is to just update the position of the menu relative to the menu button until it can no longer be visible within the viewport.
Boolean if the menu component should not gain focus once it has mounted.
This should really only be set to true
if the enter transition has been
disabled.
Boolean if the toggle element should no longer gain focus when the menu loses visibility.
Note: The toggle element will not gain focus if:
document.activeElement
has moved outside of the menuMenuItem
's action cause the focus to move
alreadydocument.activeElement
is an link (<a href="">
)Boolean if the transition should occur whenever the
TransitionOptions.transitionIn is switch to true
after the
component has been rendered in the DOM.
Boolean if the transition should occur whenever the
TransitionOptions.transitionIn is switch to false
after the
component has been rendered in the DOM.
{@inheritDoc CalculateFixedPositionOptions}
Boolean if the menu should be rendered horizontally instead of vertically.
This will also update the aria-orientation
.
An optional className that should be passed to the menu component.
An optional aria-label
that should be applied to the Menu
component. If
this is undefined
, an aria-labelledby
will be provided to the Menu
instead linking to the id of the Button
.
Any additional props that should be passed to the Menu component.
Note: use the menuStyle and menuClassName props instead of
including style
or className
here.
An optional style object that should be merged with the menu's fixed positioning styles.
This function will be called once the TransitionStage has been set
to "enter"
.
This function will be called once the TransitionStage has been set
to "entering"
.
This function will be called once the TransitionStage has been set
to "enter"
.
This function will be called once the TransitionStage has been set
to "entered"
.
This function will be called once the TransitionStage has been set
to "exited"
.
This function will be called once the TransitionStage has been set
to "exiting"
.
Boolean if the portal should be used.
Boolean if the page should no longer be scrollable while the menu is visible.
{@inheritDoc RenderMenuAsSheet}
An optional className that should be passed to the sheet component.
Any children to render below the sheet's menu implementation. This would
normally be something like a <DialogFooter>
.
Any children to render above the sheet's menu implementation. This would
normally be something like a <DialogHeader>
or AppBar
.
Any additional props that should be added to the sheet's menu implementation. You probably won't ever need to use this.
Any additional props that should be passed to the Sheet component.
Note: use the sheetStyle and sheetClassName props instead
of including style
or className
here.
An optional style object that should be passed to the sheet.
{@inheritDoc TransitionTimeout}
A function that can be used to get the CalculateFixedPositionOptions dynamically.
Generated using TypeDoc
@since 5.0.0