useMenuTriggerState

Manages state for a menu trigger. Tracks whether the menu is currently open, and controls which item will receive focus when it opens.

install	`yarn add react-stately`
version	3.17.0
usage	`import {useMenuTriggerState} from 'react-stately'`

API#

useMenuTriggerState(
  (props: MenuTriggerProps
)): MenuTriggerState

Name	Type	Description
`focusStrategy`	`FocusStrategy`	Controls which item will be auto focused when the menu opens.
`isOpen`	`boolean`	Whether the overlay is currently open.

Method	Description
`open( (focusStrategy?: FocusStrategy \| \| null )): void`	Opens the menu.
`toggle( (focusStrategy?: FocusStrategy \| \| null )): void`	Toggles the menu.
`setOpen( (isOpen: boolean )): void`	Sets whether the overlay is open.
`close(): void`	Closes the overlay.

See the docs for useMenu in react-aria for an example of useMenuTriggerState.

Name	Type	Default	Description
`trigger`	`MenuTriggerType`	`'press'`	How the menu is triggered.
`align`	`Alignment`	`'start'`	Alignment of the menu relative to the trigger.
`direction`	`'bottom' \| 'top' \| 'left' \| 'right' \| 'start' \| 'end'`	`'bottom'`	Where the Menu opens relative to its trigger.
`closeOnSelect`	`boolean`	`true`	Whether the Menu closes when a selection is made.
`shouldFlip`	`boolean`	`true`	Whether the menu should automatically flip direction when space is limited.
`isOpen`	`boolean`	—	Whether the overlay is open by default (controlled).
`defaultOpen`	`boolean`	—	Whether the overlay is open by default (uncontrolled).
`onOpenChange`	`( (isOpen: boolean )) => void`	—	Handler that is called when the overlay's open state changes.