chore: rename project and packages to tanstack hotkeys

Author: KevinVandy

.changeset/conflict-detection.md

@@ -1,5 +1,5 @@
 ---
-'@tanstack/keys': minor
+'@tanstack/hotkeys': minor
 ---
 
 Add hotkey conflict detection with configurable behavior

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -6,24 +6,24 @@ body:
       value: |
         Thank you for reporting an issue :pray:.
 
-        This issue tracker is for reporting reproducible bugs or regression's found in [keys](https://github.com/tanstack/keys)
+        This issue tracker is for reporting reproducible bugs or regression's found in [keys](https://github.com/tanstack/hotkeys)
         If you have a question about how to achieve or implement something and are struggling, please post a question
-        inside of keys's [Discussions tab](https://github.com/tanstack/keys/discussions) instead of filing an issue.
+        inside of keys's [Discussions tab](https://github.com/tanstack/hotkeys/discussions) instead of filing an issue.
 
         Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
-        - TanStack Keys's [Discussions tab](https://github.com/tanstack/keys/discussions)
-        - TanStack Keys's [Open Issues](https://github.com/tanstack/keys/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
-        - TanStack Keys's [Closed Issues](https://github.com/tanstack/keys/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed)
+        - TanStack Hotkeys's [Discussions tab](https://github.com/tanstack/hotkeys/discussions)
+        - TanStack Hotkeys's [Open Issues](https://github.com/tanstack/hotkeys/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
+        - TanStack Hotkeys's [Closed Issues](https://github.com/tanstack/hotkeys/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed)
 
         The more information you fill in, the better the community can help you.
 
   - type: input
-    id: tanstack-keys-version
+    id: tanstack-hotkeys-version
     attributes:
-      label: TanStack Keys version
+      label: TanStack Hotkeys version
       description: |
-        - Please let us know the exact version of the TanStack Keys framework adapter that you were using when the issue occurred. If you are using an older version, check to see if your bug has already been solved in the latest version. Please don't just put in "latest", as this is subject to change.
-        - The latest "keys" version is <img alt="" src="https://badgen.net/npm/v/@tanstack/react-keys" />
+        - Please let us know the exact version of the TanStack Hotkeys framework adapter that you were using when the issue occurred. If you are using an older version, check to see if your bug has already been solved in the latest version. Please don't just put in "latest", as this is subject to change.
+        - The latest "keys" version is <img alt="" src="https://badgen.net/npm/v/@tanstack/react-hotkeys" />
       placeholder: |
         e.g. v0.0.1
     validations:
