144 lines
3.8 KiB
Markdown
144 lines
3.8 KiB
Markdown
# Button
|
|
|
|
### Install
|
|
|
|
```js
|
|
import { createApp } from 'vue';
|
|
import { Button } from 'vant';
|
|
|
|
const app = createApp();
|
|
app.use(Button);
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Type
|
|
|
|
```html
|
|
<van-button type="primary">Primary</van-button>
|
|
<van-button type="success">Success</van-button>
|
|
<van-button type="default">Default</van-button>
|
|
<van-button type="danger">Danger</van-button>
|
|
<van-button type="warning">Warning</van-button>
|
|
```
|
|
|
|
### Plain
|
|
|
|
```html
|
|
<van-button plain type="primary">Primary</van-button>
|
|
<van-button plain type="primary">Danger</van-button>
|
|
```
|
|
|
|
### Hairline
|
|
|
|
```html
|
|
<van-button plain hairline type="primary">Hairline</van-button>
|
|
<van-button plain hairline type="primary">Hairline</van-button>
|
|
```
|
|
|
|
### Disabled
|
|
|
|
```html
|
|
<van-button disabled type="primary">Diabled</van-button>
|
|
<van-button disabled type="primary">Diabled</van-button>
|
|
```
|
|
|
|
### Loading
|
|
|
|
```html
|
|
<van-button loading type="primary" />
|
|
<van-button loading type="primary" loading-type="spinner" />
|
|
<van-button loading type="primary" loading-text="Loading..." />
|
|
```
|
|
|
|
### Shape
|
|
|
|
```html
|
|
<van-button square type="primary">Square</van-button>
|
|
<van-button round type="primary">Round</van-button>
|
|
```
|
|
|
|
### Icon
|
|
|
|
```html
|
|
<van-button icon="plus" type="primary" />
|
|
<van-button icon="plus" type="primary">Button</van-button>
|
|
<van-button icon="https://img.yzcdn.cn/vant/user-active.png" type="primary">
|
|
Button
|
|
</van-button>
|
|
```
|
|
|
|
### Size
|
|
|
|
```html
|
|
<van-button type="primary" size="large">Large</van-button>
|
|
<van-button type="primary" size="normal">Normal</van-button>
|
|
<van-button type="primary" size="small">Small</van-button>
|
|
<van-button type="primary" size="mini">Mini</van-button>
|
|
```
|
|
|
|
### Block Element
|
|
|
|
```html
|
|
<van-button type="primary" block>Block Element</van-button>
|
|
```
|
|
|
|
### Route
|
|
|
|
```html
|
|
<van-button type="primary" url="/vant/mobile.html">URL</van-button>
|
|
<van-button type="primary" to="index">Vue Router</van-button>
|
|
```
|
|
|
|
### Custom Color
|
|
|
|
```html
|
|
<van-button color="#7232dd">Pure</van-button>
|
|
<van-button color="#7232dd" plain>Pure</van-button>
|
|
<van-button color="linear-gradient(to right, #ff6034, #ee0a24)">
|
|
Gradient
|
|
</van-button>
|
|
```
|
|
|
|
## API
|
|
|
|
### Props
|
|
|
|
| Attribute | Description | Type | Default |
|
|
| --- | --- | --- | --- |
|
|
| type | Can be set to `primary` `success` `warning` `danger` | _string_ | `default` |
|
|
| size | Can be set to `large` `small` `mini` | _string_ | `normal` |
|
|
| text | Text | _string_ | - |
|
|
| color | Color, support linear-gradient | _string_ | - |
|
|
| icon | Left Icon | _string_ | - |
|
|
| icon-prefix `v2.6.0` | Icon className prefix | _string_ | `van-icon` |
|
|
| icon-position `v2.10.7` | Icon position, can be set to `right` | _string_ | `left` |
|
|
| tag | HTML Tag | _string_ | `button` |
|
|
| native-type | Native Type Attribute | _string_ | `button` |
|
|
| plain | Whether to be plain button | _boolean_ | `false` |
|
|
| block | Whether to set display block | _boolean_ | `false` |
|
|
| round | Whether to be round button | _boolean_ | `false` |
|
|
| square | Whether to be square button | _boolean_ | `false` |
|
|
| disabled | Whether to disable button | _boolean_ | `false` |
|
|
| loading | Whether show loading status | _boolean_ | `false` |
|
|
| loading-text | Loading text | _string_ | - |
|
|
| loading-type | Loading type, can be set to `spinner` | _string_ | `circular` |
|
|
| loading-size | Loading icon size | _string_ | `20px` |
|
|
| url | Link URL | _string_ | - |
|
|
| to | Target route of the link, same as to of vue-router | _string \| object_ | - |
|
|
| replace | If true, the navigation will not leave a history record | _boolean_ | `false` |
|
|
|
|
### Events
|
|
|
|
| Event | Description | Arguments |
|
|
| --- | --- | --- |
|
|
| click | Triggered when click button and not disabled or loading | _event: Event_ |
|
|
| touchstart | Triggered when touch start | _event: TouchEvent_ |
|
|
|
|
### Slots
|
|
|
|
| Name | Description |
|
|
| ----------------- | ------------------- |
|
|
| default | Default slot |
|
|
| loading `v2.10.1` | Custom loading icon |
|