Skip to content

ActionSheet 动作面板

介绍

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

基础用法

通过 v-model 控制展示,通过 options 配置操作项。

html
<vd-action-sheet v-model="show" :options="options" />
ts
import type { ActionSheetOption } from 'vital-design';

const show = ref(false);
const options: ActionSheetOption[] = [
  { title: '选项一' },
  { title: '选项二' },
  { title: '选项三' },
];

展示取消按钮

通过 cancel-show 展示取消按钮。

html
<vd-action-sheet
  v-model="show"
  :options="options"
  cancel-show
/>

展示标题与描述

通过 titledescription 设置标题与描述信息。

html
<vd-action-sheet
  v-model="show"
  title="标题"
  description="描述信息"
  :options="options"
  cancel-show
/>

API

Props

参数说明类型默认值
v-model是否展示boolean-
title标题string-
description描述string-
options操作项ActionSheetOption[][]
cancel-show是否展示取消按钮booleanfalse
cancel-text取消按钮文本string-
round是否显示圆角booleantrue
overlay是否展示遮罩层booleantrue
overlay-class遮罩层类名ClassValue-
overlay-style遮罩层样式StyleValue-
close-on-click-overlay点击遮罩层时关闭booleantrue
z-index层级string | number2001+
lazy-render是否懒渲染booleantrue
lock-scroll是否锁定背景booleantrue

代替原始 Props

参数说明类型默认值
custom-id根节点 idstring-
custom-class根节点类名ClassValue-
custom-style根节点样式StyleValue-

Events

事件名说明回调参数
click点击时触发MouseEvent
update:model-value展示状态更新时触发boolean
open打开时触发-
opened打开动画结束时触发-
close关闭时触发-
closed关闭动画结束时触发-
click-overlay点击遮罩时触发MouseEvent
click-option点击操作项时触发ActionSheetOnClickOptionEvent
click-cancel点击取消按钮时触发MouseEvent

Slots

名称说明
title标题
description描述
default操作项列表
option自定义操作项,作用域参数 optionindex
option-loading操作项加载中
option-icon操作项图标
option-text操作项文本
cancel取消按钮

类型定义

组件导出以下类型定义:

ts
import type {
  ActionSheetOption,
  ActionSheetOnClickOptionEvent,
} from 'vital-design';

赣ICP备2025061025号-1