@tanstack/hotkeys 0.8.0 → 0.10.0

package/dist/constants.d.ts

@@ -1,22 +1,5 @@
-import { CanonicalModifier, EditingKey, FunctionKey, LetterKey, NavigationKey, NumberKey, PunctuationKey } from "./hotkey.js";
-
+import { CanonicalModifier, EditingKey, FunctionKey, LetterKey, NavigationKey, NumberKey, PunctuationKey } from "./key.types.js";
 //#region src/constants.d.ts
-/**
- * Detects the current platform based on browser navigator properties.
- *
- * Used internally to resolve platform-adaptive modifiers like 'Mod' (Command on Mac,
- * Control elsewhere) and for platform-specific hotkey formatting.
- *
- * @returns The detected platform: 'mac', 'windows', or 'linux'
- * @remarks Defaults to 'linux' in SSR environments where navigator is undefined
- *
- * @example
- * ```ts
- * const platform = detectPlatform() // 'mac' | 'windows' | 'linux'
- * const modifier = resolveModifier('Mod', platform) // 'Meta' on Mac, 'Control' elsewhere
- * ```
- */
-declare function detectPlatform(): 'mac' | 'windows' | 'linux';
 /**
  * Canonical order for modifiers in normalized hotkey strings.
  *
@@ -31,7 +14,7 @@ declare function detectPlatform(): 'mac' | 'windows' | 'linux';
  * // Normalized: 'Control+Alt+Shift+Meta+S' (following MODIFIER_ORDER)
  * ```
  */
-declare const MODIFIER_ORDER: Array<CanonicalModifier>;
+export declare const MODIFIER_ORDER: Array<CanonicalModifier>;
 /**
  * Set of canonical modifier key names for fast lookup.
  *
@@ -39,7 +22,7 @@ declare const MODIFIER_ORDER: Array<CanonicalModifier>;
  * a modifier is released so we can clear non-modifier keys whose keyup events
  * may have been swallowed by the OS (e.g. macOS Cmd+key combos).
  */
-declare const MODIFIER_KEYS: Set<string>;
+export declare const MODIFIER_KEYS: Set<string>;
 /**
  * Maps modifier key aliases to their canonical form or platform-adaptive 'Mod'.
  *
@@ -59,36 +42,14 @@ declare const MODIFIER_KEYS: Set<string>;
  * MODIFIER_ALIASES['Mod'] // 'Mod' (resolved at runtime)
  * ```
  */
-declare const MODIFIER_ALIASES: Record<string, CanonicalModifier | 'Mod'>;
-/**
- * Resolves the platform-adaptive 'Mod' modifier to the appropriate canonical modifier.
- *
- * The 'Mod' token represents the "primary modifier" on each platform:
- * - macOS: 'Meta' (Command key ⌘)
- * - Windows/Linux: 'Control' (Ctrl key)
- *
- * This enables cross-platform hotkey definitions like 'Mod+S' that automatically
- * map to Command+S on Mac and Ctrl+S on Windows/Linux.
- *
- * @param modifier - The modifier to resolve. If 'Mod', resolves based on platform.
- * @param platform - The target platform. Defaults to auto-detection.
- * @returns The canonical modifier name ('Control', 'Shift', 'Alt', or 'Meta')
- *
- * @example
- * ```ts
- * resolveModifier('Mod', 'mac') // 'Meta'
- * resolveModifier('Mod', 'windows') // 'Control'
- * resolveModifier('Control', 'mac') // 'Control' (unchanged)
- * ```
- */
-declare function resolveModifier(modifier: CanonicalModifier | 'Mod', platform?: 'mac' | 'windows' | 'linux'): CanonicalModifier;
+export declare const MODIFIER_ALIASES: Record<string, CanonicalModifier | 'Mod'>;
 /**
  * Set of all valid letter keys (A-Z).
  *
  * Used for validation and type checking. Letter keys are matched case-insensitively
  * in hotkey matching, but normalized to uppercase in canonical form.
  */
