mirror of
https://github.com/element-plus/element-plus.git
synced 2024-12-09 02:31:33 +08:00
c6bed151a5
* feat(website): init viteperss (#3162) * init vitepress * Finish homepage * relayout page * partial finish * update * update use lang * remove font weight; change font size * docs: optimize docs folder structure * reorganize project * fix ssr issue * fix build issues Co-authored-by: Kevin <sxzz@sxzz.moe> Co-authored-by: zouhang <zouhang@didiglobal.com> * feat(website) integrate with crowdin (#3218) - Introduce Crowdin CLI - Add script for fetching Crowdin token from env - Add script for local development * fix formatting * update codeblocks (#3249) * feat(docs): update website preview script - Update azure preview build script - Eliminate dead links * bootstrap docs * fix homepage layout issue * fix formating * Finish ToC and codepen integration * reorganized files and fix issue that causes demo unavailable after build * feat(docs): migration documentations (#3283) * feat(docs): migration documentations - Move documentations to docs/ * remove unused files * docs: [popconfirm] migrate document (#3285) * feat(docs): migrate documentation from space.md to upload.md (#3292) - Upload documentations acorrodingly * docs: [date-picker] migrate document (#3289) * docs: [date-picker] migrate document * fix: typo * docs: [slider] migrate document (#3287) * docs: migrate documents (#3290) * docs: migrate-datetime-picker * docs: migrate descriptions * docs: migrate dialog * docs: migrate divider * docs: migrate drawer * docs: migrate drapdown * docs: fix drapdown * docs: migrate empty * docs: migrate form * docs: add scoped for style * docs: simplify toRefs * chore: update doc (#3297) * chore: update doc * chore: update doc * chore: update doc * feat(docs): migrate documentations from infinite-scroll to page-header (#3303) - Update docs accordingly - Update CodePen icon to match style - Update component name to match others * docs: migrate documentions (#3293) migrate list: * image * popover * scrollbar * radio * rate * skeleton * select * select-v2 * reault * progress * pagination * chore: update doc (#3305) Co-authored-by: 0song <0song@gmail.com> * Fix broken pipeline * chore: update demo plugin * website perfection * fix hydration bug * docs: update guide (#3342) * WIP docs * docs: update docs * add dark mode * make dev fetch components from local instead of node_modules Co-authored-by: msidolphin <msidolphin@outlook.com> Co-authored-by: Aex <spryti@qq.com> Co-authored-by: 0song <82012629+0song@users.noreply.github.com> Co-authored-by: 0song <0song@gmail.com> Co-authored-by: zouhang <zouhang@didiglobal.com> Co-authored-by: 三咲智子 <sxzz@sxzz.moe> * fix(docs): fix codepen code example issue (#3380) * fix(docs): fix codepen code example issue - Add lang="ts" for all example files - Fix codepen import error * revert changes in resource.vue * feat(docs): complete crowdin integration (#3408) * Update mds for preparing the integration script * deprecate old website * update sponsors and even handler for resize * update build script for preview * fix preview-build error * fix preview-build error * fix preview-build error * fix preview-build error * fix preview-build error * update deploy script and some bugs * Fix existing issue * chore(project): add dev preview workflow * chore(project): rename dev to staging * update the size of toc * update staging-preview script * update preview scripts * enable website build for preview * fix build error * final commitment for update the details * remove azure pipeline * move docs ignores into docs and update date Co-authored-by: Kevin <sxzz@sxzz.moe> Co-authored-by: zouhang <zouhang@didiglobal.com> Co-authored-by: msidolphin <msidolphin@outlook.com> Co-authored-by: Aex <spryti@qq.com> Co-authored-by: 0song <82012629+0song@users.noreply.github.com> Co-authored-by: 0song <0song@gmail.com>
125 lines
3.8 KiB
Markdown
125 lines
3.8 KiB
Markdown
# Button
|
|
|
|
Commonly used button.
|
|
|
|
## Basic usage
|
|
|
|
:::demo Use `type`, `plain`, `round` and `circle` to define Button's style.
|
|
|
|
button/basic
|
|
|
|
:::
|
|
|
|
## Disabled Button
|
|
|
|
The `disabled` attribute determines if the button is disabled.
|
|
|
|
:::demo Use `disabled` attribute to determine whether a button is disabled. It accepts a `Boolean` value.
|
|
|
|
button/disabled
|
|
|
|
:::
|
|
|
|
## Text Button
|
|
|
|
Buttons without border and background.
|
|
|
|
:::demo
|
|
|
|
button/text
|
|
|
|
:::
|
|
|
|
## Icon Button
|
|
|
|
Use icons to add more meaning to Button. You can use icon alone to save some space, or use it with text.
|
|
|
|
:::demo 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/icon
|
|
|
|
:::
|
|
|
|
## Button Group
|
|
|
|
Displayed as a button group, can be used to group a series of similar operations.
|
|
|
|
:::demo Use tag `<el-button-group>` to group your buttons.
|
|
|
|
button/group
|
|
|
|
:::
|
|
|
|
## Loading Button
|
|
|
|
Click the button to load data, then the button displays a loading state.
|
|
|
|
:::demo Set `loading` attribute to `true` to display loading state.
|
|
|
|
button/loading
|
|
|
|
:::
|
|
|
|
## Sizes
|
|
|
|
Besides default size, Button component provides three additional sizes for you to choose among different scenarios.
|
|
|
|
:::demo Use attribute `size` to set additional sizes with `medium`, `small` or `mini`.
|
|
|
|
button/size
|
|
|
|
:::
|
|
|
|
## Button Attributes
|
|
|
|
| Attribute | Description | Type | Accepted Values | Default |
|
|
| ----------- | -------------------------------------- | ------- | -------------------------------------------------- | ------- |
|
|
| size | button size | string | medium / small / mini | — |
|
|
| type | button type | string | primary / success / warning / danger / info / text | — |
|
|
| plain | determine whether it's a plain button | boolean | — | false |
|
|
| round | determine whether it's a round button | boolean | — | false |
|
|
| circle | determine whether it's a circle button | boolean | — | false |
|
|
| loading | determine whether it's loading | boolean | — | false |
|
|
| disabled | disable the button | boolean | — | false |
|
|
| icon | icon class name | string | — | — |
|
|
| autofocus | same as native button's `autofocus` | boolean | — | false |
|
|
| native-type | same as native button's `type` | string | button / submit / reset | button |
|
|
|
|
## Button-Group Attributes
|
|
|
|
| Attribute | Description | Type | Accepted Values | Default |
|
|
| --------- | ------------------------------------------------ | ------ | --------------------- | ------- |
|
|
| size | control the size of buttons in this button-group | string | medium / small / mini | — |
|
|
|
|
## Button-Group Slots
|
|
|
|
| Name | Description |
|
|
| ------- | ------------------------------ |
|
|
| default | customize button group content |
|
|
|
|
<style lang="scss">
|
|
.example-showcase {
|
|
.el-row {
|
|
margin-bottom: 20px;
|
|
align-items: baseline;
|
|
|
|
&:last-child {
|
|
margin-bottom: 0;
|
|
}
|
|
}
|
|
.el-button + .el-button {
|
|
margin-left: 10px;
|
|
}
|
|
.el-button-group {
|
|
.el-button + .el-button {
|
|
margin-left: 0;
|
|
}
|
|
|
|
& + .el-button-group {
|
|
margin-left: 10px;
|
|
}
|
|
}
|
|
}
|
|
|
|
</style>
|