Skip to content

v0.3.0

Choose a tag to compare

@github-actions github-actions released this 29 Dec 04:47
· 223 commits to main since this release

First NPM Release 🎉

use-kbd is now available on NPM! This release includes the full keyboard shortcuts library with:

Features

  • Drop-in UI components: ShortcutsModal, Omnibar, SequenceModal
  • Dynamic action registration: useAction hook for colocated handler + binding definitions
  • Multi-key sequences: Vim-style g g sequences with visual feedback
  • User customization: Editable bindings persisted to localStorage
  • CSS theming: --kbd-* custom properties for easy styling

Highlights since v0.2.1

  • Rebranded from internal naming to use-kbd
  • Default storageKey is now 'use-kbd' (no config needed for basic usage)
  • Custom group layouts via groupRenderers prop and TwoColumnRenderer factory
  • Improved editing UX: better Tab navigation, conflict detection, pending key commits
  • SequenceModal component for visualizing multi-key sequence progress
  • CSS class rename: .hotkeys-*.kbd-*

Installation

pnpm add use-kbd
# or
npm install use-kbd

Example Integration

See awair's use-kbd-demo branch for a real-world integration example.

Full Changelog: v0.2.1...v0.3.0