/** * LadrillosJS Key Modifiers * * Supports keyboard keys, mouse modifiers, and event behavior modifiers. * * Syntax: $on:event.modifier1.modifier2="handler()" * * Examples: * $on:keyup.enter="submit()" * $on:keydown.escape="closeModal()" * $on:click.ctrl="selectMultiple()" * $on:keydown.ctrl.s="save()" * $on:submit.prevent="handleSubmit()" * $on:click.stop="handleClick()" */ /** * Common key aliases for better DX. * Maps short names to KeyboardEvent.key values. */ export declare const KEY_ALIASES: Record; /** * System modifier keys that check event properties. */ export declare const SYSTEM_MODIFIERS: readonly ["ctrl", "alt", "shift", "meta"]; export type SystemModifier = (typeof SYSTEM_MODIFIERS)[number]; /** * Maps modifier names to event property names. */ export declare const MODIFIER_PROPERTIES: Record; /** * Event behavior modifiers. */ export declare const EVENT_MODIFIERS: readonly ["prevent", "stop", "self", "once", "passive", "capture"]; export type EventModifier = (typeof EVENT_MODIFIERS)[number]; /** * Mouse button modifiers for click events. */ export declare const MOUSE_MODIFIERS: { readonly left: 0; readonly middle: 1; readonly right: 2; }; export type MouseModifier = keyof typeof MOUSE_MODIFIERS; export interface ParsedEventDirective { /** The base event name (e.g., "keyup", "click") */ eventName: string; /** Key modifiers (e.g., ["enter", "shift"]) */ keyModifiers: string[]; /** System modifiers (e.g., ["ctrl", "alt"]) */ systemModifiers: SystemModifier[]; /** Event behavior modifiers (e.g., ["prevent", "stop"]) */ eventModifiers: EventModifier[]; /** Mouse button modifier (e.g., "left") */ mouseModifier: MouseModifier | null; /** Whether to use exact modifier matching */ exact: boolean; } /** * Parses a $on: directive attribute into its components. * * Examples: * "$on:keyup.enter" → { eventName: "keyup", keyModifiers: ["enter"], ... } * "$on:click.ctrl.prevent" → { eventName: "click", systemModifiers: ["ctrl"], eventModifiers: ["prevent"], ... } */ export declare function parseEventDirective(attrName: string): ParsedEventDirective | null; /** * Checks if a KeyboardEvent matches the specified key modifier. * * @param event The keyboard event * @param keyModifier The key modifier to check (e.g., "enter", "a", "escape") * @returns True if the key matches */ export declare function matchesKey(event: KeyboardEvent, keyModifier: string): boolean; /** * Checks if a keyboard/mouse event matches all system modifiers. * * @param event The event to check * @param modifiers The system modifiers required * @param exact If true, no other modifiers should be pressed * @returns True if all required modifiers are pressed (and only those if exact) */ export declare function matchesSystemModifiers(event: KeyboardEvent | MouseEvent, modifiers: SystemModifier[], exact: boolean): boolean; /** * Checks if a MouseEvent matches the specified mouse button. * * @param event The mouse event * @param mouseModifier The mouse button modifier * @returns True if the button matches */ export declare function matchesMouseButton(event: MouseEvent, mouseModifier: MouseModifier): boolean; /** * Creates an event listener options object from event modifiers. */ export declare function getListenerOptions(modifiers: EventModifier[]): AddEventListenerOptions; /** * Creates a wrapped event handler that applies all modifiers. * * @param originalHandler The original event handler function * @param parsed The parsed event directive * @returns A wrapped handler that checks modifiers before calling the original */ export declare function createModifiedHandler(originalHandler: (event: Event) => void, parsed: ParsedEventDirective): (event: Event) => void; /** * Checks if an attribute is a $on: event directive. */ export declare function isEventDirective(attrName: string): boolean;