Hook

useEscapeKey

Runs a callback when Escape is pressed.

Hook

import { useEscapeKey } from "@swirski/ui";

Live render

Preview

Escape listener for overlays

useEscapeKey(() => setOpen(false), {
  enabled: open,
});

3 documented

Prop	Type	Default	Notes
`handler`Required	`(event: KeyboardEvent) => void`	`-`	Runs when Escape is pressed.
`options.enabled`	`boolean`	`true`	Turns the key listener on or off.
`options.target`	`Document \| HTMLElement \| Window \| null`	`-`	Event target, defaults to document.

1 documented

Value	Type	Notes
`return`	`void`	Registers a keydown listener in an effect and returns no value.