vant/packages/button/en-US.md

80 lines
1.8 KiB
Markdown

## Button
### Install
``` javascript
import { Button } from 'vant';
Vue.use(Button);
```
### Usage
#### Type
```html
<van-button type="default">Default</van-button>
<van-button type="primary">Primary</van-button>
<van-button type="warning">Warning</van-button>
<van-button type="danger">Danger</van-button>
```
#### Plain
```html
<van-button type="default" plain>Default</van-button>
<van-button type="primary" plain>Primary</van-button>
<van-button type="warning" plain>Warning</van-button>
<van-button type="danger" plain>Danger</van-button>
```
#### Size
```html
<van-button size="large">Large</van-button>
<van-button size="normal">Normal</van-button>
<van-button size="small">Small</van-button>
<van-button size="mini">Mini</van-button>
```
#### Disabled
```html
<van-button disabled>Diabled</van-button>
```
#### Loading
```html
<van-button loading />
<van-button loading type="primary" />
```
#### Custom Tag
Use `tag` prop to custom button tag
```html
<van-button tag="a" href="https://www.youzan.com" target="_blank">
Button
</van-button>
```
### API
| Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|
| type | Can be set to `primary` `warning` `danger` | `String` | `default` |
| size | Can be set to `normal` `large` `small` `mini` | `String` | `normal` |
| text | Text | `String` | - |
| tag | Tag | `String` | `button` |
| native-type | Native Type Attribute | `String` | `''` |
| plain | Whether to be plain button | `Boolean` | `false` |
| disabled | Whether to disable button | `Boolean` | `false` |
| loading | Whether show loading status | `Boolean` | `false` |
| block | Whether to set display block | `Boolean` | `false` |
### Event
| Event | Description | Arguments |
|-----------|-----------|-----------|
| click | Triggered when click button and not disabled or loading | - |