logoAnt Design

⌘ K
  • 设计
  • 研发
  • 组件
  • 博客
  • 资源
  • 国内镜像
5.25.2
  • 组件总览
  • 通用
    • Button按钮
    • FloatButton悬浮按钮
      5.0.0
    • Icon图标
    • Typography排版
  • 布局
    • Divider分割线
    • Flex弹性布局
      5.10.0
    • Grid栅格
    • Layout布局
    • Space间距
    • Splitter分隔面板
      5.21.0
  • 导航
    • Anchor锚点
    • Breadcrumb面包屑
    • Dropdown下拉菜单
    • Menu导航菜单
    • Pagination分页
    • Steps步骤条
    • Tabs标签页
  • 数据录入
    • AutoComplete自动完成
    • Cascader级联选择
    • Checkbox多选框
    • ColorPicker颜色选择器
      5.5.0
    • DatePicker日期选择框
    • Form表单
    • Input输入框
    • InputNumber数字输入框
    • Mentions提及
    • Radio单选框
    • Rate评分
    • Select选择器
    • Slider滑动输入条
    • Switch开关
    • TimePicker时间选择框
    • Transfer穿梭框
    • TreeSelect树选择
    • Upload上传
  • 数据展示
    • Avatar头像
    • Badge徽标数
    • Calendar日历
    • Card卡片
    • Carousel走马灯
    • Collapse折叠面板
    • Descriptions描述列表
    • Empty空状态
    • Image图片
    • List列表
    • Popover气泡卡片
    • QRCode二维码
      5.1.0
    • Segmented分段控制器
    • Statistic统计数值
    • Table表格
    • Tag标签
    • Timeline时间轴
    • Tooltip文字提示
    • Tour漫游式引导
      5.0.0
    • Tree树形控件
  • 反馈
    • Alert警告提示
    • Drawer抽屉
    • Message全局提示
    • Modal对话框
    • Notification通知提醒框
    • Popconfirm气泡确认框
    • Progress进度条
    • Result结果
    • Skeleton骨架屏
    • Spin加载中
    • Watermark水印
      5.1.0
  • 其他
    • Affix固钉
    • App包裹组件
      5.1.0
    • ConfigProvider全局化配置
    • Util工具类
      5.13.0

Button
按钮

按钮用于开始一个即时操作。
使用import { Button } from "antd";
源码components/button
文档
编辑此页设计指南更新日志

相关资源

Ant Design X
Ant Design Charts
Ant Design Pro
Pro Components
Ant Design Mobile
Ant Design Mini
Ant Design Web3
Ant Design Landing-首页模板集
Scaffolds-脚手架市场
Umi-React 应用开发框架
dumi-组件/文档研发工具
qiankun-微前端框架
Ant Motion-设计动效
国内镜像站点 🇨🇳

社区

Awesome Ant Design
Medium
Twitter
yuque logoAnt Design 语雀专栏
Ant Design 知乎专栏
体验科技专栏
seeconf logoSEE Conf-蚂蚁体验科技大会
加入我们

帮助

GitHub
更新日志
常见问题
报告 Bug
议题
讨论区
StackOverflow
SegmentFault

Ant XTech logo更多产品

yuque logo语雀-构建你的数字花园
AntV logoAntV-数据可视化解决方案
Egg logoEgg-企业级 Node.js 框架
Kitchen logoKitchen-Sketch 工具集
Galacean logoGalacean-互动图形解决方案
xtech logo蚂蚁体验科技
主题编辑器
Made with ❤ by
蚂蚁集团和 Ant Design 开源社区

何时使用

标记了一个(或封装一组)操作命令,响应用户点击行为,触发相应的业务逻辑。

在 Ant Design 中我们提供了五种按钮。

  • 🔵 主按钮:用于主行动点,一个操作区域只能有一个主按钮。
  • ⚪️ 默认按钮:用于没有主次之分的一组行动点。
  • 🫥 虚线按钮:常用于添加操作。
  • 🔤 文本按钮:用于最次级的行动点。
  • 🔗 链接按钮:一般用于链接,即导航至某位置。

