A higher-order component for arrow key navigation on a grouping of children.
npm install boundless-arrow-key-navigationTHIS IS AN AUTOGENERATED FILE. EDIT INDEX.JS INSTEAD.
ArrowKeyNavigation is designed not to care about the component types it is wrapping. Due to this, you can pass
whatever HTML tag you like into props.component or even a React component you've made elsewhere. Additional
props passed to
The children, similarly, can be any type of component.
_Note: only top-level props are in the README, for the full list check out the website._
There are no required props.
| Name | Type | Default Value | Description |
|---|---|---|---|
| component | | | Any valid HTML tag name or a React component factory, anything that can be passed as the first argument to React.createElement |
| defaultActiveChildIndex | | | Allows for a particular child to be initially reachable via tabbing |
| mode | | | controls which arrow key events are captured to move active focus within the list: Mode | Keys _Note: focus loops when arrowing past one of the boundaries; tabbing moves the user away from the list._ |