引入

import Vue from 'vue';
import { ActionSheet } from 'vant';

Vue.use(ActionSheet);

代码演示

基础用法

ActionSheet通过actions数组来定义展示的选项,数组的每一项是一个对象,对象属性见文档下方表格。

<van-action-sheet v-model="show" :actions="actions" @select="onSelect" />
import { Toast } from 'vant';

export default {
  data() {
    return {
      show: false,
      actions: [
        { name: '选项' },
        { name: '选项' },
        { name: '选项', subname: '描述信息' }
      ]
    };
  },
  methods: {
    onSelect(item) {
      // 默认情况下点击选项时不会自动收起
      // 可以通过 close-on-click-action 属性开启自动收起
      this.show = false;
      Toast(item.name);
    }
  }
}

展示取消按钮

设置cancel-text属性后,会在底部展示取消按钮,点击后关闭当前菜单

<van-action-sheet
  v-model="show"
  :actions="actions"
  cancel-text="取消"
  @cancel="onCancel"
/>
import { Toast } from 'vant';

export default {
  data() {
    return {
      show: false
    };
  },
  methods: {
    onCancel() {
      this.show = false;
      Toast('cancel');
    }
  }
}

展示描述信息

设置description属性后,会在选项上方显示描述信息

<van-action-sheet
  v-model="show"
  :actions="actions"
  description="这是一段描述信息"
/>

选项状态

可以将选项设置为加载状态或禁用状态,或者通过color设置选项颜色

<van-action-sheet
  v-model="show"
  :actions="actions"
  cancel-text="取消"
  @cancel="onCancel"
/>
export default {
  data() {
    return {
      show: false,
      actions: [
        { name: '选项', color: '#07c160' },
        { loading: true },
        { name: '禁用选项', disabled: true }
      ]
    };
  }
}

自定义面板

通过插槽可以自定义菜单的展示内容,同时可以使用title属性展示标题栏

<van-action-sheet v-model="show" title="标题">
  <div class="content">内容</div>
</van-action-sheet>

<style>
.content {
  padding: 16px 16px 160px;
}
</style>

API

Props

actions菜单选项Action[][]
title顶部标题string-
cancel-text取消按钮文字string-
description v2.2.8选项上方的描述信息string-
close-icon v2.2.13关闭 图标名称 或图片链接stringcross
duration v2.0.3动画时长,单位秒number | string0.3
round v2.0.9是否显示圆角booleantrue
overlay是否显示遮罩层booleantrue
lock-scroll是否锁定背景滚动booleantrue
lazy-render是否在显示弹层时才渲染节点booleantrue
close-on-click-action是否在点击选项后关闭booleanfalse
close-on-click-overlay是否在点击遮罩层后关闭booleantrue
safe-area-inset-bottom是否开启 底部安全区适配booleantrue
get-container指定挂载的节点,用法示例string | () => Element-

Action 数据结构

actions属性为一个对象数组,数组中的每个对象配置一列,对象可以包含以下值:

name标题string
subname二级标题string
color选项文字颜色string
className为对应列添加额外的 classany
loading是否为加载状态boolean
disabled是否为禁用状态boolean

Events

select选中选项时触发,禁用或加载状态下不会触发item: 选项对应的对象, index: 选择对应的索引
cancel取消按钮点击时触发-
click-overlay点击遮罩层时触发-
open打开菜单时触发-
opened打开菜单且动画结束后触发-
close关闭菜单时触发-
closed关闭菜单且动画结束后触发-

常见问题

引入时提示 dependencies not found?

在 1.x 版本中,上拉菜单的组件名为Actionsheet,从 2.0 版本开始更名为ActionSheet,请注意区分。


实例演示

07-05 12:21