Function useKeyPress

  • useKeyPress(callback, keys, metaKeys?, node?): void

  • Listen to keyboard events

    Parameters

    • callback: ((e) => void)

      called on key press event

        • (e): void

        • Parameters

          • e: KeyboardEvent<Element>

          Returns void

    • keys: string[]

      keyboard keys that activate the callback

    • metaKeys: KeyboardMetaKeys[] = []

      keyboard meta keys to use

    • node: null | HTMLElement = null

      element to which the listener is applied

    Returns void

    Example

    // Prints "press" on press of a "a+Ctrl"
    useKeyPress(() => console.log("press"), ["a"], ["CTRL"]);

Settings

Member Visibility

Theme