useMenuTriggerState

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

installyarn add @react-stately/menu
version3.2.7
usageimport {useMenuTriggerState} from '@react-stately/menu'

API#


useMenuTriggerState( (props: MenuTriggerProps )): MenuTriggerState

Interface#


Properties

NameTypeDescription
focusStrategyFocusStrategyControls which item will be auto focused when the menu opens.
isOpenbooleanWhether the overlay is currently open.

Methods

MethodDescription
open( (focusStrategy?: FocusStrategynull )): voidOpens the menu.
toggle( (focusStrategy?: FocusStrategynull )): voidToggles the menu.
setOpen( (isOpen: boolean )): voidSets whether the overlay is open.
close(): voidCloses the overlay.

Example#


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