导航组件(v1) :headding-anchor:navigation-component
使用导航组件,用户可轻松地在全局化网站结构中导航。
用途 :headding-anchor:usage
导航组件列出页面树,这样网站的用户可以轻松地在网站结构中导航。
导航组件可以自动检测网站的全局化网站结构,并自动适应本地化的页面。此外,它可以使用影子重定向页面支持任意网站结构,以展示您的主内容结构之外的其他结构。
利用“编辑”对话框,内容作者可以定义导航根页面以及导航深度。利用“设计”对话框,模板作者可以定义导航根和深度的默认值。
版本和兼容性 :headding-anchor:version-and-compatibility
本文档介绍了导航组件 v1,此版本随 2018 年 1 月的核心组件发行版本 2.0.0 的发布引入。
本地化网站结构支持 :headding-anchor:localized-site-structure
网站通常以多种语言提供给不同区域。通常,每个本地化的页面将包含一个导航元素,该元素包括在页面模板中。使用导航组件,您可以在模板上为网站的所有页面放置一个导航元素,然后它可根据全局化的网站结构,自动适应单独的本地化页面。
- 有关导航组件本地化功能的工作方式示例,请参阅以下部分。
- 有关核心组件的本地化功能如何配合使用的示例,请参阅核心组件页面的本地化功能。
示例 :headding-anchor:example-localization
假设您的内容与以下内容类似:
/content
+-- wknd
+-- language-masters
+-- de
\-- experience
\-- arctic-surfing-in-lofoten
+-- en
\-- experience
\-- arctic-surfing-in-lofoten
+-- es
+-- fr
\-- it
+-- us
+-- en
\-- experience
\-- arctic-surfing-in-lofoten
\-- es
\-- ch
+-- de
\-- experience
\-- arctic-surfing-in-lofoten
+-- fr
\-- it
+-- wknd-events
\-- wknd-shop
对于站点 WKND,您可能希望将导航组件作为标头的一部分放置在页面模板上。将导航组件放到模板中之后,您可以将组件的 导航根 设置为 /content/wknd/language-masters/en
,因为这是您网站的主内容的开始位置。您可能还希望将 导航结构深度 设置为 2
,因为您可能不希望组件显示完整的内容树,而是只显示前两个级别,以将其用作概览。
使用 导航根 值,导航组件即可知道在 /content/wknd/language-masters/en
之后开始导航,并且可以向下递归网站的结构两级(如 导航结构深度 值所定义)来生成导航选项。
不论用户在查看什么本地化页面,导航组件都可以通过知道当前页面的位置,向后查找到根,然后前进到对应的页面,从而找到对应的本地化页面。
因此,如果访客查看 /content/ch/de/experience/arctic-surfing-in-lofoten
,组件就会知道根据 /content/wknd/language-masters/de
生成导航结构。与此类似,如果访客查看 /content/us/en/experience/arctic-surfing-in-lofoten
,组件就会知道根据 /content/wknd/language-masters/en
生成导航结构。
影子网站结构支持 :headding-anchor:shadow-structure
有时候,需要为访客创建不同于实际网站结构的导航菜单。可能某个促销需要通过重新排列内容的列表,在菜单中突出显示特定内容。使用仅仅重定向到其他内容页面的影子页面,导航组件可以生成所需的任意导航结构。
为此,您需要:
- 创建影子页面作为表示所需网站结构的空页面。这通常称为影子网站结构。
- 在这些页面的页面属性中,将 重定向 值设置为指向实际内容页面。
- 在影子页面的页面属性中,设置 在导航中隐藏 选项。
- 将导航组件的 导航根 值设置为指向新影子网站结构的根。
然后导航组件将根据影子网站结构渲染菜单。组件渲染的链接指向影子页面重定向到的实际内容页面,而不是影子页面本身。此外,组件显示实际页面的名称并正确地突出显示活动页面,即使导航是基于影子页面。导航组件有效地使影子页面对访客完全透明。
导航中的重定向 :headding-anchor:redirects
如果页面具有重定向目标(无论它指向的是外部 URL 还是另一个 AEM 页面),则包含指向该点的链接的导航组件将直接指向重定向目标的 URL。
示例 :headding-anchor:redirect-example
- 创建重定向到页面 B 的页面 A。
- 创建重定向到
https://aemcomponents.dev
的页面 C - 在页面 D 上,插入包含页面 A 和 C 的导航组件
- 随后,生成的相应链接将直接指向页面 B 和
https://aemcomponents.dev
示例组件输出 :headding-anchor:sample-component-output
要体验导航组件并查看其配置选项示例以及 HTML 和 JSON 输出,请访问组件库。
技术详细信息 :headding-anchor:technical-details
在 GitHub 上可找到有关导航组件的最新技术文档。
在核心组件开发人员文档中可找到有关开发核心组件的其他详细信息。
“编辑”对话框 :headding-anchor:edit-dialog
在“编辑”对话框中,内容作者可以定义导航的根页面以及导航结构的深度。
“属性”选项卡 :headding-anchor:properties-tab
-
导航根 - 用于生成导航树的根页面。
-
排除根级别 - 通常根不应包含在导航中。使用此选项,您可以指定从根开始往上,需要排除多少个级别。例如:
- 0 = 显示根级别
- 1 = 排除根级别
- 2 = 排除根以及往上的 1 级
- 以此类推。
-
收集所有子页面 - 收集导航根的所有子级页面。
-
导航结构深度 - 定义在导航树中,组件应相对于导航根向下显示多少级(仅在未选中 收集所有子页面 时可用)。
-
禁用影子 - 如果在层级中的页面是重定向的,则将显示重定向页面的名称而不是目标。有关更多信息,请参阅影子网站结构支持。
-
ID - 利用此选项,可以控制 HTML 和 Data Layer 中的组件的唯一标识符。
- 如果留空,系统会自动为您生成一个唯一 ID,可以通过检查结果页面找到该 ID。
- 如果指定一个 ID,作者有责任确保它是唯一的。
- 更改此 ID 会对 CSS、JS 和 Data Layer 跟踪产生影响。
“辅助功能”选项卡 :headding-anchor:accessibility-tab
在 辅助功能 选项卡上,可以为组件的 ARIA 辅助功能标签设置值。
- 标签 - 组件的 ARIA 标签属性的值
“设计”对话框 :headding-anchor:design-dialog
模板作者可以使用“设计”对话框设置向内容作者显示的导航根页面和导航深度的默认值。
“属性”选项卡 :headding-anchor:properties-tab-design
-
导航根 - 导航结构的根页面的默认值,该页面将用于生成导航树,在内容作者将组件添加到页面时使用该默认值。
-
排除根级别 - 通常根不应包含在导航中。使用此选项,您可以指定从根开始往上,需要默认排除多少个级别。例如:
- 0 = 显示根级别
- 1 = 排除根级别
- 2 = 排除根以及往上的 1 级
- 以此类推。
-
收集所有子页面 - 选项的默认值,将收集导航根的所有子级页面。
-
导航结构深度 - 导航结构深度的默认值。
-
禁用影子 - 在添加导航组件时是否应禁用影子的默认值。
“样式”选项卡 :headding-anchor:styles-tab
导航组件支持 AEM 样式系统。
Adobe Client Data Layer :headding-anchor:data-layer
导航组件支持 Adobe Client Data Layer。