kbar

Lil' release to get up to date on recent additions.

Enhancements

• Add section name by default to command keywords (#144)
• Add customizable search placeholder (#152)

Bug fixes

• Add event callbacks for shortcuts (#150)

Bug fixes

• Fixed styles prop type for KBarPositioner #138
• Fixes an issue where toggling the command bar when focused within contenteditable caused event.defaultPrevented to not work as expected ESC #139

Bug fixes

• Fixes an issue where the default useKBar export did not work in Vite builds. #131 (@kevinhu)

Undo/Redo

Introducing the ability to easily add undo & redo functionality to actions!

• Create the undo (negate) action by returning a function from perform:

  createAction({
    perform: () => {
      // logic to perform
      return () => {
        // logic to undo
      }
    }
  })
  

• Perform actions using action.command.perform
• Explicitly undo actions using action.command.undo, redo using action.command.redo

Fixes

• Deprecated the usage of useDeepMatches in favor of just useMatches. #124
• Reworked a few internal types; e.g. BaseAction renamed to Action

Bug fixes

• Fixes an issue where mobile Safari/Firefox outer clicks were not firing. #123

Enhancements

• Support for screen readers added ✨ #111
• Support for external analytics added; onOpen, onClose, onQueryChange, onSelectAction #110

Bug fixes

• Enable users to opt out of implicit scrollbar management. #115

Misc

• All exports from /example now import from the global entry point. #116

Bug fixes

• Fixed an issue where spreading large lists of ActionImpls crashed kbar; rather, we should be looping through and pushing these objects to a new array instead of spreading.

Missing export, need to somehow test/enforce this when adding new modules.

New features

https://user-images.githubusercontent.com/12195101/140578203-3ca073a3-c534-40c4-8a5b-ad0ec5f68e4a.mp4

• Nested searching is here! Search n levels of actions deep at ease, and speed. #105
• Actions are internally reworked to support better testing and future extensibility. #96

Bug fixes

• Escape key now properly propagates events only when kbar is open. #108

Miscellaneous

• Tests are now set up 🥳

Bug fixes

• Fixed an issue where multiple key sequence shortcuts causes the trailing keys to appear in the input. #95
• Fixed an issue where the mouse cursor captures the active index when not moved yet. #98
• Fixes an edge case where if the first result item is a group name, hitting arrow up would cause the active index to be -1. #99

Enhancements

• We're back at our original API, with KBarResults by default virtualized. 100k results? No problem 💯

Bug fixes

• Fixed an issue with shortcuts registered with shift
• Removed UI jump when scrollbar comes in and out of view
• Removed active state wrapping

• Export useMatches

Bug fixes

• Clear search query on unmount

Enhancements

• useRegisterActions now accepts an optional dependencies array enabling users to invert control on the actions cache. https://github.com/timc1/kbar/commit/b10bd501c16fef2dc3eb94f0c635741ac9a40f6a
• Introducing a new API for results, enabling users to build any results UI with index management & keyboard handling covered. https://github.com/timc1/kbar/commit/6dc7b1227599e302aafa5fcf1ab2fb828329c146
• Added a new utility hook, useMatches, which returns grouped actions based on the current search query. https://github.com/timc1/kbar/commit/6dc7b1227599e302aafa5fcf1ab2fb828329c146
• Shortcuts can now open kbar at a specific currentRootActionId. https://github.com/timc1/kbar/commit/c53f585646ebfae68af6ac6e74e593b27068f62d

Bug fixes

• Suppress shortcuts in contenteditable elements https://github.com/timc1/kbar/commit/2f1de2bdd0564ee89268c7964f82ebadbd885936

Improvements

• Animations are added as part of the default kbar package. https://github.com/timc1/kbar/commit/775edf8d6b8398be8fe573bcf05d9b6d585a3f72
• Removed usage of JSON.stringify with a simple string comparison. https://github.com/timc1/kbar/commit/6ea7472f67f8faaca6cc6ad0db21a2bd7f6ec13d
• Enable suppressing kbar when event.preventDefault is called. https://github.com/timc1/kbar/commit/828bad6ac13a0bae69981c5296ddddcf8e5348c3

Bug fixes

• Fixed a bug where the shortcuts aren't bound when actions are registered after initial mount. https://github.com/timc1/kbar/commit/980780736c49b098fc29bbb0db74f4b743dcf030
• Fixed a bug where the search query was cleared after the initial animation. https://github.com/timc1/kbar/commit/775edf8d6b8398be8fe573bcf05d9b6d585a3f72

Thanks @tommoor for the contributions 💯

Improvements

• External clicking to a nested action will now set focus back on the input
• icon and subtitle are now part of the Action type – please see the example for usage.

Bug fixes

• Fixed an issue calling perform on a nonexistent action

Improvements

• Some users had issues running kbar with our lib targeted at esnext. Now, kbar is a little more conservative, targeting es5.

Improvements

We've reworked and improved the API to support all types of styling; classNames, inline styles, css-in-js. A few components have been moved around – please reference the updated Readme and documentation for usage.

• Initial docs are now available – hit cmd/ctrl+k and search docs 📚
• Keyboard shortcuts can be use immediately after one another without a delay; e.g. pressing h navigates to the home page, and immediately pressing g+d navigates to the docs.
• A tiny bump animation is added when navigating between nested actions.