Button 按钮

常用的操作按钮。

基础用法

使用 type、plain、 round和 circle来定义按钮的样式。

<template>
    <p>
        <ec-button>Default</ec-button>
        <ec-button type="primary">Primary</ec-button>
        <ec-button type="success">Success</ec-button>
        <ec-button type="info">Info</ec-button>
        <ec-button type="warning">Warning</ec-button>
        <ec-button type="danger">Danger</ec-button>
    </p>

    <p>
        <ec-button plain>Plain</ec-button>
        <ec-button type="primary" plain>Primary</ec-button>
        <ec-button type="success" plain>Success</ec-button>
        <ec-button type="info" plain>Info</ec-button>
        <ec-button type="warning" plain>Warning</ec-button>
        <ec-button type="danger" plain>Danger</ec-button>
    </p>

    <p>
        <ec-button round>Round</ec-button>
        <ec-button type="primary" round>Primary</ec-button>
        <ec-button type="success" round>Success</ec-button>
        <ec-button type="info" round>Info</ec-button>
        <ec-button type="warning" round>Warning</ec-button>
        <ec-button type="danger" round>Danger</ec-button>
    </p>

    <p>
        <ec-button icon="search" circle />
        <ec-button type="primary" icon="edit" circle />
        <ec-button type="success" icon="check" circle />
        <ec-button type="info" icon="message" circle />
        <ec-button type="warning" icon="star" circle />
        <ec-button type="danger" icon="trash" circle />
    </p>
</template>

禁用状态

你可以使用 disabled 属性来定义按钮是否被禁用。

<template>
    <p>
        <ec-button>Default</ec-button>
        <ec-button type="primary">Primary</ec-button>
        <ec-button type="success">Success</ec-button>
        <ec-button type="info">Info</ec-button>
        <ec-button type="warning">Warning</ec-button>
        <ec-button type="danger">Danger</ec-button>
    </p>
    <p>
        <ec-button disabled>Default</ec-button>
        <ec-button type="primary" disabled>Primary</ec-button>
        <ec-button type="success" disabled>Success</ec-button>
        <ec-button type="info" disabled>Info</ec-button>
        <ec-button type="warning" disabled>Warning</ec-button>
        <ec-button type="danger" disabled>Danger</ec-button>
    </p>
</template>

图标按钮

使用 icon属性来定义按钮的图标。

<template>
    <div>
        <ec-button type="primary" icon="edit" />
        <ec-button type="primary" icon="share" />
        <ec-button type="primary" icon="trash" />
        <ec-button type="primary" icon="search">Search</ec-button>
        <ec-button type="primary">
            Upload<ec-icon icon="upload" style="margin-left: 8px" />
        </ec-button>
    </div>
</template>

按钮组

使用 <ec-button-group> 对多个按钮分组。

<template>
    <p>
        <ec-button-group disabled>
            <ec-button type="primary" icon="arrow-left">Previous Page</ec-button>
            <ec-button type="primary">
                Next Page<ec-icon icon="arrow-right" style="margin-left: 8px" />
            </ec-button>
        </ec-button-group>
    </p>
    <p>
        <ec-button-group type="warning" size="small">
            <ec-button type="primary" icon="edit" round />
            <ec-button type="primary" icon="share" />
            <ec-button type="primary" icon="trash" round />
        </ec-button-group>
    </p>
</template>

加载状态

使用 loading属性来定义按钮的加载状态。

TIP

您可以使用 loading 插槽或 loadingIcon 属性自定义您的 loading 图标

ps: loading 插槽优先级高于 loadingIcon 属性

<template>
    <div>
        <ec-button type="primary" loading>Loading</ec-button>
        <ec-button type="primary" loading-icon="circle-notch" loading>Loading</ec-button>
        <ec-button type="primary" loading>
            <template #loading>
                <ec-icon style="margin-right: 6px" icon="star" spin />
            </template>
            Loading
        </ec-button>
    </div>
</template>

按钮尺寸

使用 size属性来定义按钮的尺寸。

<template>
    <p>
        <ec-button size="large">Large</ec-button>
        <ec-button>Default</ec-button>
        <ec-button size="small">Small</ec-button>
        <ec-button size="large" icon="search">Search</ec-button>
        <ec-button icon="search">Search</ec-button>
        <ec-button size="small" icon="search">Search</ec-button>
    </p>
    <p>
        <ec-button size="large" round>Large</ec-button>
        <ec-button round>Default</ec-button>
        <ec-button size="small" round>Small</ec-button>
        <ec-button size="large" icon="search" round>Search</ec-button>
        <ec-button icon="search" round>Search</ec-button>
        <ec-button size="small" icon="search" round>Search</ec-button>
    </p>
    <p>
        <ec-button size="large" icon="search" circle />
        <ec-button icon="search" circle />
        <ec-button size="small" icon="search" circle />
    </p>
</template>

Tag

可以自定义元素标签。例如，按钮，div，路由链接，nuxt 链接。

div

a

<template>
    <ec-button>button</ec-button>
    <ec-button tag="div" role="button" tabindex="0">div</ec-button>
    <ec-button type="primary" tag="a" href="https://github.com/EricWXY/eric-ui" target="_blank"
        rel="noopener noreferrer">
        a
    </ec-button>
</template>

节流模式

可以通过 useThrottle 属性来定义按钮是否使用节流模式 默认为 true。

<script setup>
function handleBtnClick() {
    console.log("btn click");
}
</script>

<template>
    <p>
        <ec-button @click="handleBtnClick"> with throttle</ec-button>
        <ec-button :use-throttle="false" @click="handleBtnClick">without throttle</ec-button>
    </p>
</template>

Button API

Props

Name	Description	Type	Default
size	尺寸	enum - 'large'| 'default'| 'small'	—
type	类型	enum - 'primary'| 'success'| 'warning'| 'danger'| 'info'	info
plain	是否为朴素按钮	boolean	false
round	是否为圆角按钮	boolean	false
circle	是否为圆形按钮	boolean	false
loading	是否为加载中状态	boolean	false
loading-icon	自定义加载中状态图标组件	string	spinner
disabled	按钮是否为禁用状态	boolean	false
icon	按钮图标	string	-
autofocus	是否自动聚焦(原生autofocus属性)	boolean	false
native-type	原生 type 属性	enum - 'button'| 'submit'| 'reset'	button
tag	自定义元素标签	string/Component	button
use-throttle	是否使用节流模式	boolean	true
throttle-duration	节流模式下，节流时间间隔(ms)	number	500

Events

Name	Description	Type
click	按钮点击事件	(event: MouseEvent)=> void

Slots

Name	Description
default	默认插槽, 按钮内容
loading	自定义加载图标

Expose

Name	Description	Type
ref	按钮 html 元素	Ref<HTMLButtonElement>
size	按钮尺寸	ComputedRef<''|'small' |'large'>
type	按钮类型	ComputedRef<''|'primary' |...>
disabled	按钮禁用状态	ComputedRef<boolean>

ButtonGroup API

Props

Name	Description	Type	Default
size	尺寸	enum - 'large'| 'default'| 'small'	—
type	类型	enum - 'primary'| 'success'| 'warning'| 'danger'| 'info'	info
disabled	按钮组是否为禁用状态	boolean	false

Slots

Name	Description	Sub Component
default	默认插槽	Button