@tanstack/octane-hotkeys 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Tanner Linsley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,140 @@
-# Temporary Holding Version
+<div align="center">
+  <picture>
+    <source
+      media="(prefers-color-scheme: dark)"
+      srcset="https://tanstack.com/api/readme/hotkeys.png?theme=dark"
+    />
+    <source
+      media="(prefers-color-scheme: light)"
+      srcset="https://tanstack.com/api/readme/hotkeys.png"
+    />
+    <img
+      src="https://tanstack.com/api/readme/hotkeys.png"
+      alt="TanStack Hotkeys"
+      width="900"
+    />
+  </picture>
+</div>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<br />
+
+<div align="center">
+	<a href="https://www.npmjs.com/package/@tanstack/hotkeys" target="\_parent">
+	  <img alt="" src="https://img.shields.io/npm/dm/@tanstack/hotkeys.svg" alt="npm downloads" />
+	</a>
+	<a href="https://github.com/TanStack/hotkeys" target="\_parent">
+	  <img alt="" src="https://img.shields.io/github/stars/TanStack/hotkeys.svg?style=social&label=Star" alt="GitHub stars" />
+	</a>
+	<a href="https://bundlephobia.com/result?p=@tanstack/react-hotkeys@latest" target="\_parent">
+	  <img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-hotkeys@latest" alt="Bundle size" />
+	</a>
+</div>
+
+<div align="center">
+	<a href="#badge">
+	  <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
+	</a>
+	<a href="#badge">
+	  <img src="https://img.shields.io/github/v/release/tanstack/hotkeys" alt="Release"/>
+	</a>
+	<a href="https://twitter.com/tan_stack">
+	  <img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @TanStack"/>
+	</a>
+</div>
+
+<div align="center">
+
+### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
+
+</div>
+
+# TanStack Hotkeys
+
+> [!NOTE]
+> TanStack Hotkeys is alpha. We are actively developing the library and are open to feedback and contributions.
+
+Type-safe keyboard shortcuts for the web. Template-string bindings, parsed objects, a cross-platform `Mod` key, a singleton Hotkey Manager, and utilities for cheatsheet UIs—built to stay SSR-friendly.
+
+- Type-safe bindings — template strings (`Mod+Shift+S`, `Escape`) or parsed objects for full control
+- Flexible options — `keydown`/`keyup`, `preventDefault`, `stopPropagation`, conditional enabled, `requireReset`
+- Cross-platform Mod — maps to Cmd on macOS and Ctrl on Windows/Linux
+- Batteries included — validation + matching, sequences (Vim-style), key-state tracking, recorder UI helpers, framework adapters, and devtools
+
+### <a href="https://tanstack.com/hotkeys">Read the docs →</a>
+
+<br />
+
+> [!NOTE]
+> You may know **TanStack Hotkeys** by our adapter names, too!
+>
+> - [**Alpine Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/alpine/quick-start)
+> - [**Ember Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/ember/quick-start)
+> - [**Octane Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/octane/quick-start)
+> - [**React Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/react/react-hotkeys)
+> - [**Preact Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/preact/preact-hotkeys)
+> - [**Solid Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/solid/reference)
+> - [**Angular Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/angular/reference)
+> - [**Vue Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/vue/reference)
+> - [**Lit Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/lit/reference)
+> - [**Svelte Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/svelte/reference)
+
+## Get Involved
+
+- We welcome issues and pull requests!
+- Participate in [GitHub discussions](https://github.com/TanStack/hotkeys/discussions)
+- Chat with the community on [Discord](https://discord.com/invite/WrRKjPJ)
+- See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions
+
+## Partners
+
+<div align="center">
+
+<table align="center">
+  <tr>
+    <td>
+      <a href="https://www.coderabbit.ai/?via=tanstack&dub_id=aCcEEdAOqqutX6OS" >
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/coderabbit-dark-D643Zkrv.svg" height="40" />
+          <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/coderabbit-light-CIzGLYU_.svg" height="40" />
+          <img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" alt="CodeRabbit" />
+        </picture>
+      </a>
+    </td>
+    <td>
+      <a href="https://www.cloudflare.com?utm_source=tanstack">
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/cloudflare-white-Co-Tyjbl.svg" height="60" />
+          <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/cloudflare-black-6Ojsn8yh.svg" height="60" />
+          <img src="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" alt="Cloudflare" />
+        </picture>
+      </a>
+    </td>
+  </tr>
+</table>
+
+<div align="center">
+<img src="media/partner_logo.svg" alt="Keys & you?" height="65">
+<p>
+We're looking for TanStack Hotkeys Partners to join our mission! Partner with us to push the boundaries of TanStack Hotkeys and build amazing things together.
+</p>
+<a href="mailto:partners@tanstack.com?subject=TanStack Hotkeys Partnership"><b>LET'S CHAT</b></a>
+</div>
+
+</div>
+
+## Explore the TanStack Ecosystem
+
+- <a href="https://github.com/tanstack/config"><b>TanStack Config</b></a> – Tooling for JS/TS packages
+- <a href="https://github.com/tanstack/db"><b>TanStack DB</b></a> – Reactive sync client store
+- <a href="https://github.com/tanstack/devtools"><b>TanStack DevTools</b></a> – Unified devtools panel
+- <a href="https://github.com/tanstack/form"><b>TanStack Form</b></a> – Type‑safe form state
+- <a href="https://github.com/tanstack/hotkeys"><b>TanStack Hotkeys</b></a> – Type‑safe keyboard shortcuts
+- <a href="https://github.com/tanstack/query"><b>TanStack Query</b></a> – Async state & caching
+- <a href="https://github.com/tanstack/ranger"><b>TanStack Ranger</b></a> – Range & slider primitives
+- <a href="https://github.com/tanstack/router"><b>TanStack Router</b></a> – Type‑safe routing, caching & URL state
+- <a href="https://github.com/tanstack/start"><b>TanStack Start</b></a> – Full‑stack SSR & streaming
+- <a href="https://github.com/tanstack/store"><b>TanStack Store</b></a> – Reactive data store
+- <a href="https://github.com/tanstack/table"><b>TanStack Table</b></a> – Headless datagrids
+- <a href="https://github.com/tanstack/virtual"><b>TanStack Virtual</b></a> – Virtualized rendering
+
+… and more at <a href="https://tanstack.com"><b>TanStack.com »</b></a>

package/dist/HotkeysProvider.d.ts

@@ -0,0 +1,25 @@
+import { HotkeyOptions, HotkeyRecorderOptions, HotkeySequenceRecorderOptions, SequenceOptions } from "@tanstack/hotkeys";
+//#region src/HotkeysProvider.d.ts
+export interface DefaultHotkeysOptions {
+  hotkey?: HotkeyOptions;
+  hotkeySequence?: SequenceOptions;
+  hotkeyRecorder?: Partial<HotkeyRecorderOptions>;
+  hotkeySequenceRecorder?: Partial<HotkeySequenceRecorderOptions>;
+}
+export type HotkeysProviderOptions = DefaultHotkeysOptions;
+export interface HotkeysProviderProps {
+  children?: unknown;
+  defaultOptions?: HotkeysProviderOptions;
+}
+/** Reads the nearest provider, or null outside a provider. */
+export declare function useHotkeysContext(): {
+  defaultOptions: DefaultHotkeysOptions;
+} | null;
+/** Reads the nearest provider's defaults, or an empty object. */
+export declare function useDefaultHotkeysOptions(): DefaultHotkeysOptions;
+/** Sets registration and recorder defaults for descendant components. */
+export declare function HotkeysProvider({ children, defaultOptions }: HotkeysProviderProps): import("octane").ElementDescriptor<{
+  value: DefaultHotkeysOptions;
+  children: unknown;
+}>;
+//#endregion

package/dist/HotkeysProvider.js

@@ -0,0 +1,23 @@
+import { createContext, createElement, useContext } from "octane";
+
+//#region src/HotkeysProvider.ts
+const HotkeysContext = createContext(null);
+/** Reads the nearest provider, or null outside a provider. */
+function useHotkeysContext() {
+	const defaultOptions = useContext(HotkeysContext);
+	return defaultOptions === null ? null : { defaultOptions };
+}
+/** Reads the nearest provider's defaults, or an empty object. */
+function useDefaultHotkeysOptions() {
+	return useContext(HotkeysContext) ?? {};
+}
+/** Sets registration and recorder defaults for descendant components. */
+function HotkeysProvider({ children, defaultOptions = {} }) {
+	return createElement(HotkeysContext.Provider, {
+		value: defaultOptions,
+		children
+	});
+}
+
+//#endregion
+export { HotkeysProvider, useDefaultHotkeysOptions, useHotkeysContext };

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import { DefaultHotkeysOptions, HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, useDefaultHotkeysOptions, useHotkeysContext } from "./HotkeysProvider.js";
+import { useHotkeys } from "./useHotkeys.js";
+import { useHotkey } from "./useHotkey.js";
+import { useHotkeySequences } from "./useHotkeySequences.js";
+import { useHotkeySequence } from "./useHotkeySequence.js";
+import { useHeldKeys } from "./useHeldKeys.js";
+import { useHeldKeyCodes } from "./useHeldKeyCodes.js";
+import { useKeyHold } from "./useKeyHold.js";
+import { useHotkeyHint } from "./useHotkeyHint.js";
+import { HotkeyRegistrationsResult, OctaneHotkeyRecorder, OctaneHotkeySequenceRecorder } from "./types.js";
+import { useHotkeyRegistrations } from "./useHotkeyRegistrations.js";
+import { useHotkeyRecorder } from "./useHotkeyRecorder.js";
+import { useHotkeySequenceRecorder } from "./useHotkeySequenceRecorder.js";
+import { HotkeyDefinition, HotkeySequenceDefinition } from "@tanstack/hotkeys/adapter";
+export * from "@tanstack/hotkeys";
+export { type DefaultHotkeysOptions, type HotkeyDefinition, HotkeyRegistrationsResult, type HotkeySequenceDefinition, HotkeysProvider, type HotkeysProviderOptions, type HotkeysProviderProps, OctaneHotkeyRecorder, OctaneHotkeySequenceRecorder, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, useHotkeySequence, useHotkeySequenceRecorder, useHotkeySequences, useHotkeys, useHotkeysContext, useKeyHold };

package/dist/index.js

@@ -0,0 +1,16 @@
+import { HotkeysProvider, useDefaultHotkeysOptions, useHotkeysContext } from "./HotkeysProvider.js";
+import { useHotkeys } from "./useHotkeys.js";
+import { useHotkey } from "./useHotkey.js";
+import { useHotkeySequences } from "./useHotkeySequences.js";
+import { useHotkeySequence } from "./useHotkeySequence.js";
+import { useHeldKeys } from "./useHeldKeys.js";
+import { useHeldKeyCodes } from "./useHeldKeyCodes.js";
+import { useKeyHold } from "./useKeyHold.js";
+import { useHotkeyHint } from "./useHotkeyHint.js";
+import { useHotkeyRegistrations } from "./useHotkeyRegistrations.js";
+import { useHotkeyRecorder } from "./useHotkeyRecorder.js";
+import { useHotkeySequenceRecorder } from "./useHotkeySequenceRecorder.js";
+
+export * from "@tanstack/hotkeys"
+
+export { HotkeysProvider, useDefaultHotkeysOptions, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, useHotkeySequence, useHotkeySequenceRecorder, useHotkeySequences, useHotkeys, useHotkeysContext, useKeyHold };

package/dist/internal.js

@@ -0,0 +1,35 @@
+import { useSelector } from "@tanstack/octane-store";
+
+//#region src/internal.ts
+const subSlotCache = /* @__PURE__ */ new Map();
+const bareTagCache = /* @__PURE__ */ new Map();
+function subSlot(slot, tag) {
+	if (slot === void 0) {
+		let bare = bareTagCache.get(tag);
+		if (bare === void 0) {
+			bare = Symbol.for(`@tanstack/octane-hotkeys:${tag}`);
+			bareTagCache.set(tag, bare);
+		}
+		return bare;
+	}
+	let byTag = subSlotCache.get(slot);
+	if (byTag === void 0) {
+		byTag = /* @__PURE__ */ new Map();
+		subSlotCache.set(slot, byTag);
+	}
+	let child = byTag.get(tag);
+	if (child === void 0) {
+		child = Symbol.for(`${slot.description ?? ""}:${tag}`);
+		byTag.set(tag, child);
+	}
+	return child;
+}
+function splitSlot(args) {
+	const tail = args[args.length - 1];
+	const slot = typeof tail === "symbol" ? tail : void 0;
+	return [slot === void 0 ? args : args.slice(0, -1), slot];
+}
+const select = useSelector;
+
+//#endregion
+export { select, splitSlot, subSlot };

package/dist/types.d.ts

@@ -0,0 +1,38 @@
+import { Hotkey, HotkeyRegistrationView, HotkeySequence, SequenceRegistrationView } from "@tanstack/hotkeys";
+//#region src/types.d.ts
+/** Recording state and controls owned by the containing component. */
+export interface OctaneHotkeyRecorder {
+  /** Whether the recorder is listening for a shortcut. */
+  isRecording: boolean;
+  /** The last recorded binding, including brackets for physical codes. */
+  recordedHotkey: Hotkey | null;
+  /** Start a new recording session. */
+  startRecording: () => void;
+  /** Stop and clear recorder state without calling onRecord or onCancel. */
+  stopRecording: () => void;
+  /** Stop, clear recorder state, and call onCancel. */
+  cancelRecording: () => void;
+}
+/** Sequence recording state and controls. */
+export interface OctaneHotkeySequenceRecorder {
+  /** Whether the recorder is listening for chords. */
+  isRecording: boolean;
+  /** Chords captured in the current session. */
+  steps: HotkeySequence;
+  /** The last committed sequence. */
+  recordedSequence: HotkeySequence | null;
+  /** Start a new recording session. */
+  startRecording: () => void;
+  /** Stop without committing or calling onCancel. */
+  stopRecording: () => void;
+  /** Discard the current session and call onCancel. */
+  cancelRecording: () => void;
+  /** Commit the current steps. Does nothing when no steps are recorded. */
+  commitRecording: () => void;
+}
+/** Live registration views from the shared hotkey and sequence managers. */
+export interface HotkeyRegistrationsResult {
+  hotkeys: Array<HotkeyRegistrationView>;
+  sequences: Array<SequenceRegistrationView>;
+}
+//#endregion

package/dist/useHeldKeyCodes.d.ts

@@ -0,0 +1,4 @@
+//#region src/useHeldKeyCodes.d.ts
+/** Reads held physical key codes from the shared key tracker. */
+export declare function useHeldKeyCodes(): Record<string, string>;
+//#endregion

package/dist/useHeldKeyCodes.js

@@ -0,0 +1,10 @@
+import { select, subSlot } from "./internal.js";
+import { getKeyStateTracker } from "@tanstack/hotkeys";
+
+//#region src/useHeldKeyCodes.ts
+function useHeldKeyCodes(slot) {
+	return select(getKeyStateTracker().store, (state) => state.heldCodes, void 0, subSlot(slot, "held-codes"));
+}
+
+//#endregion
+export { useHeldKeyCodes };

package/dist/useHeldKeys.d.ts

@@ -0,0 +1,4 @@
+//#region src/useHeldKeys.d.ts
+/** Reads held logical keys from the shared key tracker. */
+export declare function useHeldKeys(): Array<string>;
+//#endregion

package/dist/useHeldKeys.js

@@ -0,0 +1,10 @@
+import { select, subSlot } from "./internal.js";
+import { getKeyStateTracker } from "@tanstack/hotkeys";
+
+//#region src/useHeldKeys.ts
+function useHeldKeys(slot) {
+	return select(getKeyStateTracker().store, (state) => state.heldKeys, void 0, subSlot(slot, "held-keys"));
+}
+
+//#endregion
+export { useHeldKeys };

package/dist/useHotkey.d.ts

@@ -0,0 +1,5 @@
+import { HotkeyCallback, HotkeyOptions, RegisterableHotkey } from "@tanstack/hotkeys";
+//#region src/useHotkey.d.ts
+/** Registers one shortcut. Callback and options are refreshed after every commit. */
+export declare function useHotkey(hotkey: RegisterableHotkey, callback: HotkeyCallback, options?: HotkeyOptions): void;
+//#endregion

package/dist/useHotkey.js

@@ -0,0 +1,14 @@
+import { splitSlot, subSlot } from "./internal.js";
+import { useHotkeys } from "./useHotkeys.js";
+
+//#region src/useHotkey.ts
+function useHotkey(hotkey, callback, ...rest) {
+	const [args, slot] = splitSlot(rest);
+	useHotkeys([{
+		hotkey,
+		callback
+	}], args[0], subSlot(slot, "hotkey"));
+}
+
+//#endregion
+export { useHotkey };

package/dist/useHotkeyHint.d.ts

@@ -0,0 +1,5 @@
+import { HeldModifierOptions, RegisterableHotkey } from "@tanstack/hotkeys";
+//#region src/useHotkeyHint.d.ts
+/** Reports whether held modifiers reveal a shortcut hint. */
+export declare function useHotkeyHint(hotkey: RegisterableHotkey, options?: HeldModifierOptions): boolean;
+//#endregion

package/dist/useHotkeyHint.js

@@ -0,0 +1,11 @@
+import { select, splitSlot, subSlot } from "./internal.js";
+import { getKeyStateTracker, matchesHeldModifiers } from "@tanstack/hotkeys";
+
+//#region src/useHotkeyHint.ts
+function useHotkeyHint(hotkey, ...rest) {
+	const [args, slot] = splitSlot(rest);
+	return select(getKeyStateTracker().store, (state) => matchesHeldModifiers(hotkey, state.heldKeys, args[0]), void 0, subSlot(slot, "hint"));
+}
+
+//#endregion
+export { useHotkeyHint };

package/dist/useHotkeyRecorder.d.ts

@@ -0,0 +1,6 @@
+import { OctaneHotkeyRecorder } from "./types.js";
+import { HotkeyRecorderOptions } from "@tanstack/hotkeys";
+//#region src/useHotkeyRecorder.d.ts
+/** Records a shortcut and destroys the recorder on unmount. */
+export declare function useHotkeyRecorder(options: HotkeyRecorderOptions): OctaneHotkeyRecorder;
+//#endregion

package/dist/useHotkeyRecorder.js

@@ -0,0 +1,28 @@
+import { useDefaultHotkeysOptions } from "./HotkeysProvider.js";
+import { select, subSlot } from "./internal.js";
+import { HotkeyRecorder } from "@tanstack/hotkeys";
+import { useLayoutEffect, useRef } from "octane";
+
+//#region src/useHotkeyRecorder.ts
+function useHotkeyRecorder(options, slot) {
+	const merged = {
+		...useDefaultHotkeysOptions().hotkeyRecorder,
+		...options
+	};
+	const ref = useRef(null, subSlot(slot, "recorder"));
+	ref.current ??= new HotkeyRecorder(merged);
+	const recorder = ref.current;
+	useLayoutEffect(() => {
+		recorder.setOptions(merged);
+	}, null, subSlot(slot, "options"));
+	useLayoutEffect(() => () => recorder.destroy(), [], subSlot(slot, "cleanup"));
+	return {
+		...select(recorder.store, (value) => value, void 0, subSlot(slot, "state")),
+		startRecording: () => recorder.start(),
+		stopRecording: () => recorder.stop(),
+		cancelRecording: () => recorder.cancel()
+	};
+}
+
+//#endregion
+export { useHotkeyRecorder };

package/dist/useHotkeyRegistrations.d.ts

@@ -0,0 +1,5 @@
+import { HotkeyRegistrationsResult } from "./types.js";
+//#region src/useHotkeyRegistrations.d.ts
+/** Reads public registration snapshots from both managers. */
+export declare function useHotkeyRegistrations(): HotkeyRegistrationsResult;
+//#endregion

package/dist/useHotkeyRegistrations.js

@@ -0,0 +1,13 @@
+import { select, subSlot } from "./internal.js";
+import { getHotkeyManager, getSequenceManager, toHotkeyRegistrationView } from "@tanstack/hotkeys";
+
+//#region src/useHotkeyRegistrations.ts
+function useHotkeyRegistrations(slot) {
+	return {
+		hotkeys: select(getHotkeyManager().registrations, (state) => Array.from(state.values()).map(toHotkeyRegistrationView), void 0, subSlot(slot, "hotkeys")),
+		sequences: select(getSequenceManager().registrations, (state) => Array.from(state.values()), void 0, subSlot(slot, "sequences"))
+	};
+}
+
+//#endregion
+export { useHotkeyRegistrations };

package/dist/useHotkeySequence.d.ts

@@ -0,0 +1,5 @@
+import { HotkeyCallback, HotkeySequence, SequenceOptions } from "@tanstack/hotkeys";
+//#region src/useHotkeySequence.d.ts
+/** Registers one multi-chord shortcut. Empty sequences do not register. */
+export declare function useHotkeySequence(sequence: HotkeySequence, callback: HotkeyCallback, options?: SequenceOptions): void;
+//#endregion

package/dist/useHotkeySequence.js

@@ -0,0 +1,14 @@
+import { splitSlot, subSlot } from "./internal.js";
+import { useHotkeySequences } from "./useHotkeySequences.js";
+
+//#region src/useHotkeySequence.ts
+function useHotkeySequence(sequence, callback, ...rest) {
+	const [args, slot] = splitSlot(rest);
+	useHotkeySequences([{
+		sequence,
+		callback
+	}], args[0], subSlot(slot, "sequence"));
+}
+
+//#endregion
+export { useHotkeySequence };

package/dist/useHotkeySequenceRecorder.d.ts

@@ -0,0 +1,6 @@
+import { OctaneHotkeySequenceRecorder } from "./types.js";
+import { HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
+//#region src/useHotkeySequenceRecorder.d.ts
+/** Records a sequence, including live steps and explicit commit/cancel controls. */
+export declare function useHotkeySequenceRecorder(options: HotkeySequenceRecorderOptions): OctaneHotkeySequenceRecorder;
+//#endregion

package/dist/useHotkeySequenceRecorder.js

@@ -0,0 +1,29 @@
+import { useDefaultHotkeysOptions } from "./HotkeysProvider.js";
+import { select, subSlot } from "./internal.js";
+import { HotkeySequenceRecorder } from "@tanstack/hotkeys";
+import { useLayoutEffect, useRef } from "octane";
+
+//#region src/useHotkeySequenceRecorder.ts
+function useHotkeySequenceRecorder(options, slot) {
+	const merged = {
+		...useDefaultHotkeysOptions().hotkeySequenceRecorder,
+		...options
+	};
+	const ref = useRef(null, subSlot(slot, "recorder"));
+	ref.current ??= new HotkeySequenceRecorder(merged);
+	const recorder = ref.current;
+	useLayoutEffect(() => {
+		recorder.setOptions(merged);
+	}, null, subSlot(slot, "options"));
+	useLayoutEffect(() => () => recorder.destroy(), [], subSlot(slot, "cleanup"));
+	return {
+		...select(recorder.store, (value) => value, void 0, subSlot(slot, "state")),
+		startRecording: () => recorder.start(),
+		stopRecording: () => recorder.stop(),
+		cancelRecording: () => recorder.cancel(),
+		commitRecording: () => recorder.commit()
+	};
+}
+
+//#endregion
+export { useHotkeySequenceRecorder };

package/dist/useHotkeySequences.d.ts

@@ -0,0 +1,6 @@
+import { SequenceOptions } from "@tanstack/hotkeys";
+import { HotkeySequenceDefinition } from "@tanstack/hotkeys/adapter";
+//#region src/useHotkeySequences.d.ts
+/** Registers a changing list of sequences and releases it on unmount. */
+export declare function useHotkeySequences(definitions: Array<HotkeySequenceDefinition>, options?: SequenceOptions): void;
+//#endregion

package/dist/useHotkeySequences.js

@@ -0,0 +1,23 @@
+import { useDefaultHotkeysOptions } from "./HotkeysProvider.js";
+import { splitSlot, subSlot } from "./internal.js";
+import { useLayoutEffect, useRef } from "octane";
+import { createHotkeySequenceBindings } from "@tanstack/hotkeys/adapter";
+
+//#region src/useHotkeySequences.ts
+function useHotkeySequences(definitions, ...rest) {
+	const [args, slot] = splitSlot(rest);
+	const options = {
+		...useDefaultHotkeysOptions().hotkeySequence,
+		...args[0]
+	};
+	const ref = useRef(null, subSlot(slot, "bindings"));
+	ref.current ??= createHotkeySequenceBindings();
+	const bindings = ref.current;
+	useLayoutEffect(() => {
+		bindings.update(definitions, options);
+	}, null, subSlot(slot, "update"));
+	useLayoutEffect(() => () => bindings.destroy(), [], subSlot(slot, "cleanup"));
+}
+
+//#endregion
+export { useHotkeySequences };

package/dist/useHotkeys.d.ts

@@ -0,0 +1,6 @@
+import { HotkeyOptions } from "@tanstack/hotkeys";
+import { HotkeyDefinition } from "@tanstack/hotkeys/adapter";
+//#region src/useHotkeys.d.ts
+/** Registers a changing list of shortcuts after commit and releases it on unmount. */
+export declare function useHotkeys(definitions: Array<HotkeyDefinition>, options?: HotkeyOptions): void;
+//#endregion

package/dist/useHotkeys.js

@@ -0,0 +1,23 @@
+import { useDefaultHotkeysOptions } from "./HotkeysProvider.js";
+import { splitSlot, subSlot } from "./internal.js";
+import { useLayoutEffect, useRef } from "octane";
+import { createHotkeyBindings } from "@tanstack/hotkeys/adapter";
+
+//#region src/useHotkeys.ts
+function useHotkeys(definitions, ...rest) {
+	const [args, slot] = splitSlot(rest);
+	const options = {
+		...useDefaultHotkeysOptions().hotkey,
+		...args[0]
+	};
+	const ref = useRef(null, subSlot(slot, "bindings"));
+	ref.current ??= createHotkeyBindings();
+	const bindings = ref.current;
+	useLayoutEffect(() => {
+		bindings.update(definitions, options);
+	}, null, subSlot(slot, "update"));
+	useLayoutEffect(() => () => bindings.destroy(), [], subSlot(slot, "cleanup"));
+}
+
+//#endregion
+export { useHotkeys };

package/dist/useKeyHold.d.ts

@@ -0,0 +1,5 @@
+import { IndividualKey } from "@tanstack/hotkeys";
+//#region src/useKeyHold.d.ts
+/** Reports whether a logical key is held. */
+export declare function useKeyHold(key: IndividualKey): boolean;
+//#endregion

package/dist/useKeyHold.js

@@ -0,0 +1,10 @@
+import { select, subSlot } from "./internal.js";
+import { getKeyStateTracker } from "@tanstack/hotkeys";
+
+//#region src/useKeyHold.ts
+function useKeyHold(key, slot) {
+	return select(getKeyStateTracker().store, (state) => state.heldKeys.includes(key), void 0, subSlot(slot, "key-hold"));
+}
+
+//#endregion
+export { useKeyHold };

package/package.json

@@ -1,6 +1,65 @@
 {
   "name": "@tanstack/octane-hotkeys",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.0",
+  "description": "Octane adapter for TanStack Hotkeys",
+  "author": "Tanner Linsley",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TanStack/hotkeys.git",
+    "directory": "packages/octane-hotkeys"
+  },
+  "homepage": "https://tanstack.com/hotkeys",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/tannerlinsley"
+  },
+  "keywords": [
+    "octane",
+    "tanstack",
+    "hotkeys"
+  ],
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22.22.2"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@tanstack/hotkeys": "0.11.0",
+    "@tanstack/octane-store": "^0.12.3"
+  },
+  "devDependencies": {
+    "@tsrx/typescript-plugin": "^0.3.138",
+    "octane": "0.1.36",
+    "vite": "^8.3.2"
+  },
+  "peerDependencies": {
+    "octane": ">=0.1.36 <0.2.0"
+  },
+  "octane": {
+    "hookSlots": {
+      "manual": [
+        "dist"
+      ]
+    }
+  },
+  "scripts": {
+    "clean": "premove ./build ./dist",
+    "lint": "eslint ./src",
+    "lint:fix": "eslint ./src --fix",
+    "test:eslint": "eslint ./src",
+    "test:lib": "vitest run && vitest run --config vitest.ssr.config.ts",
+    "test:lib:dev": "vitest --watch",
+    "test:types": "tsrx-tsc --noEmit",
+    "build": "tsdown",
+    "test:build": "publint --strict && node ../../scripts/verify-package.ts"
+  }
 }