svelte-event/dist/modifiers/key.js

svelte-event provides a set of wrapper functions for adding modifiers to event handlers and a versatile `event` action for comprehensive event listener management in Svelte.

import { objectToEntries } from '../utils/objectToEntries';
/**
 * Creates a modifier that only triggers the handler if a specific key is pressed.
 */
export function key(
/** The original event handler. */
handler, 
/** The key to check for (e.g., 'Enter', 'Shift', 'a'). Must be a valid KeyboardEvent.key value.
 * @see https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values
 */
key, options) {
    return function (event) {
        if (event.key !== key) {
            return;
        }
        const { altKey = false, ctrlKey = false, metaKey = false, shiftKey = false, exact = false } = options ?? {};
        const modifiersToCheck = { altKey, ctrlKey, metaKey, shiftKey };
        for (const [modifierKey, modifierValue] of objectToEntries(modifiersToCheck)) {
            if (exact && modifierValue !== event[modifierKey]) {
                return;
            }
            if (!exact && modifierValue && !event[modifierKey]) {
                return;
            }
        }
        handler.call(this, event);
    };
}