Button ​

Commonly used button.

Basic usage ​

Use type, plain, round and circle to define Button's style.

Disabled Button ​

The disabled attribute determines if the button is disabled.

Use disabled attribute to determine whether a button is disabled. It accepts a Boolean value.

WARNING

type="text" has been deprecated, and will be removed in 3.0.0, consider switching to new API.

New API link has been added in 2.2.1, you can use type API to set the theme of your link button

Basic link button

Disabled link button

Text Button ​

TIP

Text button has been upgraded with a new design since , if you want to use the previous version like button, you might want to check Link out.

The API is also updated, because the type attribute also represents the button's style. So we have to make a new API text: boolean for text button.

Buttons without border and background.

Basic text button

Background color always on

Disabled text button

Icon Button ​

Use icons to add more meaning to Button. You can use icon alone to save some space, or use it with text.

Use the icon attribute to add icon. You can find the icon list in Element Plus icon component. Adding icons to the right side of the text is achievable with an <i> tag. Custom icons can be used as well.

Button Group ​

Displayed as a button group, can be used to group a series of similar operations.

Use tag <el-button-group> to group your buttons.

Loading Button ​

Click the button to load data, then the button displays a loading state.

Set loading attribute to true to display loading state.

TIP

You can use the loading slot or loadingIcon to customize your loading component

ps: loading slot has higher priority than loadingIcon

Sizes ​

Besides default size, Button component provides three additional sizes for you to choose among different scenarios.

Use attribute size to set additional sizes with large, small.

Tag 2.3.4 ​

You can custom element tag, For example button, div, a, router-link, nuxt-link.

div
a

Custom Color beta ​

You can custom button color.

We will calculate hover color & active color automatically.

Button API ​

Button Attributes ​

NameDescriptionTypeDefault
sizebutton sizeenum—
typebutton typeenum—
plaindetermine whether it's a plain buttonbooleanfalse
text 2.2.0determine whether it's a text buttonbooleanfalse
bg 2.2.0determine whether the text button background color is always onbooleanfalse
link 2.2.1determine whether it's a link buttonbooleanfalse
rounddetermine whether it's a round buttonbooleanfalse
circledetermine whether it's a circle buttonbooleanfalse
loadingdetermine whether it's loadingbooleanfalse
loading-iconcustomize loading icon componentstring / ComponentLoading
disableddisable the buttonbooleanfalse
iconicon componentstring / Component—
autofocussame as native button's autofocusbooleanfalse
native-typesame as native button's typeenumbutton
auto-insert-spaceautomatically insert a space between two chinese charactersboolean—
colorcustom button color, automatically calculate hover and active colorstring—
darkdark mode, which automatically converts color to dark mode colorsbooleanfalse
tag 2.3.4custom element tagstring / Componentbutton

Button Slots ​

NameDescription
defaultcustomize default content
loadingcustomize loading component
iconcustomize icon component

Button Exposes ​

NameDescriptionType
refbutton html elementobject
sizebutton sizeobject
typebutton typeobject
disabledbutton disabledobject
shouldAddSpacewhether adding spaceobject

ButtonGroup API ​

ButtonGroup Attributes ​

NameDescriptionTypeDefault
sizecontrol the size of buttons in this button-groupenum—
typecontrol the type of buttons in this button-groupenum—

ButtonGroup Slots ​

NameDescriptionSubtags
defaultcustomize button group contentButton

Source ​

Component • Style • Docs

Contributors ​