列表组件 (v3) list-component

Last update: Fri Jul 12 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：
核心组件

创建对象：

开发人员
管理员
用户

利用核心组件列表组件 (v3)，可以轻松地创建动态和静态列表。

用途 usage

列表组件 (v3) 可用于创建子页面的动态列表或者任意定义项的静态列表。可用的列表类型以及格式化选项可以由模板作者在“设计”对话框中定义。内容编辑者可在“编辑”对话框中从可用列表类型以及如何格式化列表元素中选择。

版本和兼容性 version-and-compatibility

本文档介绍了列表组件 v3，此版本在 2022 年 2 月发行核心组件 2.18.0 版本时引入。

CAUTION

本文档介绍了列表组件 v3。

有关当前版本的列表组件的详细信息，请参阅列表组件文档。

下表详细说明了该组件的所有受支持版本、与该组件的版本兼容的 AEM 版本以及指向早期版本文档的链接。

组件版本

AEM 6.4

AEM 6.5

AEM as a Cloud Service

兼容

有关核心组件版本的更多信息，请参阅文档核心组件版本。

列表中的重定向 redirects

如果页面具有重定向目标（无论它指向的是外部 URL 还是另一个 AEM 页面），则包含指向该点的链接的列表将直接指向重定向目标的 URL。

示例 redirect-example

创建重定向到页面 B 的页面 A。
创建重定向到 https://aemcomponents.dev 的页面 C
在页面 D 上，插入包含页面 A 和 C 的列表组件
随后，生成的相应链接将直接指向页面 B 和 https://aemcomponents.dev

示例组件输出 sample-component-output

要体验列表组件并查看其配置选项示例以及 HTML 和 JSON 输出，请访问组件库。

技术详细信息 technical-details

在 GitHub 上可找到有关列表组件的最新技术文档。

在核心组件开发人员文档中可找到有关开发核心组件的其他详细信息。

“编辑”对话框 edit-dialog

利用“编辑”对话框，内容作者可以配置列表和列表项。

“列表设置”选项卡 list-settings-tab

列表可以通过不同方式构建。

子页面
固定列表
搜索
标记

不论如何构建列表，始终可以配置排序和 ID 选项。

列表组件的“编辑”对话框

根据内容作者选择如何构建列表，可以更改其他配置选项。

子页面 child-pages

列表可以由当前页面的子页面或其他页面构建。

子页面选项

父页面
- 其子页面应该用于生成列表的页面
- 留空可使用当前页面
子级深度
应该使用层级中向下的多少层

固定列表 fixed-list

列表可使用固定项列表构建。

固定列表选项

点击或单击添加按钮可在列表中插入新项。

在列表中为项输入文本，或者使用 “选择”对话框 从 AEM 中选择项。
使用拖动手柄重新排列列表中的项。
使用垃圾桶图标可删除列表中的项。

搜索 search-options

列表可使用对 AEM 内容搜索的结果来构建。

搜索列表选项

搜索查询
用于运行全文搜索以生成列表项的字符串
搜索范围
运行搜索的位置
- 使用 “选择”对话框 可在 AEM 中选择位置
- 如果留空则使用当前页面

标记 tags

列表可以使用在特定位置下与特定标记匹配的页面构建。

标记列表选项

父页面
开始标记匹配的位置
- 使用 “选择”对话框 可在 AEM 中选择位置
- 如果留空则使用当前页面
标记
应该匹配的标记
- 使用浏览对话框选择标记。
匹配
定义用什么类型的匹配来限定可以包括在列表中的页面
- 任何标记
- 所有标记

排序选项 sort-options

不论您选择如何构建列表，始终可以定义特定的排序选项。

排序选项

排序方式
应该如何对元素排序
- 标题
- 上次修改日期
排序顺序
对项排序所用的顺序
- 升序
- 降序
最大项数
列表中显示的项的最大数量。
- 留空可返回所有项。
ID - 利用此选项，可以控制 HTML 和 Data Layer中的组件的唯一标识符。
- 如果留空，系统会自动为您生成一个唯一 ID，可以通过检查结果页面找到该 ID。
- 如果指定一个 ID，作者有责任确保它是唯一的。
- 更改此 ID 会对 CSS、JS 和 Data Layer 跟踪产生影响。