-declare const LETTER_KEYS: Set<LetterKey>;
+export declare const LETTER_KEYS: Set<LetterKey>;
 /**
  * Set of all valid number keys (0-9).
  *
@@ -96,14 +57,14 @@ declare const LETTER_KEYS: Set<LetterKey>;
  * so they're excluded from Shift-based hotkey combinations to avoid
  * layout-dependent behavior.
  */
-declare const NUMBER_KEYS: Set<NumberKey>;
+export declare const NUMBER_KEYS: Set<NumberKey>;
 /**
- * Set of all valid function keys (F1-F12).
+ * Set of all valid function keys (F1-F24).
  *
  * Function keys are commonly used for system shortcuts (e.g., F12 for DevTools,
  * Alt+F4 to close windows) and application-specific commands.
  */
-declare const FUNCTION_KEYS: Set<FunctionKey>;
+export declare const FUNCTION_KEYS: Set<FunctionKey>;
 /**
  * Set of all valid navigation keys for cursor movement and document navigation.
  *
@@ -111,7 +72,7 @@ declare const FUNCTION_KEYS: Set<FunctionKey>;
  * These keys are commonly combined with modifiers for selection (Shift+ArrowUp) or
  * navigation shortcuts (Alt+ArrowLeft for back).
  */
-declare const NAVIGATION_KEYS: Set<NavigationKey>;
+export declare const NAVIGATION_KEYS: Set<NavigationKey>;
 /**
  * Set of all valid editing and special keys.
  *
@@ -119,7 +80,7 @@ declare const NAVIGATION_KEYS: Set<NavigationKey>;
  * special actions (Escape, Space). These keys are frequently combined with modifiers
  * for editor shortcuts (Mod+Enter to submit, Shift+Tab to go back).
  */
-declare const EDITING_KEYS: Set<EditingKey>;
+export declare const EDITING_KEYS: Set<EditingKey>;
 /**
  * Set of all valid punctuation keys commonly used in keyboard shortcuts.
  *
@@ -132,7 +93,7 @@ declare const EDITING_KEYS: Set<EditingKey>;
  * Note: Punctuation keys are affected by Shift (Shift+',' → '<' on US layout),
  * so they're excluded from Shift-based hotkey combinations to avoid layout-dependent behavior.
  */
-declare const PUNCTUATION_KEYS: Set<PunctuationKey>;
+export declare const PUNCTUATION_KEYS: Set<PunctuationKey>;
 /**
  * Maps `KeyboardEvent.code` values for punctuation keys to their canonical characters.
  *
@@ -142,7 +103,7 @@ declare const PUNCTUATION_KEYS: Set<PunctuationKey>;
  * falling back to `event.code` for punctuation keys, similar to the existing `Key*`/`Digit*`
  * fallbacks for letters and digits.
  */
-declare const PUNCTUATION_CODE_MAP: Record<string, string>;
+export declare const PUNCTUATION_CODE_MAP: Record<string, string>;
 /**
  * Set of all valid non-modifier keys.
  *
@@ -157,7 +118,7 @@ declare const PUNCTUATION_CODE_MAP: Record<string, string>;
  * @see {@link EDITING_KEYS}
  * @see {@link PUNCTUATION_KEYS}
  */
