跳到主要内容
版本：v8

@capacitor/action-sheet

Action Sheet API 提供对原生操作表的访问，操作表从屏幕底部出现并显示用户可以执行的操作。

安装​

npm install @capacitor/action-sheet
npx cap sync

变量​

此插件将使用以下项目变量（定义在你的应用 variables.gradle 文件中）：

  • androidxMaterialVersion: com.google.android.material:material 的版本（默认值：1.13.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
ShowActionsOptions

返回值： 

Promise<ShowActionsResult>

自版本： 1.0.0

接口​

ShowActionsResult​

属性类型描述版本
indexnumber被点击选项的索引（从0开始），如果操作表被取消则为 -1。在 iOS 上，如果存在带有 ActionSheetButtonStyle.Cancel 样式的按钮，并且用户点击了操作表外部，则返回取消按钮的索引。1.0.0
canceledboolean如果用户取消了操作表则为 true；否则为 false。在 Web 上，需要使用 @ionic/pwa-elements 版本 3.4.0 或更高版本。8.1.0

ShowActionsOptions​

属性类型描述默认值版本
titlestring操作表的标题。1.0.0
messagestring在标题下方显示的消息。此选项仅在 iOS 上受支持。1.0.0
optionsActionSheetButton[]用户可以选择的选项。1.0.0
cancelableboolean如果为 true，点击外部会取消操作表；如果为 false，则不会。在 iOS 上，如果存在带有 ActionSheetButtonStyle.Cancel 样式的按钮，或者在 iOS 26+ 上，此选项不可用。在这些情况下，点击操作表外部总是会取消它。在 Web 上，需要使用 @ionic/pwa-elements 版本 3.4.0 或更高版本。false8.1.0

ActionSheetButton​

属性类型描述版本
titlestring选项的标题1.0.0
style
ActionSheetButtonStyle
选项的样式。此选项仅在 iOS 上受支持。1.0.0
iconstring选项的图标（使用 ionicon 命名规范）。此选项仅在 Web 上受支持。1.0.0

枚举​

ActionSheetButtonStyle​

枚举值值描述版本
Default'DEFAULT'默认按钮样式。1.0.0
Cancel'CANCEL'取消按钮样式，用于指示操作将取消当前操作并返回先前的状态。在 iOS 上，此样式会使按钮以粗体显示。1.0.0
Destructive'DESTRUCTIVE'破坏性按钮样式，用于指示操作可能改变或删除数据。1.0.0

ActionSheetButtonStyle​

成员值描述始于
Default'DEFAULT'选项的默认样式。1.0.0
Destructive'DESTRUCTIVE'用于具有破坏性操作的选项的样式。1.0.0
Cancel'CANCEL'用于取消操作表的选项的样式。如果使用，应将其置于最后一个可用选项上。在 iOS 26+ 系统上不会显示此选项，操作表可通过点击外部区域取消。1.0.0

Contents

编辑此页