版本：v7

ion-action-sheet

操作表（Action Sheet）是一种显示一组选项的对话框。它出现在应用内容的上方，用户必须手动关闭它才能继续与应用交互。在 ios 模式下，破坏性选项会以明显的方式呈现。有多种方式可以关闭操作表，包括点击背景或在桌面上按下 Esc 键。

内联操作表（推荐）

直接在模板中编写 ion-action-sheet 组件即可使用内联操作表。这减少了呈现操作表时需要连接的处理程序数量。

使用 `isOpen` 属性

ion-action-sheet 上的 isOpen 属性允许开发者通过应用程序状态控制操作表的呈现状态。这意味着当 isOpen 设置为 true 时，操作表将呈现；当 isOpen 设置为 false 时，操作表将被关闭。

isOpen 使用单向数据绑定，这意味着当操作表关闭时，它不会自动设置为 false。开发者应监听 ionActionSheetDidDismiss 或 didDismiss 事件，并将 isOpen 设置为 false。这样做的原因是防止 ion-action-sheet 的内部逻辑与应用程序状态紧密耦合。使用单向数据绑定，操作表只需关注响应式变量提供的布尔值。而使用双向数据绑定，操作表需要同时关注布尔值以及响应式变量本身的存在。这可能导致不确定的行为，并使应用程序更难以调试。

控制器操作表

在需要对操作表的呈现和关闭时机进行更多控制的情况下，可以使用 actionSheetController。

按钮

按钮的 role 属性可以是 destructive 或 cancel。没有 role 属性的按钮将默认采用平台的样式。具有 cancel 角色的按钮将始终显示为底部按钮，无论它们在数组中的位置如何。所有其他按钮将按照它们添加到 buttons 数组中的顺序显示。注意：我们建议将 destructive 按钮始终放在数组的第一个位置，使其成为顶部按钮。此外，如果通过点击背景关闭操作表，则会触发具有 cancel 角色的按钮的处理程序。

还可以通过 ActionSheetButton 上的 data 属性向按钮传递数据。这将填充 onDidDismiss 方法返回值的 data 字段。

关闭时收集角色信息

当触发 didDismiss 事件时，可以使用事件详情中的 data 和 role 字段来收集有关操作表关闭方式的信息。

Console

Console messages will appear here when logged from the example above.

主题

操作表使用作用域封装（scoped encapsulation），这意味着它会在运行时通过为每个样式附加一个额外的类来自动限定其 CSS 的作用域。在 CSS 中覆盖作用域选择器需要更高的特异性选择器。

样式设置

我们建议在 create 方法中向 cssClass 传递一个自定义类，并使用该类为主机和内部元素添加自定义样式。此属性还可以接受多个以空格分隔的类。

/* 不起作用 - 特异性不足 */
.action-sheet-group {
  background: #e5e5e5;
}

/* 有效 - 在 cssClass 中传递 "my-custom-class" 以提高特异性 */
.my-custom-class .action-sheet-group {
  background: #e5e5e5;
}

CSS 自定义属性

可以使用任何已定义的 CSS 自定义属性来设置操作表的样式，而无需针对单个元素。

可访问性

屏幕阅读器

操作表设置了 aria 属性，以便对屏幕阅读器具有可访问性，但如果这些属性描述不够充分或与操作表在应用中的使用方式不一致，可以覆盖这些属性。

角色（Role）

操作表被赋予 dialog 的 role。为了符合 ARIA 规范，必须设置 aria-label 或 aria-labelledby 属性。

操作表描述

强烈建议为每个操作表定义 header 属性，因为 Ionic 会自动将 aria-labelledby 指向标题元素。但是，如果选择不包含 header，另一种方法是使用 htmlAttributes 属性提供描述性的 aria-label 或设置自定义的 aria-labelledby 值。

Angular
Javascript
React
Vue

const actionSheet = await this.actionSheetController.create({
  htmlAttributes: {
    'aria-label': '操作表对话框',
  },
});

const actionSheet = await this.actionSheetController.create({
  htmlAttributes: {
    'aria-label': '操作表对话框',
  },
});

useIonActionSheet({
  htmlAttributes: {
    'aria-label': '操作表对话框',
  },
});

const actionSheet = await actionSheetController.create({
  htmlAttributes: {
    'aria-label': '操作表对话框',
  },
});

操作表按钮描述

包含文本的按钮将被屏幕阅读器读取。如果按钮仅包含图标，或者需要除现有文本之外的其他描述，应通过向按钮的 htmlAttributes 属性传递 aria-label 来为按钮分配标签。

