ActionSheet 动作面板
介绍
底部弹起的模态面板,包含与当前情境相关的多个选项。
代码演示
基础用法
动作面板通过 actions
属性来定义选项,actions
属性是一个由对象构成的数组,数组中的每个对象配置一列,对象格式见文档下方表格。
<z-cell is-link title="基础用法" @click="show = true" />
<z-action-sheet v-model:show="show" :actions="actions" @select="onSelect" />
import { ref, computed } from 'vue'
import { useToast } from '../../uni_modules/zebra-ui'
const toast = useToast()
const show = ref(false);
const actions = [
{ name: '选项一' },
{ name: '选项二' },
{ name: '选项三' },
];
const onSelect = (item) => {
// 默认情况下点击选项时不会自动收起
// 可以通过 close-on-click-action 属性开启自动收起
show.value = false;
toast.showToast(item.name);
};
展示取消按钮
设置 cancel-text
属性后,会在底部展示取消按钮,点击后关闭当前面板并触发 cancel
事件。
<z-action-sheet
v-model:show="show"
:actions="actions"
cancel-text="取消"
close-on-click-action
@cancel="onCancel"
/>
const onCancel = () => toast.showToast('取消')
展示描述信息
通过 description
可以在菜单顶部显示描述信息,通过选项的 subname
属性可以在选项文字的右侧展示描述信息。
<z-action-sheet
v-model:show="show"
:actions="actions"
cancel-text="取消"
description="这是一段描述信息"
close-on-click-action
/>
import { ref } from 'vue';
const actions = [
{ name: '选项一' },
{ name: '选项二' },
{ name: '选项三', subname: '描述信息' },
];
选项状态
可以通过 loading
和 disabled
将选项设置为加载状态或禁用状态,或者通过color
设置选项的颜色
<z-action-sheet
v-model:show="show"
:actions="actions"
cancel-text="取消"
close-on-click-action
/>
import { ref } from 'vue';
const actions = [
{ name: '着色选项', color: '#ee0a24' },
{ name: '禁用选项', disabled: true },
{ name: '加载选项', loading: true },
];
自定义面板
通过插槽可以自定义面板的展示内容,同时可以使用title
属性展示标题栏
<z-action-sheet v-model:show="showTitle" title="标题">
<view class="demo-action-sheet-content">内容</view>
</z-action-sheet>
<style>
.demo-action-sheet {
&-content {
padding: var(--z-padding-md) var(--z-padding-md)
calc(var(--z-padding-md) * 10);
}
}
</style>
API
Props
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
v-model:show | 是否显示动作面板 | boolean | false |
actions | 面板选项列表 | ActionSheetAction | [] |
title | 顶部标题 | string | - |
cancel-text | 取消按钮文字 | string | - |
description | 选项上方的描述信息 | string | - |
closeable | 是否显示关闭图标 | boolean | true |
close-icon | 关闭图标名称或图片链接,等同于 Icon 组件的 name 属性 | string | close |
duration | 动画时长,单位毫秒,设置为 0 可以禁用动画 | number | string | 300 |
z-index | 将面板的 z-index 层级设置为一个固定值 | number | string | 2000+ |
round | 是否显示圆角 | boolean | true |
overlay | 是否显示遮罩层 | boolean | true |
overlay-class | 自定义遮罩层类名 | string | Array | object | - |
overlay-style | 自定义遮罩层样式 | object | - |
lock-scroll | 是否锁定背景滚动 | boolean | true |
close-on-click-action | 是否在点击选项后关闭 | boolean | false |
close-on-click-overlay | 是否在点击遮罩层后关闭 | boolean | true |
safe-area-inset-bottom | 是否开启底部安全区适配 | boolean | true |
before-close | 关闭前的回调函数,返回 false 可阻止关闭,支持返回 Promise | (action: string) => boolean | Promise<boolean> | - |
Action 数据结构
actions
属性是一个由对象构成的数组,数组中的每个对象配置一列,对象可以包含以下值:
键名 | 说明 | 类型 |
---|---|---|
name | 标题 | string |
subname | 二级标题 | string |
color | 选项文字颜色 | string |
className | 为对应列添加额外的 class | string | 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 | 自定义取消按钮内容 | - |
action | 自定义选项内容 | { action: ActionSheetAction, index: number } |
主题定制
样式变量
组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件。
名称 | 默认值 | 描述 |
---|---|---|
--z-action-sheet-max-height | 80% | - |
--z-action-sheet-header-height | 96rpx | - |
--z-action-sheet-header-font-size | var(--z-font-size-lg) | - |
--z-action-sheet-description-color | var(--z-text-color-2) | - |
--z-action-sheet-description-font-size | var(--z-font-size-md) | - |
--z-action-sheet-description-line-height | var(--z-line-height-md) | - |
--z-action-sheet-item-background | var(--z-background-2) | - |
--z-action-sheet-item-font-size | var(--z-font-size-lg) | - |
--z-action-sheet-item-line-height | var(--z-line-height-lg) | - |
--z-action-sheet-item-text-color | var(--z-text-color) | - |
--z-action-sheet-item-disabled-text-color | var(--z-text-color-3) | - |
--z-action-sheet-subname-color | var(--z-text-color-2) | - |
--z-action-sheet-subname-font-size | var(--z-font-size-sm) | - |
--z-action-sheet-subname-line-height | var(--z-line-height-sm) | - |
--z-action-sheet-close-icon-size | 44rpx | - |
--z-action-sheet-close-icon-color | var(--z-gray-5) | - |
--z-action-sheet-close-icon-padding | 0 var(--z-padding-md) | - |
--z-action-sheet-cancel-text-color | var(--z-gray-7) | - |
--z-action-sheet-cancel-padding-top | var(--z-padding-xs) | - |
--z-action-sheet-cancel-padding-color | var(--z-background) | - |
--z-action-sheet-loading-icon-size | 44rpx | - |