-declare const ALL_KEYS: Set<LetterKey | NumberKey | FunctionKey | NavigationKey | EditingKey | PunctuationKey>;
+export declare const ALL_KEYS: Set<LetterKey | NumberKey | FunctionKey | NavigationKey | EditingKey | PunctuationKey | "CapsLock" | "ContextMenu" | "Convert" | "KanaMode" | "NonConvert" | "Help" | "Insert" | "NumLock" | "Fn" | "FnLock" | "PrintScreen" | "ScrollLock" | "Pause" | "BrowserBack" | "BrowserFavorites" | "BrowserForward" | "BrowserHome" | "BrowserRefresh" | "BrowserSearch" | "BrowserStop" | "Eject" | "LaunchMail" | "MediaPlayPause" | "MediaStop" | "MediaTrackNext" | "MediaTrackPrevious" | "Power" | "AudioVolumeDown" | "AudioVolumeMute" | "AudioVolumeUp" | "WakeUp" | "Hyper" | "Super" | "Again" | "Copy" | "Cut" | "Find" | "Open" | "Paste" | "Props" | "Select" | "Undo" | "Hiragana" | "Katakana" | "Clear" | "Cancel" | "Standby" | "LaunchApplication1" | "LaunchApplication2" | "LaunchMediaPlayer" | "HangulMode" | "HanjaMode" | "Zenkaku" | "Hankaku" | "ZenkakuHankaku">;
 /**
  * Normalizes a key name to its canonical form.
  *
@@ -182,7 +143,7 @@ declare const ALL_KEYS: Set<LetterKey | NumberKey | FunctionKey | NavigationKey
  * normalizeKeyName('ArrowUp') // 'ArrowUp' (already canonical)
  * ```
  */
-declare function isSingleLetterKey(key: string): boolean;
+export declare function isSingleLetterKey(key: string): boolean;
 /**
  * Normalizes a key name to its canonical form.
  *
@@ -197,94 +158,5 @@ declare function isSingleLetterKey(key: string): boolean;
  * normalizeKeyName('ArrowUp') // 'ArrowUp' (already canonical)
  * ```
  */
-declare function normalizeKeyName(key: string): string;
-/**
- * Modifier key symbols for macOS display.
- *
- * Used by formatting functions to display hotkeys with macOS-style symbols
- * (e.g., ⌘ for Command, ⌃ for Control) instead of text labels. This provides
- * a native macOS look and feel in hotkey displays.
- *
- * @example
- * ```ts
- * MAC_MODIFIER_SYMBOLS['Meta'] // '⌘'
- * MAC_MODIFIER_SYMBOLS['Control'] // '⌃'
- * MAC_MODIFIER_SYMBOLS['Alt'] // '⌥'
- * MAC_MODIFIER_SYMBOLS['Shift'] // '⇧'
- * ```
- */
-declare const MAC_MODIFIER_SYMBOLS: Record<CanonicalModifier | 'Mod', string>;
-/**
- * Modifier key labels for macOS display.
- *
- * Used by formatting functions to display hotkeys with macOS-style text labels
- * (e.g., 'Control' for Control, 'Option' for Alt, 'Cmd' for Meta) instead of symbols.
- * This provides a familiar macOS look and feel in hotkey displays.
- *
- * @example
- * ```ts
- * MAC_MODIFIER_LABELS['Control'] // 'control'
- * MAC_MODIFIER_LABELS['Alt'] // 'option'
- * MAC_MODIFIER_LABELS['Shift'] // 'shift'
- * MAC_MODIFIER_LABELS['Meta'] // 'cmd'
- * ```
- */
-declare const MAC_MODIFIER_LABELS: Record<CanonicalModifier | 'Mod', string>;
-/**
- * Modifier key labels for Windows/Linux display.
- *
- * Used by formatting functions to display hotkeys with standard text labels
- * (e.g., 'Ctrl' for Control, 'Win' for Meta/Windows key) instead of symbols.
- * This provides a familiar Windows/Linux look and feel in hotkey displays.
- *
- * @example
- * ```ts
- * STANDARD_MODIFIER_LABELS['Control'] // 'Ctrl'
- * STANDARD_MODIFIER_LABELS['Meta'] // 'Win'
- * STANDARD_MODIFIER_LABELS['Alt'] // 'Alt'
- * STANDARD_MODIFIER_LABELS['Shift'] // 'Shift'
- * ```
- */
-declare const WINDOWS_MODIFIER_LABELS: Record<CanonicalModifier | 'Mod', string>;
-declare const LINUX_MODIFIER_LABELS: Record<CanonicalModifier | 'Mod', string>;
-declare const PUNCTUATION_KEY_DISPLAY_LABELS: {
-  readonly '`': "Backquote";
-  readonly '\\': "Backslash";
-  readonly '[': "Left Bracket";
-  readonly ']': "Right Bracket";
-  readonly ',': "Comma";
-  readonly '=': "Equal";
-  readonly '-': "Minus";
-  readonly '.': "Period";
-  readonly ';': "Semicolon";
-};
-/**
- * Special key symbols for display formatting.
- *
- * Maps certain keys to their visual symbols for better readability in hotkey displays.
- * Used by formatting functions to show symbols like ↑ for ArrowUp or ↵ for Enter
- * instead of text labels.
- *
- * @example
- * ```ts
- * KEY_DISPLAY_SYMBOLS['ArrowUp'] // '↑'
- * KEY_DISPLAY_SYMBOLS['Enter'] // '↵'
- * KEY_DISPLAY_SYMBOLS['Escape'] // 'Esc'
- * KEY_DISPLAY_SYMBOLS['Space'] // '␣'
- * ```
- */
-declare const KEY_DISPLAY_SYMBOLS: {
-  readonly ArrowUp: "↑";
-  readonly ArrowDown: "↓";
-  readonly ArrowLeft: "←";
-  readonly ArrowRight: "→";
-  readonly Enter: "↵";
-  readonly Escape: "Esc";
-  readonly Backspace: "⌫";
-  readonly Delete: "⌦";
-  readonly Tab: "⇥";
-  readonly Space: "␣";
-};
-//#endregion
-export { ALL_KEYS, EDITING_KEYS, FUNCTION_KEYS, KEY_DISPLAY_SYMBOLS, LETTER_KEYS, LINUX_MODIFIER_LABELS, MAC_MODIFIER_LABELS, MAC_MODIFIER_SYMBOLS, MODIFIER_ALIASES, MODIFIER_KEYS, MODIFIER_ORDER, NAVIGATION_KEYS, NUMBER_KEYS, PUNCTUATION_CODE_MAP, PUNCTUATION_KEYS, PUNCTUATION_KEY_DISPLAY_LABELS, WINDOWS_MODIFIER_LABELS, detectPlatform, isSingleLetterKey, normalizeKeyName, resolveModifier };
-//# sourceMappingURL=constants.d.ts.map
+export declare function normalizeKeyName(key: string): string;
+//#endregion

