ActionSheet 动作面板

介绍

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

引入

通过以下方式来全局注册组件,更多注册方式请参考组件注册

  1. import { createApp } from 'vue';
  2. import { ActionSheet } from 'vant';
  3. const app = createApp();
  4. app.use(ActionSheet);

代码演示

基础用法

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

  1. <van-cell is-link title="基础用法" @click="show = true" />
  2. <van-action-sheet v-model:show="show" :actions="actions" @select="onSelect" />
  1. import { ref } from 'vue';
  2. import { showToast } from 'vant';
  3. export default {
  4. setup() {
  5. const show = ref(false);
  6. const actions = [
  7. { name: '选项一' },
  8. { name: '选项二' },
  9. { name: '选项三' },
  10. ];
  11. const onSelect = (item) => {
  12. // 默认情况下点击选项时不会自动收起
  13. // 可以通过 close-on-click-action 属性开启自动收起
  14. show.value = false;
  15. showToast(item.name);
  16. };
  17. return {
  18. show,
  19. actions,
  20. onSelect,
  21. };
  22. },
  23. };

展示取消按钮

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

  1. <van-action-sheet
  2. v-model:show="show"
  3. :actions="actions"
  4. cancel-text="取消"
  5. close-on-click-action
  6. @cancel="onCancel"
  7. />
  1. import { ref } from 'vue';
  2. import { showToast } from 'vant';
  3. export default {
  4. setup() {
  5. const show = ref(false);
  6. const actions = [
  7. { name: '选项一' },
  8. { name: '选项二' },
  9. { name: '选项三' },
  10. ];
  11. const onCancel = () => showToast('取消');
  12. return {
  13. show,
  14. actions,
  15. onCancel,
  16. };
  17. },
  18. };

展示描述信息

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

  1. <van-action-sheet
  2. v-model:show="show"
  3. :actions="actions"
  4. cancel-text="取消"
  5. description="这是一段描述信息"
  6. close-on-click-action
  7. />
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const show = ref(false);
  5. const actions = [
  6. { name: '选项一' },
  7. { name: '选项二' },
  8. { name: '选项三', subname: '描述信息' },
  9. ];
  10. return {
  11. show,
  12. actions,
  13. };
  14. },
  15. };

选项状态

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

  1. <van-action-sheet
  2. v-model:show="show"
  3. :actions="actions"
  4. cancel-text="取消"
  5. close-on-click-action
  6. />
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const show = ref(false);
  5. const actions = [
  6. { name: '着色选项', color: '#ee0a24' },
  7. { name: '禁用选项', disabled: true },
  8. { name: '加载选项', loading: true },
  9. ];
  10. return {
  11. show,
  12. actions,
  13. };
  14. },
  15. };

自定义面板

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

  1. <van-action-sheet v-model:show="show" title="标题">
  2. <div class="content">内容</div>
  3. </van-action-sheet>
  4. <style>
  5. .content {
  6. padding: 16px 16px 160px;
  7. }
  8. </style>

API

Props

参数说明类型默认值
v-model:show是否显示动作面板booleanfalse
actions面板选项列表ActionSheetAction[][]
title顶部标题string-
cancel-text取消按钮文字string-
description选项上方的描述信息string-
closeable是否显示关闭图标booleantrue
close-icon关闭图标名称或图片链接,等同于 Icon 组件的 name 属性stringcross
duration动画时长,单位秒,设置为 0 可以禁用动画number | string0.3
z-index将面板的 z-index 层级设置为一个固定值number | string2000+
round是否显示圆角booleantrue
overlay是否显示遮罩层booleantrue
overlay-class自定义遮罩层类名string | Array | object-
overlay-style自定义遮罩层样式object-
lock-scroll是否锁定背景滚动booleantrue
lazy-render是否在显示弹层时才渲染节点booleantrue
close-on-popstate是否在页面回退时自动关闭booleantrue
close-on-click-action是否在点击选项后关闭booleanfalse
close-on-click-overlay是否在点击遮罩层后关闭booleantrue
safe-area-inset-bottom是否开启底部安全区适配booleantrue
teleport指定挂载的节点,等同于 Teleport 组件的 to 属性string | Element-
before-close v3.1.4关闭前的回调函数,返回 false 可阻止关闭,支持返回 Promise(action: string) => boolean | Promise<boolean>-

Action 数据结构

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

键名说明类型
name标题string
subname二级标题string
color选项文字颜色string
className为对应列添加额外的 classstring | Array | object
loading是否为加载状态boolean
disabled是否为禁用状态boolean
callback点击时触发的回调函数action: ActionSheetAction

Events

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

Slots

名称说明参数
default自定义面板的展示内容-
description自定义描述文案-
cancel v3.0.10自定义取消按钮内容-
action v3.4.0自定义选项内容{ action: ActionSheetAction, index: number }

类型定义

组件导出以下类型定义:

  1. import type { ActionSheetProps, ActionSheetAction } from 'vant';

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
—van-action-sheet-max-height80%-
—van-action-sheet-header-height48px-
—van-action-sheet-header-font-sizevar(—van-font-size-lg)-
—van-action-sheet-description-colorvar(—van-text-color-2)-
—van-action-sheet-description-font-sizevar(—van-font-size-md)-
—van-action-sheet-description-line-heightvar(—van-line-height-md)-
—van-action-sheet-item-backgroundvar(—van-background-2)-
—van-action-sheet-item-font-sizevar(—van-font-size-lg)-
—van-action-sheet-item-line-heightvar(—van-line-height-lg)-
—van-action-sheet-item-text-colorvar(—van-text-color)-
—van-action-sheet-item-disabled-text-colorvar(—van-text-color-3)-
—van-action-sheet-subname-colorvar(—van-text-color-2)-
—van-action-sheet-subname-font-sizevar(—van-font-size-sm)-
—van-action-sheet-subname-line-heightvar(—van-line-height-sm)-
—van-action-sheet-close-icon-size22px-
—van-action-sheet-close-icon-colorvar(—van-gray-5)-
—van-action-sheet-close-icon-padding0 var(—van-padding-md)-
—van-action-sheet-cancel-text-colorvar(—van-gray-7)-
—van-action-sheet-cancel-padding-topvar(—van-padding-xs)-
—van-action-sheet-cancel-padding-colorvar(—van-background)-
—van-action-sheet-loading-icon-size22px-

ActionSheet 动作面板 - 图1