Repolode
timc1

timc1/kbar

一个 React 命令面板(Cmd+K)组件,可为网站添加带快捷键的可搜索操作菜单。

Star
5,261
Fork
204
未关闭 Issue
0
最近提交
3个月前

这是什么?

kbar 是一个 React 组件库,用于为网站或 Web 应用添加 Cmd+K 风格的命令面板。用户按下快捷键即可打开搜索框,直接执行原本需要逐层点击才能完成的操作。

开发者用普通对象定义操作,包括 id、名称、关键词、可选的键盘快捷键和执行函数。使用 KBarProvider 包裹应用后,即可通过内置的 Portal、Positioner、Animator、搜索输入框和结果列表等组件快速搭建界面。useMatches 钩子会根据当前输入返回过滤后的结果,结果列表支持虚拟化渲染,适合操作数量较多的场景。

此外,它支持嵌套操作以实现多级导航,可通过操作历史实现撤销与重做,并内置屏幕阅读器支持。开发者也可以基于底层数据结构自定义或替换组件。

核心功能

  • 01可为单个操作注册键盘快捷键。
  • 02支持嵌套操作,实现多级导航。
  • 03结果列表虚拟化渲染,适合大量操作。
  • 04通过操作历史支持撤销与重做。
  • 05内置动画,组件可自定义。
  • 06内置屏幕阅读器支持。

适用场景

  • 为 React 文档或内容网站添加 Cmd+K 搜索与导航菜单。
  • 让 SaaS 仪表盘用户通过键盘触发应用操作。
  • 为 Web 应用构建页面和设置的快速跳转菜单。

快速上手

  1. 1

    从 npm 安装 kbar

    npm install kbar
  2. 2

    用 KBarProvider 包裹应用并添加 UI 组件

  3. 3

    按 cmd+k(macOS)或 ctrl+k(Linux/Windows)打开命令菜单

标签

常见问题

kbar 是什么?
一个 React 命令面板(Cmd+K)组件,可为网站添加带快捷键的可搜索操作菜单。 kbar 是一个 React 组件库,用于为网站或 Web 应用添加 Cmd+K 风格的命令面板。用户按下快捷键即可打开搜索框,直接执行原本需要逐层点击才能完成的操作。
kbar 可以免费使用吗?用的什么许可证?
kbar 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
kbar 还在维护吗?
半年内有更新。kbar 最近一次提交是在 2026年8月10日。
kbar 适合用来做什么?
为 React 文档或内容网站添加 Cmd+K 搜索与导航菜单。 让 SaaS 仪表盘用户通过键盘触发应用操作。 为 Web 应用构建页面和设置的快速跳转菜单。
kbar 怎么安装和运行?
从 npm 安装 kbar: npm install kbar 用 KBarProvider 包裹应用并添加 UI 组件 按 cmd+k(macOS)或 ctrl+k(Linux/Windows)打开命令菜单
在哪里获取 kbar?
源代码和安装说明在 GitHub 上:https://github.com/timc1/kbar

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目