package/dist/constants.js

@@ -1,28 +1,7 @@
+import { LOGICAL_ONLY_NAMED_KEYS, SHARED_NAMED_KEYS } from "./_named-keys.js";
+
 //#region src/constants.ts
 /**
-* Detects the current platform based on browser navigator properties.
-*
-* Used internally to resolve platform-adaptive modifiers like 'Mod' (Command on Mac,
-* Control elsewhere) and for platform-specific hotkey formatting.
-*
-* @returns The detected platform: 'mac', 'windows', or 'linux'
-* @remarks Defaults to 'linux' in SSR environments where navigator is undefined
-*
-* @example
-* ```ts
-* const platform = detectPlatform() // 'mac' | 'windows' | 'linux'
-* const modifier = resolveModifier('Mod', platform) // 'Meta' on Mac, 'Control' elsewhere
-* ```
-*/
-function detectPlatform() {
-	if (typeof navigator === "undefined") return "linux";
-	const platform = navigator.platform?.toLowerCase() ?? "";
-	const userAgent = navigator.userAgent?.toLowerCase() ?? "";
-	if (platform.includes("mac") || userAgent.includes("mac")) return "mac";
-	if (platform.includes("win") || userAgent.includes("win")) return "windows";
-	return "linux";
-}
-/**
 * Canonical order for modifiers in normalized hotkey strings.
 *
 * Defines the standard order in which modifiers should appear when formatting
@@ -96,37 +75,12 @@ const MODIFIER_ALIASES = {
 	mod: "Mod"
 };
 /**
-* Resolves the platform-adaptive 'Mod' modifier to the appropriate canonical modifier.
-*
-* The 'Mod' token represents the "primary modifier" on each platform:
-* - macOS: 'Meta' (Command key ⌘)
-* - Windows/Linux: 'Control' (Ctrl key)
-*
-* This enables cross-platform hotkey definitions like 'Mod+S' that automatically
-* map to Command+S on Mac and Ctrl+S on Windows/Linux.
-*
-* @param modifier - The modifier to resolve. If 'Mod', resolves based on platform.
-* @param platform - The target platform. Defaults to auto-detection.
-* @returns The canonical modifier name ('Control', 'Shift', 'Alt', or 'Meta')
-*
-* @example
-* ```ts
-* resolveModifier('Mod', 'mac') // 'Meta'
-* resolveModifier('Mod', 'windows') // 'Control'
-* resolveModifier('Control', 'mac') // 'Control' (unchanged)
-* ```
-*/
-function resolveModifier(modifier, platform = detectPlatform()) {
-	if (modifier === "Mod") return platform === "mac" ? "Meta" : "Control";
-	return modifier;
-}
-/**
 * Set of all valid letter keys (A-Z).
 *
 * Used for validation and type checking. Letter keys are matched case-insensitively
 * in hotkey matching, but normalized to uppercase in canonical form.
 */