Angular
Javascript
React
Vue

const actionSheet = await this.actionSheetController.create({
  header: '标题',
  buttons: [
    {
      icon: 'close',
      htmlAttributes: {
        'aria-label': '关闭',
      },
    },
  ],
});

const actionSheet = await this.actionSheetController.create({
  header: '标题',
  buttons: [
    {
      icon: 'close',
      htmlAttributes: {
        'aria-label': '关闭',
      },
    },
  ],
});

useIonActionSheet({
  header: '标题',
  buttons: [
    {
      icon: 'close',
      htmlAttributes: {
        'aria-label': '关闭',
      },
    },
  ],
});

const actionSheet = await actionSheetController.create({
  header: '标题',
  buttons: [
    {
      icon: 'close',
      htmlAttributes: {
        'aria-label': '关闭',
      },
    },
  ],
});

接口

ActionSheetButton

interface ActionSheetButton<T = any> {
  text?: string;
  role?: 'cancel' | 'destructive' | 'selected' | string;
  icon?: string;
  cssClass?: string | string[];
  id?: string;
  htmlAttributes?: { [key: string]: any };
  handler?: () => boolean | void | Promise<boolean | void>;
  data?: T;
}

ActionSheetOptions

interface ActionSheetOptions {
  header?: string;
  subHeader?: string;
  cssClass?: string | string[];
  buttons: (ActionSheetButton | string)[];
  backdropDismiss?: boolean;
  translucent?: boolean;
  animated?: boolean;
  mode?: Mode;
  keyboardClose?: boolean;
  id?: string;
  htmlAttributes?: { [key: string]: any };

  enterAnimation?: AnimationBuilder;
  leaveAnimation?: AnimationBuilder;
}

属性

animated

Description	If `true`, the action sheet will animate.
Attribute	`animated`
Type	`boolean`
Default	`true`

backdropDismiss

Description	If `true`, the action sheet will be dismissed when the backdrop is clicked.
Attribute	`backdrop-dismiss`
Type	`boolean`
Default	`true`

buttons

Description	An array of buttons for the action sheet.
Attribute	`undefined`
Type	`(string ｜ ActionSheetButton<any>)[]`
Default	`[]`

cssClass

Description	Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces.
Attribute	`css-class`
Type	`string ｜ string[] ｜ undefined`
Default	`undefined`

enterAnimation

Description	Animation to use when the action sheet is presented.
Attribute	`undefined`
Type	`((baseEl: any, opts?: any) => Animation) ｜ undefined`
Default	`undefined`

Description	Title for the action sheet.
Attribute	`header`
Type	`string ｜ undefined`
Default	`undefined`

htmlAttributes

Description	Additional attributes to pass to the action sheet.
Attribute	`undefined`
Type	`undefined ｜ { [key: string]: any; }`
Default	`undefined`

isOpen

Description	If `true`, the action sheet will open. If `false`, the action sheet will close. Use this if you need finer grained control over presentation, otherwise just use the actionSheetController or the `trigger` property. Note: `isOpen` will not automatically be set back to `false` when the action sheet dismisses. You will need to do that in your code.
Attribute	`is-open`
Type	`boolean`
Default	`false`

keyboardClose

Description	If `true`, the keyboard will be automatically dismissed when the overlay is presented.
Attribute	`keyboard-close`
Type	`boolean`
Default	`true`

leaveAnimation

Description	Animation to use when the action sheet is dismissed.
Attribute	`undefined`
Type	`((baseEl: any, opts?: any) => Animation) ｜ undefined`
Default	`undefined`

mode

Description	The mode determines which platform styles to use. This is a virtual property that is set once during initialization and will not update if you change its value after the initial render.
Attribute	`mode`
Type	`"ios" ｜ "md"`
Default	`undefined`

subHeader

Description	Subtitle for the action sheet.
Attribute	`sub-header`
Type	`string ｜ undefined`
Default	`undefined`

translucent

Description	If `true`, the action sheet will be translucent. Only applies when the mode is `"ios"` and the device supports `backdrop-filter`.
Attribute	`translucent`
Type	`boolean`
Default	`false`

trigger

Description	An ID corresponding to the trigger element that causes the action sheet to open when clicked.
Attribute	`trigger`
Type	`string ｜ undefined`
Default	`undefined`

事件

