@tanstack/vue-hotkeys 0.20.0 → 0.21.0

package/dist/HotkeysProviderContext.d.ts

@@ -1,9 +1,15 @@
 import { UseHotkeyCommonOptions } from "./useHotkey.js";
-import { AppHotkeys, AppHotkeysStore, CustomHotkeys, HotkeyChordRecorderOptions, HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
+import { AppHotkeys, AppHotkeysStore, CustomHotkeys, HotkeyChordRecorderOptions, HotkeyPlatform, HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
 import { MaybeRefOrGetter } from "vue";
 import { HotkeysProviderScopeProps } from "@tanstack/hotkeys/adapter";
 //#region src/HotkeysProviderContext.d.ts
 export interface HotkeysProviderOptions {
+  /**
+   * The user's platform, for labels from `useFormatForDisplay`, hotkeys, and
+   * recorders. On a server, set it from the request with
+   * `detectPlatform(userAgent)`.
+   */
+  platform?: HotkeyPlatform;
   /**
    * Defaults for every hotkey registered by `useHotkey` and `useHotkeys`.
    * `requireReset` applies to chords and `timeout` applies to sequences.

package/dist/index.d.ts

@@ -9,6 +9,7 @@ import { VueHotkeyRecorder, useHotkeyRecorder } from "./useHotkeyRecorder.js";
 import { useHotkeyRegistrations } from "./useHotkeyRegistrations.js";
 import { useHotkeyScopesState } from "./useHotkeyScopesState.js";
 import { useHotkeyHint } from "./useHotkeyHint.js";
+import { useFormatForDisplay } from "./useFormatForDisplay.js";
 import { UseCustomHotkeysResult, useAppHotkeyList, useAppHotkeys, useCustomHotkeys } from "./useAppHotkeys.js";
 export * from "@tanstack/hotkeys";
-export { HotkeysProvider, HotkeysProviderOptions, ProvideHotkeysContextOptions, UseAppHotkeyOptions, UseCustomHotkeysResult, UseHotkeyChordOptions, UseHotkeyCommonOptions, UseHotkeyDefinition, UseHotkeyOptions, UseHotkeyOptionsFor, UseHotkeySequenceOptions, UseHotkeyTarget, VueHotkeyRecorder, provideHotkeysContext, useAppHotkeyList, useAppHotkeys, useCustomHotkeys, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, useHotkeyScopesState, useHotkeys, useHotkeysContext, useKeyHold };
+export { HotkeysProvider, HotkeysProviderOptions, ProvideHotkeysContextOptions, UseAppHotkeyOptions, UseCustomHotkeysResult, UseHotkeyChordOptions, UseHotkeyCommonOptions, UseHotkeyDefinition, UseHotkeyOptions, UseHotkeyOptionsFor, UseHotkeySequenceOptions, UseHotkeyTarget, VueHotkeyRecorder, provideHotkeysContext, useAppHotkeyList, useAppHotkeys, useCustomHotkeys, useDefaultHotkeysOptions, useFormatForDisplay, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, useHotkeyScopesState, useHotkeys, useHotkeysContext, useKeyHold };

package/dist/index.js

@@ -9,8 +9,9 @@ import { useHotkeyRecorder } from "./useHotkeyRecorder.js";
 import { useHotkeyRegistrations } from "./useHotkeyRegistrations.js";
 import { useHotkeyScopesState } from "./useHotkeyScopesState.js";
 import { useHotkeyHint } from "./useHotkeyHint.js";
+import { useFormatForDisplay } from "./useFormatForDisplay.js";
 import { useAppHotkeyList, useAppHotkeys, useCustomHotkeys } from "./useAppHotkeys.js";
 
 export * from "@tanstack/hotkeys"
 
-export { HotkeysProvider, provideHotkeysContext, useAppHotkeyList, useAppHotkeys, useCustomHotkeys, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, useHotkeyScopesState, useHotkeys, useHotkeysContext, useKeyHold };
+export { HotkeysProvider, provideHotkeysContext, useAppHotkeyList, useAppHotkeys, useCustomHotkeys, useDefaultHotkeysOptions, useFormatForDisplay, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, useHotkeyScopesState, useHotkeys, useHotkeysContext, useKeyHold };

package/dist/useFormatForDisplay.d.ts

@@ -0,0 +1,24 @@
+import { formatForDisplay } from "@tanstack/hotkeys";
+//#region src/useFormatForDisplay.d.ts
+/**
+ * Returns `formatForDisplay` with the provider's `platform` as the default,
+ * so labels match the user's platform. Call in `setup`; the returned function
+ * works anywhere, and templates update when the provider's platform changes.
+ * An explicit `platform` option wins.
+ *
+ * Server-rendered apps should set the provider's `defaultOptions.platform`
+ * from the request user agent with `detectPlatform(userAgent)`.
+ *
+ * @example
+ * ```vue
+ * <script setup lang="ts">
+ * const format = useFormatForDisplay()
+ * </script>
+ *
+ * <template>
+ *   <kbd>{{ format('Mod+S') }}</kbd>
+ * </template>
+ * ```
+ */
+export declare function useFormatForDisplay(): typeof formatForDisplay;
+//#endregion

package/dist/useFormatForDisplay.js

@@ -0,0 +1,34 @@
+import { useDefaultHotkeysOptionsSource } from "./defaultOptions.js";
+import { formatForDisplay } from "@tanstack/hotkeys";
+
+//#region src/useFormatForDisplay.ts
+/**
+* Returns `formatForDisplay` with the provider's `platform` as the default,
+* so labels match the user's platform. Call in `setup`; the returned function
+* works anywhere, and templates update when the provider's platform changes.
+* An explicit `platform` option wins.
+*
+* Server-rendered apps should set the provider's `defaultOptions.platform`
+* from the request user agent with `detectPlatform(userAgent)`.
+*
+* @example
+* ```vue
+* <script setup lang="ts">
+* const format = useFormatForDisplay()
+* <\/script>
+*
+* <template>
+*   <kbd>{{ format('Mod+S') }}</kbd>
+* </template>
+* ```
+*/
+function useFormatForDisplay() {
+	const defaultOptions = useDefaultHotkeysOptionsSource();
+	return ((hotkey, options) => formatForDisplay(hotkey, {
+		...options,
+		platform: options?.platform ?? defaultOptions().platform
+	}));
+}
+
+//#endregion
+export { useFormatForDisplay };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/vue-hotkeys",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "Vue adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -38,7 +38,7 @@
     "skills"
   ],
   "dependencies": {
-    "@tanstack/hotkeys": "0.22.1"
+    "@tanstack/hotkeys": "0.23.0"
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "^6.0.9",

package/skills/vue-hotkeys/SKILL.md

@@ -60,6 +60,7 @@ useHotkey('Escape', () => closePanel(), { target: panel })
 | `provideHotkeysContext(options)`          | Provide the same options from a component's setup instead of rendering `HotkeysProvider`; they apply to its children.                                                                                    |
 | `useHotkeysContext()`                     | Read the nearest provider's merged defaults and enabled state, or `null` outside a provider.                                                                                                             |
 | `useDefaultHotkeysOptions()`              | Read the default options merged from every provider above.                                                                                                                                               |
+| `useFormatForDisplay()`                   | Get `formatForDisplay` with the provider's `platform` filled in, for labels in server-rendered apps. Call it in `setup`.                                                                                 |
 | `useAppHotkeys()`                         | Get a computed ref of the declared app hotkeys with the user's custom hotkeys applied.                                                                                                                   |
 | `useAppHotkeyList()`                      | Get a computed ref listing every app hotkey with its status, for a cheat sheet or settings screen.                                                                                                       |
 | `useCustomHotkeys()`                      | Read, change, and reset the user's custom hotkeys, and check a new one for conflicts.                                                                                                                    |
@@ -82,6 +83,7 @@ No provider is required. Call the composables synchronously in setup.
 - **Destructure the recorder.** Templates unwrap only top-level refs, so `v-if="recorder.isRecording"` is always true. Use `const { isRecording, startRecording } = useHotkeyRecorder(...)`.
 - **The callback isn't tracked.** Read refs and props inside it.
 - **Call the composables directly.** A `useShortcut(keys: string)` wrapper has to cast strings to hotkeys, which turns off type checking and drops sequences, reactive options, and app hotkeys.
+- **Server-rendered labels need the user's platform.** On the server, `formatForDisplay` can't see the user's OS, so it renders Linux labels that differ after hydration for Mac and Windows users. Set the provider's `defaultOptions.platform` to `detectPlatform(userAgent)` from the request's `User-Agent` header, and format labels with `const format = useFormatForDisplay()` in `setup`, then `format(hotkey)`. Keep plain `formatForDisplay` for labels that render only in the browser.
 
 When declaring app hotkeys, building a cheat sheet, or letting users rebind shortcuts, load `@tanstack/hotkeys#app-hotkeys` and read [app hotkeys in Vue](references/app-hotkeys.md).