mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
105 lines
2.0 KiB
Markdown
105 lines
2.0 KiB
Markdown
## Actionsheet
|
|
|
|
### Install
|
|
``` javascript
|
|
import { Actionsheet } from 'vant';
|
|
|
|
Vue.use(Actionsheet);
|
|
```
|
|
|
|
### Usage
|
|
|
|
#### Basic Usage
|
|
Use `actions` prop to set options of actionsheet.
|
|
|
|
```html
|
|
<van-actionsheet
|
|
v-model="show"
|
|
:actions="actions"
|
|
@select="onSelect"
|
|
/>
|
|
```
|
|
|
|
```javascript
|
|
export default {
|
|
data() {
|
|
return {
|
|
show: false,
|
|
actions: [
|
|
{
|
|
name: 'Option'
|
|
},
|
|
{
|
|
name: 'Option',
|
|
description: 'Description'
|
|
},
|
|
{
|
|
loading: true
|
|
},
|
|
{
|
|
name: 'Disabled Option',
|
|
disabled: true
|
|
}
|
|
]
|
|
};
|
|
},
|
|
|
|
methods: {
|
|
onSelect(item) {
|
|
this.show = false;
|
|
Toast(item.name);
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
#### Actionsheet with cancel button
|
|
|
|
```html
|
|
<van-actionsheet
|
|
v-model="show"
|
|
:actions="actions"
|
|
cancel-text="Cancel"
|
|
@select="onSelect"
|
|
@cancel="onCancel"
|
|
/>
|
|
```
|
|
|
|
#### Actionsheet with title
|
|
Actionsheet will get another style if there is a `title` prop.
|
|
|
|
```html
|
|
<van-actionsheet v-model="show" title="Title">
|
|
<p>Content</p>
|
|
</van-actionsheet>
|
|
```
|
|
|
|
### API
|
|
|
|
| Attribute | Description | Type | Default |
|
|
|------|------|------|------|
|
|
| actions | Options | `Array` | `[]` |
|
|
| title | Title | `String` | - |
|
|
| cancel-text | Text of cancel button | `String` | - |
|
|
| overlay | Whether to show overlay | `Boolean` | `true` |
|
|
| close-on-click-overlay | Whether to close when click overlay | `Boolean` | `true` |
|
|
| lazy-render | Whether to lazy render util appeared | `Boolean` | `true` |
|
|
| get-container | Return the mount node for actionsheet | `String | () => HTMLElement` | - |
|
|
|
|
### Event
|
|
|
|
| Event | Description | Arguments |
|
|
|------|------|------|
|
|
| select | Triggered when click option | item |
|
|
| cancel | Triggered when cancel click | - |
|
|
|
|
### Data struct of actions
|
|
|
|
| key | Description |
|
|
|------|------|
|
|
| name | Title |
|
|
| subname | Subtitle |
|
|
| className | className for the option |
|
|
| loading | Whether to be loading status |
|
|
| disabled | Whether to be disabled |
|