Interface IZKeyboardInteraction<T>

A set of keyboard interactions that should be set on an element.

interface IZKeyboardInteraction<T = Element> {
tabIndex?: number;
onKey?(e: KeyboardEvent<T>): void;
}

Type Parameters

T = Element
The type of Element that the KeyboardEvent will receive.

Index

Properties

Methods

Properties

`Optional`tabIndex

tabIndex?: number

The tab index to set on the element.

This will be 0 if onKey is handled, or undefined otherwise.

Methods

`Optional`onKey

onKey?(e: KeyboardEvent<T>): void
A key handler.

This can be used for onKeyDown and onKeyUp.
Parameters
- e: KeyboardEvent<T>
  The keyboard event that happened.
Returns void
- Defined in keyboard-activate/use-keyboard-activate.mts:28