Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyboardMovementProviderProps

remarks

@since 5.0.0

Hierarchy

Index

Properties

children: ReactNode
decrementKeys?: readonly string[]

A list of keys that will attempt to decrement the focus index by 1.

defaultvalue

["ArrowUp"]

horizontal?: boolean

Boolean if the keyboard movement is horizontal instead of vertical. This updates the default keyboard config to use ArrowRight and ArrowLeft instead of ArrowDown and ArrowUp,

remarks

@since 5.1.2

defaultvalue

false

includeDisabled?: boolean

Boolean if elements that are aria-disabled or disabled should still be able to gain focus.

defaultvalue

false

incrementKeys?: readonly string[]

A list of keys that will attempt to increment the focus index by 1.

defaultvalue

["ArrowDown"]

jumpToFirstKeys?: readonly string[]

A list of keys that will set the focus index to 0.

defaultvalue

["Home"]

jumpToLastKeys?: readonly string[]

A list of keys that will set the focus index to the last focusable index.

defaultvalue

["End"]

loopable?: boolean

Boolean if the KeyboardMovementProvider should allow the focus behavior to loop from the first to last or last to first item instead of preventing any new focus behavior. In other words... if the last item is focused and the user presses a key that should advance the focus to the next focusable element, should the focus stay on the current element or loop back and focus the first focusable item.

defaultvalue

false

searchable?: boolean

Boolean if pressing a letter will focus the next item in the KeyboardMovementProvider that starts with the same letter.

defaultvalue

false

Generated using TypeDoc