@workday/canvas-kit-react/dist/es6/collection/lib/useListKeyboardHandler.js

The parent module that contains all Workday Canvas Kit React components

import { useIsRTL, createElemPropsHook } from '@workday/canvas-kit-react/common';
import { useCursorListModel } from './useCursorListModel';
import { keyboardEventToCursorEvents } from './keyUtils';
/**
 * This elemProps hook is used to attach keyboard events to handle keyboard navigation
 *
 * ```ts
 * const useMyItem = composeHooks(
 *   useListKeyboardHandler, // adds keyboard support support
 *   useListItemRegister
 * );
```
 */
export const useListKeyboardHandler = createElemPropsHook(useCursorListModel)(model => {
    const isRTL = useIsRTL();
    return {
        onKeyDown(event) {
            const handled = keyboardEventToCursorEvents(event, model, isRTL);
            if (handled) {
                event.preventDefault();
            }
        },
    };
});