以及四种状态属性与上面配合使用。

  • ⚠️ 危险:删除/移动/修改权限等危险操作,一般需要二次确认。
  • 👻 幽灵:用于背景色比较复杂的地方,常用在首页/产品页等展示场景。
  • 🚫 禁用:行动点不可用的时候,一般需要文案解释。
  • 🔃 加载中:用于异步操作等待反馈的时候,也可以避免多次提交。

代码演示

语法糖

通过 type 语法糖,使用预设的按钮样式:主按钮、次按钮、虚线按钮、文本按钮和链接按钮。推荐主按钮在同一个操作区域最多出现一次。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
按钮图标

可以通过 icon属性添加图标。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
Preview
按钮尺寸

按钮有大、中、小三种尺寸。

通过设置 size 为 large small 分别把按钮设为大、小尺寸。若不设置 size,则尺寸默认为中。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
加载中状态

添加 loading 属性即可让按钮处于加载状态,loading.icon 可以自定义加载图标,最后三个按钮演示点击后进入加载状态。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
幽灵按钮

幽灵按钮将按钮的内容反色,背景变为透明,常用在有色背景上。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
Block 按钮

block 属性将使按钮适合其父宽度。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
颜色与变体

同时设置 color 和 variant 属性,可以衍生出更多的变体按钮。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
5.21.0
Preview
按钮图标位置

通过设置 iconPosition 为 start 或 end 分别设置按钮图标的位置。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
5.17.0
Href PrimaryHref Primary(disabled)
不可用状态

添加 disabled 属性即可让按钮处于不可用状态,同时按钮样式也会改变。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
多个按钮组合

按钮组合使用时,推荐使用 1 个主操作 + n 个次操作,3 个以上操作时把更多操作放到 Dropdown.Button 中组合使用。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
危险按钮

在 4.0 之后,危险成为一种按钮属性而不是按钮类型。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
渐变按钮

自定义为渐变背景按钮。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

API

通用属性参考:通用属性

通过设置 Button 的属性来产生不同的按钮样式,推荐顺序为:type -> shape -> size -> loading -> disabled。

按钮的属性说明如下:

属性说明类型默认值版本
autoInsertSpace我们默认提供两个汉字之间的空格,可以设置 autoInsertSpace 为 false 关闭booleantrue5.17.0
block将按钮宽度调整为其父宽度的选项booleanfalse
classNames语义化结构 classRecord<SemanticDOM, string>-5.4.0
color设置按钮的颜色default | primary | danger | PresetColors-default、primary 和 danger: 5.21.0, PresetColors: 5.23.0
danger语法糖,设置危险按钮。当设置 color 时会以后者为准booleanfalse
disabled设置按钮失效状态booleanfalse
ghost幽灵属性,使按钮背景透明booleanfalse
href点击跳转的地址,指定此属性 button 的行为和 a 链接一致string-
htmlType设置 button 原生的 type 值,可选值请参考 HTML 标准submit | reset | buttonbutton
icon设置按钮的图标组件ReactNode-
iconPosition设置按钮图标组件的位置start | endstart5.17.0
loading设置按钮载入状态boolean | { delay: number, icon: ReactNode }falseicon: 5.23.0
shape设置按钮形状default | circle | rounddefault
size设置按钮大小large | middle | smallmiddle
styles语义化结构 styleRecord<SemanticDOM, CSSProperties>-5.4.0
target相当于 a 链接的 target 属性,href 存在时生效string-
type语法糖,设置按钮类型。当设置 variant 与 color 时以后者为准primary | dashed | link | text | defaultdefault
onClick点击按钮时的回调(event: React.MouseEvent<HTMLElement, MouseEvent>) => void-
variant设置按钮的变体outlined | dashed | solid | filled | text | link-5.21.0

支持原生 button 的其他所有属性。

PresetColors

type PresetColors = 'blue' | 'purple' | 'cyan' | 'green' | 'magenta' | 'pink' | 'red' | 'orange' | 'yellow' | 'volcano' | 'geekblue' | 'lime' | 'gold';

