# Button 按钮

# 介绍

该Button组件兼容全端

# 代码演示

# 按钮类型

支持defaultprimaryinfowarningdanger五种类型,默认为default

<x-button type="default">默认按钮</x-button>
<x-button type="primary">主要按钮</x-button>
<x-button type="info">信息按钮</x-button>
<x-button type="warning">警告按钮</x-button>
<x-button type="danger">危险按钮</x-button>
1
2
3
4
5

# 朴素按钮

通过plain属性将按钮设置为朴素按钮,朴素按钮的文字为按钮颜色,背景为白色。

<x-button plain type="primary">朴素按钮</x-button>
<x-button plain type="info">朴素按钮</x-button>
1
2

# 细边框

设置hairline属性可以开启 0.5px 边框,基于伪类实现

<x-button plain hairline type="primary">细边框按钮</x-button>
<x-button plain hairline type="info">细边框按钮</x-button>
1
2

# 禁用状态

通过disabled属性来禁用按钮,禁用状态下按钮不可点击

<x-button disabled type="primary">禁用状态</x-button>
<x-button disabled type="info">禁用状态</x-button>
1
2

# 加载状态

通过loading属性设置按钮为加载状态,加载状态下默认会隐藏按钮文字,可以通过loading-text设置加载状态下的文字

<x-button loading type="primary" />
<x-button loading type="primary" loading-type="spinner" />
<x-button loading type="info" loading-text="加载中..." />
1
2
3

# 按钮形状

通过square设置方形按钮,通过round设置圆形按钮

<x-button square type="primary">方形按钮</x-button>
<x-button round type="info">圆形按钮</x-button>
1
2

# 图标按钮

通过icon属性设置按钮图标,支持 Icon 组件里的所有图标,也可以传入图标 URL

<x-button icon="star-o" type="primary" />
<x-button icon="star-o" type="primary">按钮</x-button>
<x-button icon="https://img.yzcdn.cn/vant/logo.png" type="info"
  >按钮</x-button
>
1
2
3
4
5

# 按钮尺寸

支持largenormalsmallmini四种尺寸,默认为normal

<x-button type="primary" size="large">大号按钮</x-button>
<x-button type="primary" size="normal">普通按钮</x-button>
<x-button type="primary" size="small">小型按钮</x-button>
<x-button type="primary" size="mini">迷你按钮</x-button>
1
2
3
4

# 块级元素

按钮在默认情况下为行内块级元素,通过block属性可以将按钮的元素类型设置为块级元素

<x-button type="primary" block>块级元素</x-button>
1

# 页面导航

可以通过url属性进行 URL 跳转,或通过to属性进行路由跳转

<x-button type="primary" url="/vant/mobile.html">URL 跳转</x-button>
<x-button type="primary" to="index">路由跳转</x-button>
1
2

# 自定义颜色

通过color属性可以自定义按钮的颜色

<x-button color="#7232dd">单色按钮</x-button>
<x-button color="#7232dd" plain>单色按钮</x-button>
<x-button color="linear-gradient(to right, #4bb0ff, #6149f6)">渐变色按钮</x-button>
1
2
3

# API

# Props

参数 说明 类型 默认值
type 类型,可选值为 primary info warning danger string default
size 尺寸,可选值为 large small mini string normal
text 按钮文字 string -
color v2.1.8 按钮颜色,支持传入linear-gradient渐变色 string -
icon 左侧图标名称或图片链接 string -
icon-prefix v2.6.0 图标类名前缀,同 Icon 组件的 class-prefix 属性 string van-icon
tag 根节点的 HTML 标签 string button
native-type 原生 button 标签的 type 属性 string -
block 是否为块级元素 boolean false
plain 是否为朴素按钮 boolean false
square 是否为方形按钮 boolean false
round 是否为圆形按钮 boolean false
disabled 是否禁用按钮 boolean false
hairline 是否使用 0.5px 边框 boolean false
loading 是否显示为加载状态 boolean false
loading-text 加载状态提示文字 string -
loading-type 加载图标类型,可选值为spinner string circular
loading-size 加载图标大小 string 20px
url 点击后跳转的链接地址 string -
to 点击后跳转的目标路由对象,同 vue-router 的 to 属性 string | object -
replace 是否在跳转时替换当前页面历史 boolean false

# Events

事件名 说明 回调参数
click 点击按钮,且按钮状态不为加载或禁用时触发 event: Event
touchstart 开始触摸按钮时触发 event: TouchEvent