快速搜索组件 quick-search-component

快速搜索组件提供对网站的搜索功能并显示搜索结果,以便访客能够轻松找到匹配内容并查看结果。

TIP
您是否考虑过使用适合 AEM 的 Edge Delivery Services?
您可以继续为现有项目使用本文档中描述的方法。 但是对于新项目,Adobe 建议使用 Edge Delivery Services。

用途 usage

利用快速搜索组件,网站访客能够搜索内容、就地查看结果和轻松导航到匹配页面。 在用户滚动浏览搜索结果时,将动态获取新结果。

编辑对话框允许内容作者定义内容树中开始搜索的位置,并可以选择隐藏语义搜索切换开关。 使用设计对话框,模板作者可以设置内容树中开始搜索的位置的默认值、最大结果集大小、最小搜索词长度以及默认情况下是否向访客显示语义搜索切换开关。

版本和兼容性 version-and-compatibility

快速搜索组件的当前版本是v3,此版本随版本2.32.0的核心组件引入,添加了可选的语义搜索切换开关,具体说明见本文档。

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

组件版本
AEM 6.4
AEM 6.5
AEM 6.5 LTS
AEM as a Cloud Service
v3
-
兼容*
兼容*
兼容
v2
-
兼容
兼容
兼容
v1

版本 2.17.4 和更低版本兼容
兼容
-
兼容

*语义搜索切换开关仅适用于AEM as a Cloud Service。

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

示例组件输出 sample-component-output

要体验快速搜索组件并查看其配置选项示例以及HTML和JSON输出,请访问组件库。

技术详细信息 technical-details

NOTE
应对搜索组件或任何基于 AEM 的应用程序实施更高级别的保护以使其免受 DOS 攻击,例如,通过使用 Dispatcher 上的 mod_security

在GitHub上可找到有关快速搜索组件的最新技术文档。

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

“编辑”对话框 edit-dialog

利用“编辑”对话框,内容作者可以定义内容树中开始搜索的位置,并可以选择隐藏语义搜索切换开关。

快速搜索组件的“编辑”对话框

搜索根 - 要从其开始搜索的根页面。 搜索根可以是 Blueprint 母版页、语言母版页或常规页。

  • ID - 利用此选项,可以控制 HTML 和Data Layer 中的组件的唯一标识符。

    • 如果留空,系统会自动为您生成一个唯一 ID,可以通过检查结果页面找到该 ID。
    • 如果指定一个 ID,作者有责任确保它是唯一的。
    • 更改此 ID 会对 CSS、JS 和 Data Layer 跟踪产生影响。
  • 隐藏此实例的语义搜索切换开关 — 选中后,无论设计对话框配置为显示什么内容,语义搜索切换开关都将隐藏。

    • 保持未选中状态以使用模板的默认值。
    • 此选项无法强制切换开关显示在设计对话框隐藏它的位置上。
NOTE
如果​ 搜索根 ​未配置或无法解析,则快速搜索默认为在当前页面下搜索。
NOTE
语义搜索切换仅在使用AEM Content AI配置环境时返回AI支持的结果。 在未使用内容人工智能配置的AEM 6.5和AEM 6.5 LTS环境中,使用设计对话框🔗隐藏切换开关,以便不向访客提供无法正常运行的搜索模式。

“设计”对话框 design-dialog

利用“设计”对话框,模板作者可以设置内容树中开始搜索的位置的默认值、最大结果集大小、最小搜索词长度以及默认情况下是否向访客显示语义搜索切换开关。

“属性”选项卡 properties-tab

快速搜索组件的“设计”对话框

  • 搜索根 — 内容作者在内容页面上放置快速搜索组件时搜索根的默认值

  • 结果大小 — 搜索请求获取的结果的最大数目

  • 搜索词最小长度 — 用于开始搜索的搜索词的最小长度

  • 隐藏语义搜索切换 — 选中后,用法中描述的​ 语义搜索 ​切换默认不会向网站访客显示,该组件的行为类似于v2 (仅限全文搜索)组件。

    • 默认情况下处于未选中状态。
    • 内容作者还可以在编辑对话框中为单个快速搜索组件覆盖此内容。
NOTE
语义搜索切换仅在使用AEM Content AI配置环境时返回AI支持的结果。 在未使用内容人工智能配置的AEM 6.5和AEM 6.5 LTS环境中,使用“设计”对话框隐藏切换开关,以便不向访客提供无法正常运行的搜索模式。
NOTE
由于只能在设计模式中设置​ 结果大小 ​和​搜索词最小长度,因此它们仅处于模板级别,这意味着内容作者无法修改这些值。
CAUTION
如果​ 结果大小 ​和​ 搜索词最小长度 ​分别设置得太高或太低,则会影响性能。

“样式”选项卡 styles-tab

快速搜索组件支持 AEM 样式系统

recommendation-more-help
experience-manager-core-components-help-main-toc