Interface KeybindingHandlerOptions

src/tinykeys.ts:25–61

export type KeybindingFilter = (event: KeyboardEvent) => boolean

export interface KeybindingHandlerOptions {
	/**
	 * Keybinding sequences will wait this long between key presses before
	 * cancelling (default: 1000).
	 *
	 * **Note:** Setting this value too low (i.e. `300`) will be too fast for many
	 * of your users.
	 */
	timeout?: number

	/**
	 * Customize the behavior of which keyboard events will be ignored/skipped.
	 *
	 * By default this uses the behavior of {@link defaultKeybindingsHandlerIgnore}.
	 *
	 * @example Allow all events
	 * ```tsx
	 * tinykeys(window, {...}, {
	 *   ignore: () => false
	 * })
	 * ```
	 *
	 * @example Extend the default ignore
	 * ```tsx
	 * tinykeys(window, {...}, {
	 *   ignore: event => {
	 *     return (
	 *       // Also ignore events inside a dialog
	 *       event.target.closest("dialog") != null &&
	 *       defaultKeybindingsHandlerIgnore(event)
	 *     );
	 *   }
	 * })
	 * ```
	 */
	ignore?: KeybindingFilter
}

/**
 * Options to configure the behavior of keybindings.