@capacitor/action-sheet
Action Sheet API 提供对原生操作表的访问,这些操作表从屏幕底部弹出,显示用户可以执行的操作。
安装
npm install @capacitor/action-sheet@latest-6
npx cap sync
变量
此插件将使用以下项目变量(在您应用的 variables.gradle 文件中定义):
androidxMaterialVersion:com.google.android.material:material的版本(默认值:1.10.0)
PWA 说明
Action Sheet 插件需要 PWA Elements 才能正常工作。
示例
import { ActionSheet, ActionSheetButtonStyle } from '@capacitor/action-sheet';
const showActions = async () => {
const result = await ActionSheet.showActions({
title: '照片选项',
message: '选择一个要执行的操作',
options: [
{
title: '上传',
},
{
title: '分享',
},
{
title: '删除',
style: ActionSheetButtonStyle.Destructive,
},
],
});
console.log('操作表结果:', result);
};
API
showActions(...)
showActions(options: ShowActionsOptions) => Promise<ShowActionsResult>
显示一个操作表样式的模态框,其中包含用户可以选择的各种选项。
| 参数 | 类型 |
|---|---|
options | |
返回值:
Promise<ShowActionsResult>
自: 1.0.0
接口
ShowActionsResult
| 属性 | 类型 | 描述 | 自 |
|---|---|---|---|
index | number | 被点击选项的索引(从 0 开 始) | 1.0.0 |
ShowActionsOptions
| 属性 | 类型 | 描述 | 自 |
|---|---|---|---|
title | string | 操作表的标题。 | 1.0.0 |
message | string | 显示在标题下方的消息。此选项仅在 iOS 上受支持。 | 1.0.0 |
options | ActionSheetButton[] | 用户可以从中选择的选项。 | 1.0.0 |
ActionSheetButton
| 属性 | 类型 | 描述 | 自 |
|---|---|---|---|
title | string | 选项的标题 | 1.0.0 |
style | | 选项的样式。此选项仅在 iOS 上受支持。 | 1.0.0 |
icon | string | 选项的图标(使用 ionicon 命名约定)。此选项仅在 Web 上受支持。 | 1.0.0 |
枚举
ActionSheetButtonStyle
| 成员 | 值 | 描述 | 自 |
|---|---|---|---|
Default | 'DEFAULT' | 选项的默认样式。 | 1.0.0 |
Destructive | 'DESTRUCTIVE' | 用于破坏性选项的样式。 | 1.0.0 |
Cancel | 'CANCEL' | 用于取消操作表的选项的样式。如果使用,应放在最后一个可用的选项上。 | 1.0.0 |