keystra 0.0.0-stage → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+This project follows [Semantic Versioning](https://semver.org/).
+
+## [0.1.1] — 2026-11-02
+
+- Shorter README, with a demo GIF and full guides in `docs/`.
+
+## [0.1.0] — 2026-11-02
+
+First release.
+
+- `createKeystra()` engine: key normalization and matching, modifier chords,
+  multi-key sequences, custom key maps and event delegation.
+- Navigation modes: sequential, vertical, horizontal, grid, directional and
+  custom strategies, with looping and disabled and hidden item skipping.
+- Focus management: roving tabindex, `aria-activedescendant`, focus restoration
+  and nested groups.
+- Selection: single, multiple and range modes, independent of styling.
+- Patterns: `createTabs`, `createMenu`, `createDropdown`, `createList`,
+  `createGrid`, `createTree`, `createCommandPalette` and `createRovingFocus`.
+- `createKeyBinding()` for document-level shortcuts, and `useKeystra()` for
+  elements that do not exist yet.
+- Dynamic DOM support through `refresh()`, explicit registration and optional
+  mutation observation.
+- ESM, CommonJS and script-tag builds, TypeScript declarations and deep imports
+  such as `keystra/patterns`. No runtime dependencies.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Zahid Hasan
+
+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,79 @@
-# Temporary Holding Version
+# Keystra
 
-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.
+Keyboard navigation, focus and selection for any DOM UI.
+
+- Works with vanilla JS, TypeScript and any DOM-based framework.
+- Arrow keys, Home/End, typeahead, shortcuts and key sequences.
+- Roving tabindex, focus restore, and single, multiple or range selection.
+- Ready-made tabs, menus, dropdowns, lists, grids, trees and command palettes.
+- Skips disabled and hidden items, and keeps up with DOM changes.
+- No dependencies, and no UI or styling of its own.
+
+![Keystra demo: tabs, a dropdown, a list, a grid, a tree and a command palette, all driven from the keyboard](https://raw.githubusercontent.com/zahidhasann88/keystra/main/docs/demo.gif)
+
+## Install
+
+```bash
+npm i keystra
+```
+
+## Quick start
+
+```html
+<div id="actions" aria-label="Actions">
+  <button data-keystra-item>Copy</button>
+  <button data-keystra-item>Move</button>
+  <button data-keystra-item disabled>Delete</button>
+</div>
+```
+
+```ts
+import { createKeystra } from 'keystra';
+
+const nav = createKeystra({
+  container: '#actions',
+  loop: true,
+  onSelect: (element) => console.log('activate', element),
+});
+
+nav.focusFirst();
+
+// When the UI is removed:
+nav.destroy();
+```
+
+Arrow keys now move through the buttons and skip the disabled one, Tab leaves the group in one stop, and Enter calls `onSelect`.
+
+## Patterns
+
+```ts
+import { createTabs } from 'keystra';
+
+const tabs = createTabs({
+  container: '#tabs',
+  items: '[role="tab"]',
+  panels: '[role="tabpanel"]',
+});
+```
+
+Also available: `createMenu`, `createDropdown`, `createList`, `createGrid`, `createTree`, `createCommandPalette` and `createRovingFocus`. See [Patterns](docs/patterns.md).
+
+## Shortcuts
+
+```ts
+import { createKeyBinding } from 'keystra';
+
+const palette = createKeyBinding('Ctrl+K', () => openPalette());
+```
+
+## Docs
+
+- [API](docs/api.md): options, methods, keys, selection and lifecycle.
+- [Patterns](docs/patterns.md): each ready-made widget.
+- [Frameworks](docs/frameworks.md): React, Vue, Svelte and Angular.
+- [Accessibility](docs/accessibility.md): what Keystra does and what stays yours, plus browser support.
+- [Performance](docs/performance.md): bundle size and large lists.
+
+## License
+
+MIT