当前位置: 首页 > 文档资料 > Vant 中文文档 >

ActionSheet 动作面板

优质
小牛编辑
206浏览
2023-12-01

介绍

底部弹起的模态面板,包含与当前情境相关的多个选项。

引入

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

const app = createApp();
app.use(ActionSheet);

代码演示

基础用法

动作面板通过 actions 属性来定义选项,actions 属性是一个由对象构成的数组,数组中的每个对象配置一列,对象格式见文档下方表格。

<van-cell is-link title="基础用法" @click="show = true" />
<van-action-sheet v-model:show="show" :actions="actions" @select="onSelect" />
import { Toast } from 'vant';

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

展示取消按钮

设置 cancel-text 属性后,会在底部展示取消按钮,点击后关闭当前面板并触发 cancel 事件。

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

export default {
  data() {
    return {
      show: false,
      actions: [{ name: '选项一' }, { name: '选项二' }, { name: '选项三' }],
    };
  },
  methods: {
    onCancel() {
      Toast('取消');
    },
  },
};

展示描述信息

通过 description 可以在菜单顶部显示描述信息,通过选项的 subname 属性可以在选项文字的右侧展示描述信息。

<van-action-sheet
  v-model:show="show"
  :actions="actions"
  cancel-text="取消"
  description="这是一段描述信息"
  close-on-click-action
/>
export default {
  data() {
    return {
      show: false,
      actions: [
        { name: '选项一' },
        { name: '选项二' },
        { name: '选项三', subname: '描述信息' },
      ],
    };
  },
};

选项状态

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

<van-action-sheet
  v-model:show="show"
  :actions="actions"
  cancel-text="取消"
  close-on-click-action
/>
export default {
  data() {
    return {
      show: false,
      actions: [
        { name: '着色选项', color: '#ee0a24' },
        { name: '禁用选项', disabled: true },
        { name: '加载选项', loading: true },
      ],
    };
  },
};

自定义面板

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

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

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

API

Props

参数说明类型默认值
v-model:show是否显示动作面板booleanfalse
actions面板选项列表Action[][]
title顶部标题string-
cancel-text取消按钮文字string-
description选项上方的描述信息string-
closeable v2.10.5是否显示关闭图标booleantrue
close-icon关闭图标名称或图片链接stringcross
duration动画时长,单位秒number / string0.3
round是否显示圆角booleantrue
overlay是否显示遮罩层booleantrue
lock-scroll是否锁定背景滚动booleantrue
lazy-render是否在显示弹层时才渲染节点booleantrue
close-on-popstate v2.5.3是否在页面回退时自动关闭booleanfalse
close-on-click-action是否在点击选项后关闭booleanfalse
close-on-click-overlay是否在点击遮罩层后关闭booleantrue
safe-area-inset-bottom是否开启底部安全区适配booleantrue
teleport指定挂载的节点,用法示例string / Element-

Action 数据结构

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

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

Events

事件名说明回调参数
select点击选项时触发,禁用或加载状态下不会触发action: Action, index: number
cancel点击取消按钮时触发-
open打开面板时触发-
close关闭面板时触发-
opened打开面板且动画结束后触发-
closed关闭面板且动画结束后触发-
click-overlay点击遮罩层时触发-

Slots

名称说明
default自定义面板的展示内容
description v2.10.4自定义描述文案

常见问题

引入时提示 dependencies not found?

在 1.x 版本中,动作面板的组件名为Actionsheet,从 2.0 版本开始更名为ActionSheet,请注意区分。