Button 按钮

介绍

按钮通常用于触发操作。

代码演示

按钮类型

按钮支持 defaultprimarysuccesswarningdanger 五种类型,默认为 default

<z-button type="primary">主要按钮</z-button>
<z-button type="success">成功按钮</z-button>
<z-button type="default">默认按钮</z-button>
<z-button type="warning">警告按钮</z-button>
<z-button type="danger">危险按钮</z-button>

朴素按钮

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

<z-button plain type="primary">朴素按钮</z-button>
<z-button plain type="success">朴素按钮</z-button>

细边框

设置 hairline 属性可以展示 0.5px 的细边框。

为规范Andriod和IOS差异,zebra对button做了处理,按钮的边框默认统一使用细边框。

<z-button plain hairline type="primary">细边框按钮</z-button>
<z-button plain hairline type="success">细边框按钮</z-button>

禁用状态

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

<z-button disabled type="primary">禁用状态</z-button>
<z-button disabled type="success">禁用状态</z-button>

加载状态

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

<z-button loading type="primary" />
<z-button loading type="primary" loading-type="spinner" />
<z-button loading type="success" loading-text="加载中..." />

按钮形状

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

<z-button square type="primary">方形按钮</z-button>
<z-button round type="success">圆形按钮</z-button>

图标按钮

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

<z-button icon="plus" type="primary" />
<z-button icon="plus" type="primary">按钮</z-button>
<z-button
  icon="https://cdn.zebraui.com/zebra-ui/images/assets/demo-select.png"
  type="primary"
>
  按钮
</z-button>

按钮尺寸

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

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

块级元素

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

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

自定义颜色

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

<z-button color="#7232dd">单色按钮</z-button>
<z-button color="#7232dd" plain>单色按钮</z-button>
<z-button color="linear-gradient(to right, #ff6034, #ee0a24)">
  渐变色按钮
</z-button>

动画按钮

搭配 Button 和 Swipe 组件,可以实现垂直滚动的动画按钮效果。

<z-button type="danger">
  <z-swipe
    vertical
    class="notice-swipe"
    :autoplay="2000"
    :touchable="false"
    :show-indicators="false"
    :custom-style="{ height: '30rpx' }"
  >
    <z-swipe-item>按钮一</z-swipe-item>
    <z-swipe-item>按钮二</z-swipe-item>
  </z-swipe>
</z-button>

API

Props

参数说明类型默认值
type类型,可选值为 primary success warning dangerstringdefault
size尺寸,可选值为 large small ministringnormal
text按钮文字string-
color按钮颜色,支持传入 linear-gradient 渐变色string-
icon左侧图标名称或图片链接,等同于 Icon 组件的 name 属性string-
icon-prefix图标类名前缀,等同于 Icon 组件的 class-prefix 属性stringz-icon
icon-position图标展示位置,可选值为 rightstringleft
block是否为块级元素booleanfalse
plain是否为朴素按钮booleanfalse
square是否为方形按钮booleanfalse
round是否为圆形按钮booleanfalse
disabled是否禁用按钮booleanfalse
hairline是否使用 0.5px 边框booleantrue
loading是否显示为加载状态booleanfalse
loading-text加载状态提示文字string-
loading-type加载图标类型,可选值为 spinnerstringcircular
loading-size加载图标大小,默认单位为 px,可传入带rpx单位的字符串number | string-
customStyle自定义按钮的样式object-
customClass自定义按钮的类名object-
formType用于 form 组件,点击分别会触发 form 组件的 submit/reset 事件string-
hide-border是否强制隐藏边框,设置此属性,将会强制隐藏按钮的边框booleanfalse
hide-radius是否强制去掉border-radius样式booleanfalse

Events

事件名说明回调参数
click点击按钮,且按钮状态不为加载或禁用时触发event
clickLoading点击按钮,且按钮状态为加载时触发event

Slots

名称说明
default按钮内容
icon自定义图标
loading自定义加载图标

类型定义

组件导出以下类型定义:

import type {
  ButtonType,
  ButtonSize,
  ButtonProps,
  ButtonIconPosition,
} from '@zebra-ui/uniapp/components/z-button/types';

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
--z-button-mini-height46rpx-
--z-button-mini-padding0 var(--z-padding-base)-
--z-button-mini-font-sizevar(--z-font-size-xs)-
--z-button-small-height64rpx-
--z-button-small-padding0 var(--z-padding-xs)-
--z-button-small-font-sizevar(--z-font-size-sm)-
--z-button-normal-font-sizevar(--z-font-size-md)-
--z-button-normal-padding0 30rpx-
--z-button-large-height100rpx-
--z-button-default-height88rpx-
--z-button-default-line-height1.2-
--z-button-default-font-sizevar(--z-font-size-lg)-
--z-button-default-colorvar(--z-text-color)-
--z-button-default-backgroundvar(--z-background-2)-
--z-button-default-border-colorvar(--z-gray-4)-
--z-button-primary-colorvar(--z-white)-
--z-button-primary-backgroundvar(--z-primary-color)-
--z-button-primary-border-colorvar(--z-primary-color)-
--z-button-success-colorvar(--z-white)-
--z-button-success-backgroundvar(--z-success-color)-
--z-button-success-border-colorvar(--z-success-color)-
--z-button-danger-colorvar(--z-white)-
--z-button-danger-backgroundvar(--z-danger-color)-
--z-button-danger-border-colorvar(--z-danger-color)-
--z-button-warning-colorvar(--z-white)-
--z-button-warning-backgroundvar(--z-orange)-
--z-button-warning-border-colorvar(--z-orange)-
--z-button-border-widthvar(--z-border-width)-
--z-button-radiusvar(--z-radius-md)-
--z-button-round-radiusvar(--z-radius-max)-
--z-button-plain-backgroundvar(--z-white)-
--z-button-disabled-opacityvar(--z-disabled-opacity)-
--z-button-icon-size1.2em-
--z-button-loading-icon-size40rpx-

注意事项

uniappbutton组件会自带边框等样式,且无法通过全局样式进行覆盖,组件提供hide-border hide-radius 属性来强制覆盖。