@gemeente-denhaag/button

中文文档
3.2.0发布于 2026/10/05EUPL-1.2TypeScriptESM + CJS构建来源已验证近 30 天下载 2.5万

按钮组件

中文使用文档
文档目录18 节
  1. 何时使用
  2. 替代品和相关构成部分
  3. 解剖学
  4. (互动)状态
  5. 设计属性
  6. 类型
  7. 颜色
  8. 交互式状态
  9. 结构
  10. 无障碍
  11. 导航
  12. 键盘支持
  13. 内容准则
  14. 最佳做法
  15. 说吧
  16. 别
  17. 按钮对链接
  18. 参考资料

按钮

npm version GitHub Workflow Status (branch)

按钮用于"Add","Close","Cancel"或"Save"等动作. 按钮标签表示当用户与其互动时会发生什么动作.

何时使用

使用按钮来沟通用户可以采取的行动并允许用户与页面交互. 每一页应有一个主按钮,任何剩余的行动呼号应作为更低的强调按钮来表示.

使用 Link 用于句子内或句子后立即出现的导航动作.

导航到链接

解剖学

按钮包括:

  1. 标签:在用户与它互动时,通知将要执行的动作.
  2. 图标(可选):为标签提供支持.
  3. 集装箱

(互动)状态

按钮包含状态正常,徘徊,禁用和聚焦.

设计属性

类型

大块

  • 标签:Sans/lg/400

中型

  • 标签:桑斯人/md/400

颜色

主按钮

  • 标签: 文字颜色为白色
  • 图标: svg 颜色为白色
  • 集装箱:背景-绿色/3

二级按钮

  • 标签:文本颜色为绿色/3
  • 图标: svg 颜色为绿色/3
  • 集装箱:背景颜色为白色,边框为绿色/3

交互式状态

主按钮

  • Hover:集装箱背景-绿色/4
  • 已禁用: 容器背景- 灰色/2
  • 焦点:容器边框颜色 Ocher/5

二级按钮

  • Hover:标签文本颜色为Green/4,图标 svg颜色为Green/4,集装箱边框颜色为Green/4
  • 已禁用: 标签为文本颜色 Grey/2, 图标 svg 颜色 Grey/2, 容器边框颜色 Grey/2
  • 焦点:容器边框颜色 Ocher/5

结构

大块

  • 标签:贴上左侧和贴上右侧20px
  • 图标:高度和宽度 24px
  • 图标-左: 贴地-左 16px,贴地-右 8px
  • 图标- 右: 贴地- 左 8px, 贴地- 右 16px
  • 集装箱:高度48px

中型

  • 标签: 左侧和右侧 16px
  • 图标:高度和宽度 20px
  • 图标左: 贴上左 12px,贴上右 8px
  • 图标 - 右: 贴上左 8px,贴上右 12px
  • 集装箱:高度40px

主按钮

  • 集装箱重点:集装箱边界2px,破损5,5

二级按钮

  • 集装箱:1px边界
  • 集装箱重点:集装箱边界2px,破损5,5

无障碍

警报为残疾用户提供上下文和协助工作流程.

  • 警示使用图标和颜色的组合来显示其意义和重要性.
  • [技术无障碍要求]

导航

用户一般期望按钮发送数据或采取行动,并能够导航链接. 如果按钮组件需要导航,请使用url道具. 控件以按钮的形式显示锚,而不是HTML中的按钮来表达这种差异.

关于创建可访问链接的更多信息, 请参见链接 .

键盘支持

按键使用浏览器的默认设置进行键盘交互.

  • 用标签键给键盘焦点( 或向后移动 + 标签)
  • 激活带有输入/ 返回密钥或空格密钥的按钮

内容准则

按钮应明确和可预测。 用户应该能够预测在选择按钮时会发生什么. 千万别用错误的标签来误导任何人.

按钮应始终以强有力的动词来引导,鼓励行动. 要给用户提供足够的上下文,可以使用按钮上的内容公式{动词}+{名},但"Done","Close","Cancel"或"OK"等一般动作除外.

最佳做法

说吧

按钮必须:

  • 明确而准确地标出标签.
  • 包含一个强而面向行动的动词.
  • 使用右上下文中的按钮颜色 。 例如,对于一个难以或无法撤销的动作,只使用红色出错按钮.
  • 优先采取最重要的行动。 太多的行动呼吁会造成混乱,使用户不确定下一步要做什么.
  • 位于接口中一致的位置.

别

按钮必须:

  • 切勿猜测用户按键会做什么, 特别是如果按键是不可逆的 .
  • 不作通航用. 您可以为此使用链接 .
  • 不包在超过一行。 确保文本保持一行.

按钮主要用于"Add","Close","Cancel"或"Save"等动作. 类似链接的正则按钮被用在不太重要或常用的动作上,如"视频细节".

链接主要用于导航,通常出现在句子中或紧接句子后.

为按钮和链接组件显示的 HTML 有意义. 有意和始终如一地使用这些组成部分,导致:

  • 为辅助技术用户提供更具包容性的经验
  • 为视觉用户提供更连贯的视觉体验
  • 易于维护以扩大规模的产品

参考资料

https://uxmovement.com/buttons/5-rules-for-choosing-右字-上-按钮-标签/
https://uxplanet.org/7-basic-rules-for-button-design-63dcdf5676b4 (英语)
https://www.invisionapp.com/inside-design/comferredve-guide-designing-ux-按钮/ (中文(简体) )

版本与发布记录

@gemeente-denhaag/button 共发布 440 个版本,首次发布于 2021/03/20;过去 12 个月发布了 8 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
3.2.0latest2026/10/051 个月前
3.1.32026/09/231 个月前
3.1.22026/08/272 个月前
3.1.12026/07/273 个月前
3.1.02026/06/294 个月前
3.0.42026/06/115 个月前

关于 @gemeente-denhaag/button 的常见问题

@gemeente-denhaag/button 是什么?

按钮组件

如何安装 @gemeente-denhaag/button?

在项目目录运行 npm install @gemeente-denhaag/button,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(18 || 19)、react-dom(18 || 19)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gemeente-denhaag/button 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gemeente-denhaag/button 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gemeente-denhaag/button 可以商用吗?

@gemeente-denhaag/button 使用 EUPL-1.2 许可。声明的许可为 EUPL-1.2,请阅读许可原文确认使用条件。以上为概括,不构成法律意见,请以许可原文为准。

@gemeente-denhaag/button 的下载量有多少?

根据 npm 官方下载统计,@gemeente-denhaag/button 在 2026/10/16 – 2026/11/14 这 30 天内被下载 24,836 次,日均约 828 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gemeente-denhaag/button 还在维护吗?

最新版本 3.2.0 发布于 2026/10/05(1 个月前);至今共发布 440 个版本,其中过去 12 个月发布了 8 个;首次发布于 2021/03/20。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。