跳到主要内容
版本:v7

ion-accordion

shadow

手风琴(Accordion)在您的内容中提供可折叠的区块,通过组织和分组信息来减少垂直空间占用。所有 ion-accordion 组件都应分组在 ion-accordion-group 组件内部。

基本用法

切换手风琴状态

通过设置 ion-accordion-groupvalue 属性来控制哪个手风琴处于展开状态。设置此属性允许开发者以编程方式展开或折叠特定的手风琴。

监听手风琴状态变化

警告

其他组件(如 InputTextarea)发出的大多数 ionChange 事件会向上冒泡。因此,如果这些关联组件在手风琴内部使用,这些事件将冒泡并触发您在手风琴组(Accordion Group)上设置的 ionChange 监听器。

当在手风琴内部使用其他发出 ionChange 事件的组件时,建议让手风琴组上的 ionChange 回调函数检查传递给回调的事件中的 target 键,以验证 ionChange 是否来自手风琴组本身,而非任何子组件。

开发者可以监听 ionChange 事件,以便在手风琴展开或折叠时收到通知。

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

多手风琴展开

通过 multiple 属性,开发者可以允许多个手风琴同时展开。

禁用手风琴

单个手风琴

可以通过在 ion-accordion 上设置 disabled 属性来禁用单个手风琴。

手风琴组

可以通过在 ion-accordion-group 上设置 disabled 属性来禁用手风琴组。

只读手风琴

单个手风琴

可以通过在 ion-accordion 上设置 readonly 属性来使单个手风琴变为只读。

手风琴组

可以通过在 ion-accordion-group 上设置 readonly 属性来使手风琴组变为只读。

结构剖析

头部(Header)

header 插槽用作切换按钮,用于展开或折叠您的手风琴。我们建议您在此处使用 ion-item,以利用其辅助功能和主题化功能。

当在 header 插槽中使用 ion-item 时,ion-itembutton 属性将设置为 truedetail 属性将设置为 false。此外,我们还会自动向 ion-item 添加一个切换图标。当您展开或折叠手风琴时,此图标会自动旋转。更多信息请参阅自定义图标

内容(Content)

content 插槽用作手风琴的一部分,根据手风琴的状态显示或隐藏。您可以在此处放置除另一个 ion-content 实例之外的任何内容,因为每个页面只应添加一个 ion-content 实例。

自定义

展开样式

有两种内置的展开样式:compact(紧凑式)和 inset(内嵌式)。此展开样式通过 ion-accordion-group 上的 expand 属性设置。

expand="inset" 时,手风琴组会获得边框圆角。在 md 模式下,整个手风琴在展开时会向下移动。

高级展开样式

您可以根据手风琴的状态通过样式自定义展开行为。ion-accordion 上应用了四个状态类。使用这些类进行样式设置可以让您创建高级的状态过渡效果:

类名描述
.accordion-expanding当手风琴正在展开时应用
.accordion-expanded当手风琴完全展开时应用
.accordion-collapsing当手风琴正在折叠时应用
.accordion-collapsed当手风琴完全折叠时应用

如果您需要定位到手风琴的特定部分,我们建议直接定位该元素。例如,如果您想在手风琴展开时自定义头部插槽中的 ion-item,可以使用以下选择器:

ion-accordion.accordion-expanding ion-item[slot='header'],
ion-accordion.accordion-expanded ion-item[slot='header'] {
--color: red;
}

图标

当在 header 插槽中使用 ion-item 时,我们会自动添加一个 ion-icon。所使用的图标类型可以通过 toggleIcon 属性控制,其添加到的插槽位置可以通过 toggleIconSlot 属性控制。

如果您想自己管理图标或使用非 ion-icon 的图标,可以向图标元素添加 ion-accordion-toggle-icon 类。

无论您选择哪种方式,当您展开或折叠手风琴时,图标都会自动旋转。

主题化

由于 ion-accordion 充当头部和内容元素的外壳,您可以轻松地对手风琴进行主题化。您可以通过定位已插入的 ion-item 来为主题化头部。由于您使用的是 ion-item,您还可以访问所有 ion-item CSS 变量ion-item 阴影部件。通过定位 content 插槽中的元素,也可以轻松为主题化内容。