-const LETTER_KEYS = new Set([
+const LETTER_KEYS = /* @__PURE__ */ new Set([
 	"A",
 	"B",
 	"C",
@@ -161,7 +115,7 @@ const LETTER_KEYS = new Set([
 * so they're excluded from Shift-based hotkey combinations to avoid
 * layout-dependent behavior.
 */
-const NUMBER_KEYS = new Set([
+const NUMBER_KEYS = /* @__PURE__ */ new Set([
 	"0",
 	"1",
 	"2",
@@ -174,12 +128,12 @@ const NUMBER_KEYS = new Set([
 	"9"
 ]);
 /**
-* Set of all valid function keys (F1-F12).
+* Set of all valid function keys (F1-F24).
 *
 * Function keys are commonly used for system shortcuts (e.g., F12 for DevTools,
 * Alt+F4 to close windows) and application-specific commands.
 */
-const FUNCTION_KEYS = new Set([
+const FUNCTION_KEYS = /* @__PURE__ */ new Set([
 	"F1",
 	"F2",
 	"F3",
@@ -191,7 +145,19 @@ const FUNCTION_KEYS = new Set([
 	"F9",
 	"F10",
 	"F11",
-	"F12"
+	"F12",
+	"F13",
+	"F14",
+	"F15",
+	"F16",
+	"F17",
+	"F18",
+	"F19",
+	"F20",
+	"F21",
+	"F22",
+	"F23",
+	"F24"
 ]);
 /**
 * Set of all valid navigation keys for cursor movement and document navigation.
@@ -200,7 +166,7 @@ const FUNCTION_KEYS = new Set([
 * These keys are commonly combined with modifiers for selection (Shift+ArrowUp) or
 * navigation shortcuts (Alt+ArrowLeft for back).
 */
-const NAVIGATION_KEYS = new Set([
+const NAVIGATION_KEYS = /* @__PURE__ */ new Set([
 	"ArrowUp",
 	"ArrowDown",
 	"ArrowLeft",
@@ -217,7 +183,7 @@ const NAVIGATION_KEYS = new Set([
 * special actions (Escape, Space). These keys are frequently combined with modifiers
 * for editor shortcuts (Mod+Enter to submit, Shift+Tab to go back).
 */
-const EDITING_KEYS = new Set([
+const EDITING_KEYS = /* @__PURE__ */ new Set([
 	"Enter",
 	"Escape",
 	"Space",
@@ -237,7 +203,7 @@ const EDITING_KEYS = new Set([
 * Note: Punctuation keys are affected by Shift (Shift+',' → '<' on US layout),
 * so they're excluded from Shift-based hotkey combinations to avoid layout-dependent behavior.
 */
-const PUNCTUATION_KEYS = new Set([
+const PUNCTUATION_KEYS = /* @__PURE__ */ new Set([
 	"/",
 	"[",
 	"]",
@@ -247,7 +213,29 @@ const PUNCTUATION_KEYS = new Set([
 	",",
 	".",
 	";",
-	"`"
+	"`",
+	"'",
+	"+",
+	"?",
+	"!",
+	"@",
+	"#",
+	"$",
+	"%",
+	"^",
+	"&",
+	"*",
+	"(",
+	")",
+	"_",
+	"{",
+	"}",
+	"|",
+	":",
+	"\"",
+	"<",
+	">",
+	"~"
 ]);
 /**
 * Maps `KeyboardEvent.code` values for punctuation keys to their canonical characters.
@@ -267,6 +255,7 @@ const PUNCTUATION_CODE_MAP = {
 	Equal: "=",
 	Minus: "-",
 	Period: ".",
+	Quote: "'",
 	Semicolon: ";",
 	Slash: "/"
 };
@@ -284,14 +273,17 @@ const PUNCTUATION_CODE_MAP = {
 * @see {@link EDITING_KEYS}
 * @see {@link PUNCTUATION_KEYS}
 */
-const ALL_KEYS = new Set([
+const ALL_KEYS = /* @__PURE__ */ new Set([
 	...LETTER_KEYS,
 	...NUMBER_KEYS,
 	...FUNCTION_KEYS,
 	...NAVIGATION_KEYS,
 	...EDITING_KEYS,
-	...PUNCTUATION_KEYS
+	...PUNCTUATION_KEYS,
+	...SHARED_NAMED_KEYS,
+	...LOGICAL_ONLY_NAMED_KEYS
 ]);
+const CANONICAL_KEY_NAMES = new Map(Array.from(ALL_KEYS, (key) => [key.toLowerCase(), key]));
 /**
 * Maps key name aliases to their canonical form.
 *
@@ -312,6 +304,8 @@ const ALL_KEYS = new Set([
 * ```
 */
 const KEY_ALIASES = {
+	Plus: "+",
+	plus: "+",
 	Esc: "Escape",
 	esc: "Escape",
 	escape: "Escape",
@@ -396,119 +390,8 @@ function normalizeKeyName(key) {
 		const upper = key.toUpperCase();
 		return upper.length === 1 ? upper : key;
 	}
-	const upperKey = key.toUpperCase();
-	if (/^F([1-9]|1[0-2])$/.test(upperKey)) return upperKey;
-	return key;
+	return CANONICAL_KEY_NAMES.get(key.toLowerCase()) ?? key;
 }
-/**
-* Modifier key symbols for macOS display.
-*
-* Used by formatting functions to display hotkeys with macOS-style symbols
-* (e.g., ⌘ for Command, ⌃ for Control) instead of text labels. This provides
-* a native macOS look and feel in hotkey displays.
-*
-* @example
-* ```ts
-* MAC_MODIFIER_SYMBOLS['Meta'] // '⌘'
-* MAC_MODIFIER_SYMBOLS['Control'] // '⌃'
-* MAC_MODIFIER_SYMBOLS['Alt'] // '⌥'
-* MAC_MODIFIER_SYMBOLS['Shift'] // '⇧'
-* ```
-*/
-const MAC_MODIFIER_SYMBOLS = {
-	Control: "⌃",
-	Alt: "⌥",
-	Shift: "⇧",
-	Meta: "⌘",
-	Mod: "⌘"
-};
-/**
-* Modifier key labels for macOS display.
-*
-* Used by formatting functions to display hotkeys with macOS-style text labels
-* (e.g., 'Control' for Control, 'Option' for Alt, 'Cmd' for Meta) instead of symbols.
-* This provides a familiar macOS look and feel in hotkey displays.
-*
-* @example
-* ```ts
-* MAC_MODIFIER_LABELS['Control'] // 'control'
-* MAC_MODIFIER_LABELS['Alt'] // 'option'
-* MAC_MODIFIER_LABELS['Shift'] // 'shift'
-* MAC_MODIFIER_LABELS['Meta'] // 'cmd'
-* ```
-*/
-const MAC_MODIFIER_LABELS = {
-	Control: "Control",
-	Alt: "Option",
-	Shift: "Shift",
-	Meta: "Cmd",
-	Mod: "Cmd"
-};
-/**
-* Modifier key labels for Windows/Linux display.
-*
-* Used by formatting functions to display hotkeys with standard text labels
-* (e.g., 'Ctrl' for Control, 'Win' for Meta/Windows key) instead of symbols.
-* This provides a familiar Windows/Linux look and feel in hotkey displays.
-*
-* @example
-* ```ts
-* STANDARD_MODIFIER_LABELS['Control'] // 'Ctrl'
-* STANDARD_MODIFIER_LABELS['Meta'] // 'Win'
-* STANDARD_MODIFIER_LABELS['Alt'] // 'Alt'
-* STANDARD_MODIFIER_LABELS['Shift'] // 'Shift'
-* ```
-*/
-const WINDOWS_MODIFIER_LABELS = {
-	Control: "Ctrl",
-	Alt: "Alt",
-	Shift: "Shift",
-	Meta: "Win",
-	Mod: "Ctrl"
-};
-const LINUX_MODIFIER_LABELS = {
-	...WINDOWS_MODIFIER_LABELS,
-	Meta: "Super"
-};
-const PUNCTUATION_KEY_DISPLAY_LABELS = {
-	"`": "Backquote",
-	"\\": "Backslash",
-	"[": "Left Bracket",
-	"]": "Right Bracket",
-	",": "Comma",
-	"=": "Equal",
-	"-": "Minus",
-	".": "Period",
-	";": "Semicolon"
-};
-/**
-* Special key symbols for display formatting.
-*
-* Maps certain keys to their visual symbols for better readability in hotkey displays.
-* Used by formatting functions to show symbols like ↑ for ArrowUp or ↵ for Enter
-* instead of text labels.
-*
-* @example
-* ```ts
-* KEY_DISPLAY_SYMBOLS['ArrowUp'] // '↑'
-* KEY_DISPLAY_SYMBOLS['Enter'] // '↵'
-* KEY_DISPLAY_SYMBOLS['Escape'] // 'Esc'
-* KEY_DISPLAY_SYMBOLS['Space'] // '␣'
-* ```
-*/
-const KEY_DISPLAY_SYMBOLS = {
-	ArrowUp: "↑",
-	ArrowDown: "↓",
-	ArrowLeft: "←",
-	ArrowRight: "→",
-	Enter: "↵",
-	Escape: "Esc",
-	Backspace: "⌫",
-	Delete: "⌦",
-	Tab: "⇥",
-	Space: "␣"
-};
 
 //#endregion
-export { ALL_KEYS, EDITING_KEYS, FUNCTION_KEYS, KEY_DISPLAY_SYMBOLS, LETTER_KEYS, LINUX_MODIFIER_LABELS, MAC_MODIFIER_LABELS, MAC_MODIFIER_SYMBOLS, MODIFIER_ALIASES, MODIFIER_KEYS, MODIFIER_ORDER, NAVIGATION_KEYS, NUMBER_KEYS, PUNCTUATION_CODE_MAP, PUNCTUATION_KEYS, PUNCTUATION_KEY_DISPLAY_LABELS, WINDOWS_MODIFIER_LABELS, detectPlatform, isSingleLetterKey, normalizeKeyName, resolveModifier };
-//# sourceMappingURL=constants.js.map
+export { ALL_KEYS, EDITING_KEYS, FUNCTION_KEYS, LETTER_KEYS, MODIFIER_ALIASES, MODIFIER_KEYS, MODIFIER_ORDER, NAVIGATION_KEYS, NUMBER_KEYS, PUNCTUATION_CODE_MAP, PUNCTUATION_KEYS, isSingleLetterKey, normalizeKeyName };

package/dist/display-labels.d.ts

@@ -0,0 +1,90 @@
+import { CanonicalModifier } from "./key.types.js";
+//#region src/display-labels.d.ts
+/**
+ * Modifier key symbols for macOS display.
+ *
+ * Used by formatting functions to display hotkeys with macOS-style symbols
+ * (e.g., ⌘ for Command, ⌃ for Control) instead of text labels. This provides
+ * a native macOS look and feel in hotkey displays.
+ *
+ * @example
+ * ```ts
+ * MAC_MODIFIER_SYMBOLS['Meta'] // '⌘'
+ * MAC_MODIFIER_SYMBOLS['Control'] // '⌃'
+ * MAC_MODIFIER_SYMBOLS['Alt'] // '⌥'
+ * MAC_MODIFIER_SYMBOLS['Shift'] // '⇧'
+ * ```
+ */
+export declare const MAC_MODIFIER_SYMBOLS: Record<CanonicalModifier | 'Mod', string>;
+/**
+ * Modifier key labels for macOS display.
+ *
+ * Used by formatting functions to display hotkeys with macOS-style text labels
+ * (e.g., 'Control' for Control, 'Option' for Alt, 'Cmd' for Meta) instead of symbols.
+ * This provides a familiar macOS look and feel in hotkey displays.
+ *
+ * @example
+ * ```ts
+ * MAC_MODIFIER_LABELS['Control'] // 'control'
+ * MAC_MODIFIER_LABELS['Alt'] // 'option'
+ * MAC_MODIFIER_LABELS['Shift'] // 'shift'
+ * MAC_MODIFIER_LABELS['Meta'] // 'cmd'
+ * ```
+ */
+export declare const MAC_MODIFIER_LABELS: Record<CanonicalModifier | 'Mod', string>;
+/**
+ * Modifier key labels for Windows/Linux display.
+ *
+ * Used by formatting functions to display hotkeys with standard text labels
+ * (e.g., 'Ctrl' for Control, 'Win' for Meta/Windows key) instead of symbols.
+ * This provides a familiar Windows/Linux look and feel in hotkey displays.
+ *
+ * @example
+ * ```ts
+ * STANDARD_MODIFIER_LABELS['Control'] // 'Ctrl'
+ * STANDARD_MODIFIER_LABELS['Meta'] // 'Win'
+ * STANDARD_MODIFIER_LABELS['Alt'] // 'Alt'
+ * STANDARD_MODIFIER_LABELS['Shift'] // 'Shift'
+ * ```
+ */
+export declare const WINDOWS_MODIFIER_LABELS: Record<CanonicalModifier | 'Mod', string>;
+export declare const LINUX_MODIFIER_LABELS: Record<CanonicalModifier | 'Mod', string>;
+export declare const PUNCTUATION_KEY_DISPLAY_LABELS: {
+  readonly '`': "Backquote";
+  readonly '\\': "Backslash";
+  readonly '[': "Left Bracket";
+  readonly ']': "Right Bracket";
+  readonly ',': "Comma";
+  readonly '=': "Equal";
+  readonly '-': "Minus";
+  readonly '.': "Period";
+  readonly ';': "Semicolon";
+};
+/**
+ * Special key symbols for display formatting.
+ *
+ * Maps certain keys to their visual symbols for better readability in hotkey displays.
+ * Used by formatting functions to show symbols like ↑ for ArrowUp or ↵ for Enter
+ * instead of text labels.
+ *
+ * @example
+ * ```ts
+ * KEY_DISPLAY_SYMBOLS['ArrowUp'] // '↑'
+ * KEY_DISPLAY_SYMBOLS['Enter'] // '↵'
+ * KEY_DISPLAY_SYMBOLS['Escape'] // 'Esc'
+ * KEY_DISPLAY_SYMBOLS['Space'] // '␣'
+ * ```
+ */
+export declare const KEY_DISPLAY_SYMBOLS: {
+  readonly ArrowUp: "↑";
+  readonly ArrowDown: "↓";
+  readonly ArrowLeft: "←";
+  readonly ArrowRight: "→";
+  readonly Enter: "↵";
+  readonly Escape: "Esc";
+  readonly Backspace: "⌫";
+  readonly Delete: "⌦";
+  readonly Tab: "⇥";
+  readonly Space: "␣";
+};
+//#endregion