Semantic DOM

  • icon
    5.5.0
    图标元素

主题变量(Design Token)

组件 Token如何定制?
Token 名称描述类型默认值
borderColorDisabled禁用状态边框颜色string#d9d9d9
contentFontSize按钮内容字体大小number14
contentFontSizeLG大号按钮内容字体大小number16
contentFontSizeSM小号按钮内容字体大小number14
contentLineHeight按钮内容字体行高number1.5714285714285714
contentLineHeightLG大号按钮内容字体行高number1.5
contentLineHeightSM小号按钮内容字体行高number1.5714285714285714
dangerColor危险按钮文本颜色string#fff
dangerShadow危险按钮阴影string0 2px 0 rgba(255,38,5,0.06)
defaultActiveBg默认按钮激活态背景色string#ffffff
defaultActiveBorderColor默认按钮激活态边框颜色string#0958d9
defaultActiveColor默认按钮激活态文字颜色string#0958d9
defaultBg默认按钮背景色string#ffffff
defaultBorderColor默认按钮边框颜色string#d9d9d9
defaultColor默认按钮文本颜色stringrgba(0,0,0,0.88)
defaultGhostBorderColor默认幽灵按钮边框颜色string#ffffff
defaultGhostColor默认幽灵按钮文本颜色string#ffffff
defaultHoverBg默认按钮悬浮态背景色string#ffffff
defaultHoverBorderColor默认按钮悬浮态边框颜色string#4096ff
defaultHoverColor默认按钮悬浮态文本颜色string#4096ff
defaultShadow默认按钮阴影string0 2px 0 rgba(0,0,0,0.02)
fontWeight文字字重undefined | FontWeight400
ghostBg幽灵按钮背景色stringtransparent
groupBorderColor按钮组边框颜色string#4096ff
linkHoverBg链接按钮悬浮态背景色stringtransparent
onlyIconSize只有图标的按钮图标尺寸string | numberinherit
onlyIconSizeLG大号只有图标的按钮图标尺寸string | numberinherit
onlyIconSizeSM小号只有图标的按钮图标尺寸string | numberinherit
paddingBlock按钮纵向内间距undefined | PaddingBlock<string | number>4
paddingBlockLG大号按钮纵向内间距undefined | PaddingBlock<string | number>7
paddingBlockSM小号按钮纵向内间距undefined | PaddingBlock<string | number>0
paddingInline按钮横向内间距undefined | PaddingInline<string | number>15
paddingInlineLG大号按钮横向内间距undefined | PaddingInline<string | number>15
paddingInlineSM小号按钮横向内间距undefined | PaddingInline<string | number>7
primaryColor主要按钮文本颜色string#fff
primaryShadow主要按钮阴影string0 2px 0 rgba(5,145,255,0.1)
solidTextColor默认实心按钮的文本色string#fff
textHoverBg文本按钮悬浮态背景色stringrgba(0,0,0,0.04)
textTextActiveColor默认文本按钮激活态文字颜色stringrgba(0,0,0,0.88)
textTextColor默认文本按钮的文本色stringrgba(0,0,0,0.88)
textTextHoverColor默认文本按钮悬浮态文本颜色stringrgba(0,0,0,0.88)
全局 Token如何定制?

FAQ

类型和颜色与变体如何选择?

类型本质上是颜色与变体的语法糖,内部为其提供了一组颜色与变体的映射关系。如果两者同时存在,优先使用颜色与变体。

jsx
<Button type="primary">click</Button>

等同于

jsx
<Button color="primary" variant="solid">
click
</Button>

如何关闭点击波纹效果?

如果你不需要这个特性,可以设置 ConfigProvider 的 wave 的 disabled 为 true。

jsx
<ConfigProvider wave={{ disabled: true }}>
<Button>click</Button>
</ConfigProvider>

设计指引

  • 我的按钮究竟该放哪儿!?| Ant Design 4.0 系列分享
移除两个汉字之间的空格

我们默认在两个汉字之间添加空格,可以通过设置 autoInsertSpace 为 false 关闭。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
5.17.0