react-accessible-menu

Type parameters

• T: HTMLElement = HTMLDivElement

Parameters

• props: MenuProps<T, any> & { ref?: ForwardedRef<MenuImperativeHandle<any>> }

Returns null | ReactElement<any, string | JSXElementConstructor<any>>

Type parameters

• E: HTMLElement = HTMLDivElement

• D = any

Parameters

• __namedParameters: MenuItemProps<E, D>

Returns null | ReactElement<any, string | JSXElementConstructor<any>>

Type parameters

• E: HTMLElement = HTMLDivElement

• D = any

Parameters

• __namedParameters: UseMenuProps<E, D>

Returns { Provider: Provider<MenuContextProps>; contextProps: MenuContextProps; focusItem: (itemId: ItemId, passive?: any) => void; focusedItem: null | ItemId; getItem: (id: ItemId) => undefined | RegisteredItem; items: MutableRefObject<RegisteredItem[]>; moveFocusIndexRelative: (direction: "up" | "down") => void; moveFocusToCharacter: (character: string) => void; moveFocusToEnd: () => void; moveFocusToStart: () => void; renderProps: MenuRenderProps<E, D>; reorder: () => void }

• Provider: Provider<MenuContextProps>

• contextProps: MenuContextProps

• focusItem: (itemId: ItemId, passive?: any) => void

  • • (itemId: ItemId, passive?: any): void

    • Parameters

      • itemId: ItemId

      • passive: any = false

      Returns void

• focusedItem: null | ItemId

• getItem: (id: ItemId) => undefined | RegisteredItem

  • • (id: ItemId): undefined | RegisteredItem

    • Parameters

      • id: ItemId

      Returns undefined | RegisteredItem

• items: MutableRefObject<RegisteredItem[]>

• moveFocusIndexRelative: (direction: "up" | "down") => void

  • • (direction: "up" | "down"): void

    • Parameters

      • direction: "up" | "down"

      Returns void

• moveFocusToCharacter: (character: string) => void

  • • (character: string): void

    • Parameters

      • character: string

      Returns void

• moveFocusToEnd: () => void

  • • (): void

    • Returns void

• moveFocusToStart: () => void

  • • (): void

    • Returns void

• renderProps: MenuRenderProps<E, D>

• reorder: () => void

  • • (): void

    • Returns void

Type parameters

• E: HTMLElement = HTMLDivElement

• D = any

Parameters

• __namedParameters: UseMenuItemProps<E, D>

Returns { hasFocus: boolean; id: string | number; renderProps: MenuItemRenderProps<E, D> }

• hasFocus: boolean

• id: string | number

• renderProps: MenuItemRenderProps<E, D>