element/examples/docs/button.md

193 lines
6.4 KiB
Markdown
Raw Normal View History

2016-07-27 06:15:02 +00:00
<script>
export default {
data() {
return {
isLoading: false,
isLoading2: false
};
},
methods: {
handleClick(event) {
console.log(event);
alert('button clicked!');
}
}
}
</script>
<style>
.demo-box.demo-button {
.el-button + .el-button {
margin-left: 10px;
}
.el-button-group {
margin-bottom: 20px;
.el-button + .el-button {
margin-left: 0;
}
}
}
</style>
## 基础用法
2016-08-18 09:29:11 +00:00
Button 组件默认提供7种主题由`type`属性来定义,默认为`default`
2016-07-27 06:15:02 +00:00
<div class="demo-box demo-button">
<el-button>Default</el-button>
<el-button type="primary">primary</el-button>
<el-button type="success">success</el-button>
<el-button type="warning">warning</el-button>
<el-button type="danger">danger</el-button>
<el-button type="info">info</el-button>
<el-button type="text">text button</el-button>
</div>
你可以使用`disabled`属性来定义按钮是否可用,它接受一个`Boolean`值:
<div class="demo-box demo-button">
<el-button>Default</el-button>
<el-button :disabled="true">disabled</el-button>
</div>
下面是他们的样例代码:
2016-07-27 06:15:02 +00:00
```html
<el-button>Default</el-button>
<el-button type="primary">primary</el-button>
<el-button type="success">success</el-button>
<el-button type="warning">warning</el-button>
<el-button type="danger">danger</el-button>
<el-button type="info">info</el-button>
<el-button type="text">text button</el-button>
<el-button :disabled="true">disabled</el-button>
2016-07-27 06:15:02 +00:00
```
## Plain Button
默认的`Default`主题,我们称之为朴素按钮(Plain Button),朴素按钮同样设置了不同的`type`属性对应的样式(可选值同上),默认为`info`。
设置`plain`属性,它接受一个`Boolean`。
注意,在该情况下,`type`虽然可以为`text`,但是是没有意义的,会显示为`text button`的样式。
2016-08-18 09:29:11 +00:00
你可以 Hover 在样例上进行预览:
2016-07-27 06:15:02 +00:00
<div class="demo-box demo-button">
<el-button :plain="true">Default</el-button>
<el-button :plain="true" type="success">success</el-button>
<el-button :plain="true" type="warning">warning</el-button>
<el-button :plain="true" type="danger">danger</el-button>
<el-button :plain="true" :disabled="true">disabled</el-button>
</div>
```html
<el-button :plain="true">Default</el-button>
<el-button :plain="true" type="success">success</el-button>
<el-button :plain="true" type="warning">warning</el-button>
<el-button :plain="true" type="danger">danger</el-button>
<el-button :plain="true" :disabled="true">disabled</el-button>
```
## 尺寸
2016-08-18 09:29:11 +00:00
Button 组件提供除了默认值以外的三种尺寸:`large`、`small`、`mini`来满足不同的需求,通过设置`size`属性来配置它们。
2016-07-27 06:15:02 +00:00
<div class="demo-box demo-button">
<el-button type="primary" size="large">large</el-button>
<el-button type="primary">Default</el-button>
<el-button type="primary" size="small">small</el-button>
<el-button type="primary" size="mini">mini</el-button>
</div>
```html
<el-button type="primary" size="large">large</el-button>
<el-button type="primary">Default</el-button>
<el-button type="primary" size="small">small</el-button>
<el-button type="primary" size="mini">mini</el-button>
```
## Loading
2016-08-18 09:29:11 +00:00
Button 组件提供的`loading`属性可以方便的让你处理 loading 状态,它接受一个`Boolean`,要设置为 loading 状态,只要设置`loading`属性为`true`即可,下面是一个样例:
2016-07-27 06:15:02 +00:00
<div class="demo-box demo-button">
<el-button type="primary" :loading="true">Button</el-button>
</div>
点击后变成 loading 状态的样例,尝试点击它:
2016-07-27 06:15:02 +00:00
<div class="demo-box demo-button">
<el-button type="primary" :loading="isLoading" @click.native="isLoading = true">Button</el-button>
<el-button type="primary" icon="search" :loading="isLoading2" @click.native="isLoading2 = true">Button</el-button>
2016-07-27 06:15:02 +00:00
</div>
```html
<el-button type="primary" :loading="true">Button</el-button>
<el-button type="primary" :loading="isLoading" @click.native="isLoading = true">Button</el-button>
<el-button type="primary" icon="search" :loading="isLoading2" @click.native="isLoading2 = true">Button</el-button>
2016-07-27 06:15:02 +00:00
```
## 图标按钮
2016-08-18 09:29:11 +00:00
理所当然的Element 也支持图标按钮,设置`icon`属性即可icon 的列表可以参考 Element 的 icon 组件,下面是简单的预览:
2016-07-27 06:15:02 +00:00
<div class="demo-box demo-button">
<el-button type="primary" icon="edit"></el-button>
<el-button type="primary" icon="search">Search</el-button>
</div>
2016-08-19 06:45:08 +00:00
除此以外,你也可以设置在文字右边的 icon ,只要使用`i`标签即可,使用图标组件来实现它,由此,你可以使用自己的图标了:
<div class="demo-box demo-button">
2016-07-27 06:15:02 +00:00
<el-button type="primary">Upload<i class="el-icon-upload el-icon-right"></i></el-button>
</div>
```html
<el-button type="primary" icon="edit"></el-button>
<el-button type="primary" icon="search">Search</el-button>
<el-button type="primary">Upload<i class="el-icon-upload el-icon-right"></i></el-button>
```
## 按钮组
如果你需要多个并列的按钮,按钮组可以帮你轻松的实现它,使用`<el-button-group>`标签来嵌套你的按钮即可。
2016-07-27 06:15:02 +00:00
<div class="demo-box demo-button">
<el-button-group>
<el-button>Button</el-button>
<el-button>Button</el-button>
<el-button>Button</el-button>
</el-button-group>
<div></div>
<el-button-group>
<el-button type="primary" icon="edit"></el-button>
<el-button type="primary" icon="share"></el-button>
<el-button type="primary" icon="delete"></el-button>
</el-button-group>
</div>
```html
<el-button-group>
<el-button>Button</el-button>
<el-button>Button</el-button>
<el-button>Button</el-button>
</el-button-group>
<div></div>
<el-button-group>
<el-button type="primary" icon="edit"></el-button>
<el-button type="primary" icon="share"></el-button>
<el-button type="primary" icon="delete"></el-button>
</el-button-group>
```
## Attributes
2016-07-27 06:15:02 +00:00
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---------- |-------- |---------- |------------- |-------- |
| size | 尺寸 | string | large,small,mini | |
| type | 类型 | string | primary,success,warning,danger,info,text | |
| plain | 是否朴素按钮 | Boolean | true,false | false |
| disabled | 禁用 | boolean | true, false | false |
| icon | 图标,已有的图标库中的图标名 | string | | |