辅助功能

动画

默认情况下,展开或折叠手风琴项时会启用动画。当支持 prefers-reduced-motion 媒体查询且其值设为 reduce 时,动画将自动禁用。对于不支持此功能的浏览器,可以通过在 Ionic Framework 应用中设置 animated 配置来禁用动画。

键盘交互

当在 ion-accordion-group 内部使用时,ion-accordion 具有与组件交互的完整键盘支持。下表详细说明了每个按键的作用:

按键描述
空格Enter当焦点位于手风琴头部时,根据组件的状态折叠或展开手风琴。
Tab将焦点移动到下一个可聚焦元素。
Shift + Tab将焦点移动到上一个可聚焦元素。
下箭头- 当焦点位于某个手风琴头部时,将焦点移动到下一个手风琴头部。
- 当焦点位于最后一个手风琴头部时,将焦点移动到第一个手风琴头部。
上箭头- 当焦点位于某个手风琴头部时,将焦点移动到上一个手风琴头部。
- 当焦点位于第一个手风琴头部时,将焦点移动到最后一个手风琴头部。
Home当焦点位于某个手风琴头部时,将焦点移动到第一个手风琴头部。
End当焦点位于某个手风琴头部时,将焦点移动到最后一个手风琴头部。

性能

动画

手风琴动画的工作原理是在动画开始时知道 content 插槽的高度。手风琴期望此高度在整个动画过程中保持一致。因此,开发者应避免在动画期间执行任何可能改变内容高度的操作。

例如,使用 ion-img 可能会在延迟加载图像时导致布局偏移。这意味着随着动画的进行,ion-img 将加载图像数据,并且 ion-img 的尺寸将随之改变以适应加载的图像数据。这可能导致 content 插槽的高度发生变化。开发者有几种方法可以避免这种情况:

  1. 使用没有任何延迟加载的 img 元素。ion-img 始终使用延迟加载,但 img 默认不使用延迟加载。这是最简单的选项,如果您有较小的图像且延迟加载带来的优势不明显,此方法效果很好。

  2. ion-img 上设置最小宽度和高度。如果您需要使用延迟加载并且提前知道图像的尺寸(例如,如果您加载的是相同尺寸的图标),可以使用 CSS 设置 ion-img 的最小宽度或高度。这使开发者在获得延迟加载好处的同时避免布局偏移。使用带有 loading="lazy"img 元素时,此方法也同样有效!

  3. 如果这些选项都不适用,开发者可以考虑通过使用 ion-accordion-group 上的 animated 属性完全禁用动画。

属性

disabled

DescriptionIf true, the accordion cannot be interacted with.
Attributedisabled
Typeboolean
Defaultfalse

mode

DescriptionThe 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.
Attributemode
Type"ios" | "md"
Defaultundefined

readonly

DescriptionIf true, the accordion cannot be interacted with, but does not alter the opacity.
Attributereadonly
Typeboolean
Defaultfalse

toggleIcon

DescriptionThe toggle icon to use. This icon will be rotated when the accordion is expanded or collapsed.
Attributetoggle-icon
Typestring
DefaultchevronDown

toggleIconSlot

DescriptionThe slot inside of ion-item to place the toggle icon. Defaults to "end".
Attributetoggle-icon-slot
Type"end" | "start"
Default'end'

value

DescriptionThe value of the accordion. Defaults to an autogenerated value.
Attributevalue
Typestring
Defaultion-accordion-${accordionIds++}

事件

No events available for this component.

方法

No public methods available for this component.

CSS 阴影部件

NameDescription
contentThe wrapper element for the content slot.
expandedThe expanded element. Can be used in combination with the header and content parts (i.e. ::part(header expanded)).
headerThe wrapper element for the header slot.

CSS 自定义属性

No CSS custom properties available for this component.

插槽

NameDescription
contentContent is placed below the header and is shown or hidden based on expanded state.
headerContent is placed at the top and is used to expand or collapse the accordion item.