Name	Description	Bubbles
`didDismiss`	Emitted after the action sheet has dismissed. Shorthand for ionActionSheetDidDismiss.	`true`
`didPresent`	Emitted after the action sheet has presented. Shorthand for ionActionSheetWillDismiss.	`true`
`ionActionSheetDidDismiss`	Emitted after the action sheet has dismissed.	`true`
`ionActionSheetDidPresent`	Emitted after the action sheet has presented.	`true`
`ionActionSheetWillDismiss`	Emitted before the action sheet has dismissed.	`true`
`ionActionSheetWillPresent`	Emitted before the action sheet has presented.	`true`
`willDismiss`	Emitted before the action sheet has dismissed. Shorthand for ionActionSheetWillDismiss.	`true`
`willPresent`	Emitted before the action sheet has presented. Shorthand for ionActionSheetWillPresent.	`true`

方法

dismiss

Description	Dismiss the action sheet overlay after it has been presented.
Signature	`dismiss(data?: any, role?: string) => Promise<boolean>`
Parameters	data: Any data to emit in the dismiss events. role: The role of the element that is dismissing the action sheet. This can be useful in a button handler for determining which button was clicked to dismiss the action sheet. Some examples include: ``"cancel"`,` "destructive"`, "selected"`, and `"backdrop"`. This is a no-op if the overlay has not been presented yet. If you want to remove an overlay from the DOM that was never presented, use the remove method.

onDidDismiss

Description	Returns a promise that resolves when the action sheet did dismiss.
Signature	`onDidDismiss<T = any>() => Promise<OverlayEventDetail<T>>`

onWillDismiss

Description	Returns a promise that resolves when the action sheet will dismiss.
Signature	`onWillDismiss<T = any>() => Promise<OverlayEventDetail<T>>`

present

Description	Present the action sheet overlay after it has been created.
Signature	`present() => Promise<void>`

CSS Shadow Parts

No CSS shadow parts available for this component.

CSS 自定义属性

Name	Description
`--backdrop-opacity`	Opacity of the backdrop
`--background`	Background of the action sheet group
`--button-background`	Background of the action sheet button
`--button-background-activated`	Background of the action sheet button when pressed. Note: setting this will interfere with the Material Design ripple.
`--button-background-activated-opacity`	Opacity of the action sheet button background when pressed
`--button-background-focused`	Background of the action sheet button when tabbed to
`--button-background-focused-opacity`	Opacity of the action sheet button background when tabbed to
`--button-background-hover`	Background of the action sheet button on hover
`--button-background-hover-opacity`	Opacity of the action sheet button background on hover
`--button-background-selected`	Background of the selected action sheet button
`--button-background-selected-opacity`	Opacity of the selected action sheet button background
`--button-color`	Color of the action sheet button
`--button-color-activated`	Color of the action sheet button when pressed
`--button-color-focused`	Color of the action sheet button when tabbed to
`--button-color-hover`	Color of the action sheet button on hover
`--button-color-selected`	Color of the selected action sheet button
`--color`	Color of the action sheet text
`--height`	height of the action sheet
`--max-height`	Maximum height of the action sheet
`--max-width`	Maximum width of the action sheet
`--min-height`	Minimum height of the action sheet
`--min-width`	Minimum width of the action sheet
`--width`	Width of the action sheet

插槽

No slots available for this component.

内联操作表（推荐）​

使用 isOpen 属性​

控制器操作表​

按钮​

关闭时收集角色信息​

主题​

样式设置​

CSS 自定义属性​

可访问性​

屏幕阅读器​

角色（Role）​

操作表描述​

操作表按钮描述​

接口​

ActionSheetButton​

ActionSheetOptions​

属性​

animated​

backdropDismiss​

buttons​

cssClass​

enterAnimation​

header​

htmlAttributes​

isOpen​

keyboardClose​

leaveAnimation​

mode​

subHeader​

translucent​

trigger​

事件​

方法​

dismiss​

onDidDismiss​

onWillDismiss​

present​

CSS Shadow Parts​

CSS 自定义属性​

插槽​

Contents

内联操作表（推荐）

使用 `isOpen` 属性

控制器操作表

按钮

关闭时收集角色信息

主题

样式设置

CSS 自定义属性

可访问性

屏幕阅读器

角色（Role）

操作表描述

操作表按钮描述

接口

ActionSheetButton

ActionSheetOptions

属性

animated

backdropDismiss

buttons

cssClass

enterAnimation

header

htmlAttributes

isOpen

keyboardClose

leaveAnimation

mode

subHeader

translucent

trigger

事件

方法

dismiss

onDidDismiss

onWillDismiss

present

CSS Shadow Parts

CSS 自定义属性

插槽