@opentui/keymap 0.0.0-20260423-76a94f40

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 opentui
+
+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

@@ -0,0 +1,54 @@
+# @opentui/keymap
+
+Keymap package for OpenTUI and browser-based UIs.
+
+It provides a shared keymap core, adapter-specific entrypoints for HTML and OpenTUI, and framework providers/hooks for React and Solid.
+
+The core `Keymap` is intentionally bare. Create a keymap, install the addons you want, then pass that configured instance to your app.
+
+Use the HTML entrypoint for DOM-based hosts and the OpenTUI entrypoint for terminal renderers. The React and Solid entrypoints consume a pre-created OpenTUI keymap through context.
+
+Entry points:
+
+- `@opentui/keymap`: core keymap API
+- `@opentui/keymap/addons`: universal addons
+- `@opentui/keymap/addons/opentui`: universal addons plus OpenTUI-specific addons
+- `@opentui/keymap/html`: core API plus the HTML adapter
+- `@opentui/keymap/opentui`: core API plus the OpenTUI adapter
+- `@opentui/keymap/react`: React provider and hooks for a pre-created OpenTUI keymap
+- `@opentui/keymap/solid`: Solid provider and hooks for a pre-created OpenTUI keymap
+
+## Usage
+
+```tsx
+import { registerDefaultKeys } from "@opentui/keymap/addons"
+import { createOpenTuiKeymap } from "@opentui/keymap/opentui"
+import { KeymapProvider } from "@opentui/keymap/react"
+
+const keymap = createOpenTuiKeymap(renderer)
+registerDefaultKeys(keymap)
+
+createRoot(renderer).render(
+  <KeymapProvider keymap={keymap}>
+    <App />
+  </KeymapProvider>,
+)
+```
+
+## Installation
+
+```bash
+bun install @opentui/keymap
+```
+
+## Development
+
+```bash
+bun run build
+bun run test
+bun src/keymap-benchmark.ts
+bun run serve:keymap-html
+```
+
+- `bun src/keymap-benchmark.ts` runs the benchmark suite from `src/keymap-benchmark.ts`.
+- `bun run serve:keymap-html` builds the package and serves the HTML demo locally.