R后悔药 Rue.js
  • 首页
    • 深度指南
    • 实战例子
    • 快速上手
    • 路由指南
    • 术语表
    • 错误代码参考
  • API
    • 合作伙伴
    • 插件
    • 组件库
    • 工具链
    • Text.js
    • 新闻简报
    • 常见问题
    • 团队
    • 版本发布
    • 社区指南
    • 行为规范
    • 隐私政策
  • 赞助
  • 合作伙伴
设置
目录统计
总条目
  • 按钮 Button
  • 排版 Typography
  • 时间选择器 TimePicker
  • 下拉菜单 Dropdown
  • 悬浮操作按钮 FAB
  • 模态框 Modal
  • 切换 Swap
  • 主题控制器 Theme Controller
  • 手风琴 Accordion
  • 头像 Avatar
  • 徽标 Badge
  • 卡片 Card
  • 轮播 Carousel
  • 聊天气泡 Chat
  • 折叠面板 Collapse
  • 倒计时 Countdown
  • 描述列表 Descriptions
  • 对比 Diff
  • 二维码 QRCode
  • 悬浮 3D 卡片 Hover 3D
  • 悬浮画廊 Hover Gallery
  • 键盘提示 Kbd
  • 列表 List
  • 统计 Stat
  • 状态 Status
  • 表格 Table
  • 文本轮播 Text Rotate
  • 时间线 Timeline
  • 锚点 Anchor
  • 固钉 Affix
  • 面包屑 Breadcrumbs
  • 底部导航 Dock
  • 链接 Link
  • 菜单 Menu
  • 导航栏 Navbar
  • 分页 Pagination
  • 步骤 Steps
  • 选项卡 Tabs
  • 提示 Alert
  • 结果页 Result
  • 空状态 Empty
  • 加载 Loading
  • 全局提示 Message
  • 进度条 Progress
  • 环形进度 Radial Progress
  • 骨架屏 Skeleton
  • 通知提醒框 Notification
  • 轻提示 Toast
  • 气泡确认框 Popconfirm
  • 气泡卡片 Popover
  • 工具提示 Tooltip
  • 日历 Calendar
  • 颜色选择器 ColorPicker
  • 复选框 Checkbox
  • 字段集 Fieldset
  • 表单 Form
  • 文件输入 File Input
  • 筛选器 Filter
  • 标签 Label
  • 单选框 Radio
  • 范围选择 Range
  • 评分 Rating
  • 分段选择 Segmented
  • 自动完成 AutoComplete
  • 选择器 Select
  • 树选择 TreeSelect
  • 树控件 Tree
  • 提及输入 Mentions
  • 穿梭框 Transfer
  • 漫游引导 Tour
  • 输入框 Input
  • 数字输入 InputNumber
  • 文本域 Textarea
  • 开关 Toggle
  • 校验器 Validator
  • 分隔线 Divider
  • 弹性布局 Flex
  • 分割面板 Splitter
  • 抽屉侧边栏 Drawer
  • 页脚 Footer
  • 栅格 Grid
  • 瀑布流 Masonry
  • 布局 Layout
  • 主视觉区 Hero
  • 指示器 Indicator
  • 组合项 Join
  • 蒙版 Mask
  • 水印 Watermark
  • 间距 Space
  • 堆叠 Stack
  • 浏览器样机 Mockup Browser
  • 代码样机 Mockup Code
  • 手机样机 Mockup Phone
  • 窗口样机 Mockup Window
目录统计
总条目
  • 按钮 Button
  • 排版 Typography
  • 时间选择器 TimePicker
  • 下拉菜单 Dropdown
  • 悬浮操作按钮 FAB
  • 模态框 Modal
  • 切换 Swap
  • 主题控制器 Theme Controller
  • 手风琴 Accordion
  • 头像 Avatar
  • 徽标 Badge
  • 卡片 Card
  • 轮播 Carousel
  • 聊天气泡 Chat
  • 折叠面板 Collapse
  • 倒计时 Countdown
  • 描述列表 Descriptions
  • 对比 Diff
  • 二维码 QRCode
  • 悬浮 3D 卡片 Hover 3D
  • 悬浮画廊 Hover Gallery
  • 键盘提示 Kbd
  • 列表 List
  • 统计 Stat
  • 状态 Status
  • 表格 Table
  • 文本轮播 Text Rotate
  • 时间线 Timeline
  • 锚点 Anchor
  • 固钉 Affix
  • 面包屑 Breadcrumbs
  • 底部导航 Dock
  • 链接 Link
  • 菜单 Menu
  • 导航栏 Navbar
  • 分页 Pagination
  • 步骤 Steps
  • 选项卡 Tabs
  • 提示 Alert
  • 结果页 Result
  • 空状态 Empty
  • 加载 Loading
  • 全局提示 Message
  • 进度条 Progress
  • 环形进度 Radial Progress
  • 骨架屏 Skeleton
  • 通知提醒框 Notification
  • 轻提示 Toast
  • 气泡确认框 Popconfirm
  • 气泡卡片 Popover
  • 工具提示 Tooltip
  • 日历 Calendar
  • 颜色选择器 ColorPicker
  • 复选框 Checkbox
  • 字段集 Fieldset
  • 表单 Form
  • 文件输入 File Input
  • 筛选器 Filter
  • 标签 Label
  • 单选框 Radio
  • 范围选择 Range
  • 评分 Rating
  • 分段选择 Segmented
  • 自动完成 AutoComplete
  • 选择器 Select
  • 树选择 TreeSelect
  • 树控件 Tree
  • 提及输入 Mentions
  • 穿梭框 Transfer
  • 漫游引导 Tour
  • 输入框 Input
  • 数字输入 InputNumber
  • 文本域 Textarea
  • 开关 Toggle
  • 校验器 Validator
  • 分隔线 Divider
  • 弹性布局 Flex
  • 分割面板 Splitter
  • 抽屉侧边栏 Drawer
  • 页脚 Footer
  • 栅格 Grid
  • 瀑布流 Masonry
  • 布局 Layout
  • 主视觉区 Hero
  • 指示器 Indicator
  • 组合项 Join
  • 蒙版 Mask
  • 水印 Watermark
  • 间距 Space
  • 堆叠 Stack
  • 浏览器样机 Mockup Browser
  • 代码样机 Mockup Code
  • 手机样机 Mockup Phone
  • 窗口样机 Mockup Window