@@ -57,7 +57,7 @@ body:
           - Your bug may get fixed much faster if we can run your code and it doesn't have dependencies other than React.
           - To create a shareable code example for web, you can use CodeSandbox (https://codesandbox.io/s/new) or Stackblitz (https://stackblitz.com/).
           - Please make sure the example is complete and runnable without prior dependencies and free of unnecessary abstractions
-          - Feel free to fork any of the official CodeSandbox examples to reproduce your issue: https://github.com/tanstack/keys/tree/main/examples/
+          - Feel free to fork any of the official CodeSandbox examples to reproduce your issue: https://github.com/tanstack/hotkeys/tree/main/examples/
           - For React Native, you can use: https://snack.expo.dev/
           - For TypeScript related issues only, a TypeScript Playground link might be sufficient: https://www.typescriptlang.org/play
           - Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.

.github/workflows/pr.yml

@@ -47,4 +47,4 @@ jobs:
       - name: Build Packages
         run: pnpm run build:all
       - name: Publish Previews
-        run: pnpx pkg-pr-new publish --pnpm './packages/*' --keys './examples/*/*'
+        run: pnpx pkg-pr-new publish --pnpm './packages/*' --hotkeys './examples/*/*'

CONTRIBUTING.md

@@ -7,11 +7,11 @@ id: contributing
 
 ## Questions
 
-If you have questions about implementation details, help or support, then please use our dedicated community forum at [Github Discussions](https://github.com/tanstack/keys/discussions) **PLEASE NOTE:** If you choose to instead open an issue for your question, your issue will be immediately closed and redirected to the forum.
+If you have questions about implementation details, help or support, then please use our dedicated community forum at [Github Discussions](https://github.com/tanstack/hotkeys/discussions) **PLEASE NOTE:** If you choose to instead open an issue for your question, your issue will be immediately closed and redirected to the forum.
 
 ## Reporting Issues
 
-If you have found what you think is a bug, please [file an issue](https://github.com/tanstack/keys/issues/new). **PLEASE NOTE:** Issues that are identified as implementation questions or non-issues will be immediately closed and redirected to [Github Discussions](https://github.com/tanstack/keys/discussions)
+If you have found what you think is a bug, please [file an issue](https://github.com/tanstack/hotkeys/issues/new). **PLEASE NOTE:** Issues that are identified as implementation questions or non-issues will be immediately closed and redirected to [Github Discussions](https://github.com/tanstack/hotkeys/discussions)
 
 ## Suggesting new features
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Tanner Linsley
+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

README.md

@@ -5,14 +5,14 @@
 <br />
 
 <div align="center">
-	<a href="https://www.npmjs.com/package/@tanstack/keys" target="\_parent">
-	  <img alt="" src="https://img.shields.io/npm/dm/@tanstack/keys.svg" alt="npm downloads" />
+	<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/keys" target="\_parent">
-	  <img alt="" src="https://img.shields.io/github/stars/TanStack/keys.svg?style=social&label=Star" alt="GitHub stars" />
+	<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-keys@latest" target="\_parent">
-	  <img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-keys@latest" alt="Bundle size" />
+	<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>
 
@@ -21,7 +21,7 @@
 	  <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/keys" alt="Release"/>
+	  <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"/>
@@ -34,12 +34,12 @@
 
 </div>
 
-# TanStack Keys
+# TanStack Hotkeys
 
 Type-safe keyboard shortcuts for the web. Template strings, parsed objects, cross-platform `Mod`, a singleton Hotkey Manager, and utilities for cheatsheet UIs. Built to stay SSR-friendly.
 
 > [!NOTE]
-> TanStack Keys is pre-alpha (prototyping phase). We are actively developing the library and are open to feedback and contributions.
+> TanStack Hotkeys is pre-alpha (prototyping phase). We are actively developing the library and are open to feedback and contributions.
 
 ## Features
 
@@ -78,30 +78,30 @@ Type-safe keyboard shortcuts for the web. Template strings, parsed objects, cros
   - `useHotkeyRecorder` – record keyboard shortcuts interactively with live preview
 - **Devtools**
   - Devtools are a core focus: visibility into all registered hotkeys, scopes, and options
-  - `@tanstack/keys-devtools` and `@tanstack/react-keys-devtools` (in active development)
+  - `@tanstack/hotkeys-devtools` and `@tanstack/react-hotkeys-devtools` (in active development)
 - **Planned**
   - Scoping hotkeys to a DOM element or React ref
   - Warn/error on conflicting shortcuts (TBD)
   - Ignore hotkeys when certain inputs are focused (e.g. `input`, `textarea`)
   - Focus traps and tab-order utilities
 
-### <a href="https://tanstack.com/keys">Read the docs →</a>
+### <a href="https://tanstack.com/hotkeys">Read the docs →</a>
 
 <br />
 
 > [!NOTE]
-> You may know **TanStack Keys** by our adapter names, too!
+> You may know **TanStack Hotkeys** by our adapter names, too!
 >
-> - [**React Keys**](https://tanstack.com/keys/latest/docs/framework/react/react-keys)
-> - Solid Keys – needs a contributor!
-> - Angular Keys – needs a contributor!
-> - Svelte Keys – needs a contributor!
-> - Vue Keys – needs a contributor!
+> - [**React Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/react/react-hotkeys)
+> - Solid Hotkeys – needs a contributor!
+> - Angular Hotkeys – needs a contributor!
+> - Svelte Hotkeys – needs a contributor!
+> - Vue Hotkeys – needs a contributor!
 
 ## Quick Example
 
 ```tsx
-import { useHotkey, formatForDisplay } from '@tanstack/react-keys'
+import { useHotkey, formatForDisplay } from '@tanstack/react-hotkeys'
 
 function Editor() {
   useHotkey(
@@ -124,15 +124,15 @@ function Editor() {
 
 ## Packages
 
-- **`@tanstack/keys`** – Core: parse, format, match, validate, manager, sequence, key-state
-- **`@tanstack/react-keys`** – React: `useHotkey`, `useHotkeySequence`, `useHeldKeys`, `useKeyHold`, `useHotkeyRecorder`
-- **`@tanstack/keys-devtools`** – Base devtools (in development)
-- **`@tanstack/react-keys-devtools`** – React devtools (in development)
+- **`@tanstack/hotkeys`** – Core: parse, format, match, validate, manager, sequence, key-state
+- **`@tanstack/react-hotkeys`** – React: `useHotkey`, `useHotkeySequence`, `useHeldKeys`, `useKeyHold`, `useHotkeyRecorder`
+- **`@tanstack/hotkeys-devtools`** – Base devtools (in development)
+- **`@tanstack/react-hotkeys-devtools`** – React devtools (in development)
 
 ## Get Involved
 
 - We welcome issues and pull requests!
-- Participate in [GitHub discussions](https://github.com/TanStack/keys/discussions)
+- 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
 
@@ -164,9 +164,9 @@ function Editor() {
 <div align="center">
 <img src="https://tanstack.com/assets/partner_logo.svg" alt="Keys & you?" height="65">
 <p>
-We're looking for TanStack Keys Partners to join our mission! Partner with us to push the boundaries of TanStack Keys and build amazing things together.
+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 Keys Partnership"><b>LET'S CHAT</b></a>
+<a href="mailto:partners@tanstack.com?subject=TanStack Hotkeys Partnership"><b>LET'S CHAT</b></a>
 </div>
 
 </div>
@@ -177,7 +177,7 @@ We're looking for TanStack Keys Partners to join our mission! Partner with us to
 - <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/keys"><b>TanStack Keys</b></a> – Type‑safe keyboard shortcuts
+- <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

docs/config.json

@@ -3,7 +3,7 @@
   "docSearch": {
     "appId": "",
     "apiKey": "",
-    "indexName": "tanstack-keys"
+    "indexName": "tanstack-hotkeys"
   },
   "sections": [
     {

docs/framework/react/adapter.md

@@ -7,7 +7,7 @@ The React adapter provides hooks for using Keys in React applications.
 The `useTemplate` hook connects a Keys instance to React's reactivity system.
 
 ```tsx
-import { useTemplate } from '@tanstack/react-keys'
+import { useTemplate } from '@tanstack/react-hotkeys'
 
 function MyComponent() {
   const keys = React.useMemo(() => createTemplate(), [])

docs/framework/react/reference/functions/useHeldKeyCodes.md

@@ -9,7 +9,7 @@ title: useHeldKeyCodes
 function useHeldKeyCodes(): Record<string, string>;
 ```
 
-Defined in: [useHeldKeyCodes.ts:30](https://github.com/TanStack/keys/blob/main/packages/react-keys/src/useHeldKeyCodes.ts#L30)
+Defined in: [useHeldKeyCodes.ts:30](https://github.com/TanStack/keys/blob/main/packages/react-hotkeys/src/useHeldKeyCodes.ts#L30)
 
 React hook that returns a map of currently held key names to their physical `event.code` values.
 

docs/framework/react/reference/functions/useHeldKeys.md

@@ -9,7 +9,7 @@ title: useHeldKeys
 function useHeldKeys(): string[];
 ```
 
-Defined in: [useHeldKeys.ts:26](https://github.com/TanStack/keys/blob/main/packages/react-keys/src/useHeldKeys.ts#L26)
+Defined in: [useHeldKeys.ts:26](https://github.com/TanStack/keys/blob/main/packages/react-hotkeys/src/useHeldKeys.ts#L26)
 
 React hook that returns an array of currently held keyboard keys.