Kbd 键盘提示

Kbd 可以使用 Rue 当前的键帽视觉风格,并补上更适合实际场景的组合键 API。现在既可以写 <Kbd>K</Kbd> ,也可以直接用items或Kbd.Group组织快捷键序列。

何时使用

  • 需要展示单个按键、组合键或快捷键列表。
  • 希望可以使用 Rue 当前键帽视觉,但让组合表达更语义化、更容易复用。
  • 需要在设计页里同时保持静态示例和更贴近真实产品的快捷键场景。

# 推荐写法

根组件直接接收 items,适合大多数快捷键展示场景。

打开命令面板
推荐使用 items 直接表达组合键。
⌘+K
全局搜索
使用 Rue 的键帽视觉,同时让组合表达更直接。
⌘+⇧+F
快速提交
对象项可以单独控制某个键帽的 className。
Ctrl+Enter

# 组合子组件

Kbd.Combo 负责键序列,Kbd.Group 负责布局容器,Kbd.Separator 负责分隔符外观。

⌘+⇧+PG/ICtrl+Alt+Shift+Delete
Command Palette
Press⌘thenKto focus search
Shortcut List
New file⌘+N
Duplicate line⌥+⇧+↓

# 尺寸体系

展示基础 sizeDemo,并额外补上更顺手的语义尺寸别名。

Daisy 尺寸
XsmallSmallMediumLargeXlarge
语义别名
SmallMiddleMediumLarge

# 文本内嵌

展示基础 in textDemo,用于行文中的单键强调。

Press F to pay respects.

# 基础单键

展示基础示例,写法完全不变。

K

# 组合键

展示基础 key combinationDemo,并与新 API 共存。

ctrl + shift + del

# 功能键

展示基础 function keysDemo。

⌘⌥⇧⌃

# 完整键盘

展示基础 full keyboardDemo,说明 Kbd 仍然适合自由布局。

qwertyuiop
asdfghjkl
zxcvbnm/

# 方向键

展示基础 arrow keysDemo。

▲
◀︎▶︎
▼

API

当前页面展示的是 Kbd 根组件与组合模式的完整可用 API。

属性说明类型默认值
as指定根节点标签;单键模式默认渲染 kbd,组合模式默认渲染 spanany单键为 `kbd`,组合为 `span`
children单键模式内容,也可作为 Kbd.Group 的自定义内容any-
className根节点扩展类名string-
directionKbd.Group 布局方向,适合快捷键列表等垂直排布场景`horizontal` | `vertical``horizontal`
gapKbd.Group / Kbd.Combo 的间距预设`xs` | `sm` | `md` | `lg``sm`
itemClassName组合模式下给每个键帽统一追加类名string-
items组合模式数据源;可传基础值,也可传带 size/className 的对象Array<any | { key?: string | number; label?: any; children?: any; size?: KbdSize; className?: string }>-
separator组合模式分隔符;默认是 `+`,可传自定义节点或 `null`any`+`
separatorClassName组合模式下给分隔符统一追加类名string-
size键帽尺寸,支持 xs 到 xl,以及 small / middle / medium / large 别名`xs` | `sm` | `md` | `lg` | `xl` | `small` | `middle` | `medium` | `large`-
wrap组合模式是否允许自动换行booleanfalse

复合子组件

Kbd.Combo:显式渲染组合键序列,适合控制separator、wrap和itemClassName。
Kbd.Group:显式渲染布局容器,适合用direction和 gap组织多条快捷键。
Kbd.Separator:默认输出带弱化样式的分隔符,内容默认是+,也可以换成/、then等文案。

FAQ

什么时候用 children,什么时候用 items?

单个键帽或完全自定义布局时,可以用children 最直接;需要表达标准组合键时,优先用items或Kbd.Combo,维护成本更低。

分隔符只能是加号吗?

不是。你可以通过separator传任意节点,也可以直接使用 Kbd.Separator包一层,统一保持当前页面的弱化分隔视觉。

完整键盘这种自由布局还支持吗?

支持。Kbd 本质上仍然是轻量键帽组件,语义 API 只是补充组合键表达,不会限制你自由排布完整键盘。

页内导航
页内导航
文档
  • 深度指南
  • 实战例子
  • 快速上手
  • 术语表
  • 错误码参照表
关于
  • 常见问题
  • 团队
  • 版本发布
  • 社区指南
生态
  • 插件
  • 组件库
  • 路由指南
  • Text.js
© 2024-2026 Xiangmin Liu
Rue.JS