SPA页面组件

在SPA中,页面组件不提供其子组件的HTML元素,而是将其委派给SPA框架。 此文档说明如何使SPA的页面组件具有唯一性。

注意

单页应用程序(SPA)编辑器功能需要AEM 6.4 service pack 2或更高版本。

SPA编辑器是需要SPA框架的客户端渲染(例如,React或Angular)的项目的推荐解决方案。

简介

SPA的页面组件不通过JSP或HTL文件和资源对象提供其子组件的HTML元素。 此操作委托给SPA框架。 子组件的表示形式被提取为JSON数据结构(即模型)。 然后,SPA组件会根据提供的JSON模型添加到页面。 因此,页面组件初始主体合成与预先渲染的HTML相同。

页面模型管理

页面模型的解析和管理被委托给提供的 PageModelManager模块。 当SPA初始化以获取初始页面模型并注册模型更新时,必须与PageModelManager模块交互——大多数情况下,当作者通过页面编辑器编辑页面时生成。 SPA project可以将PageModelManager作为npm包访问。 PageModelManager是AEM和SPA之间的翻译员,应与SPA一起使用。

要允许创作页面,必须添加名为cq.authoring.pagemodel.messaging的客户端库,以在SPA和页面编辑器之间提供通信渠道。 如果SPA页面组件从页面wcm/core组件继承内容,则有以下选项可使cq.authoring.pagemodel.messaging客户端库类别可用:

  • 如果模板是可编辑的,请将客户端库类别添加到页面策略。
  • 使用页面组件的customfooterlibs.html添加客户端库类别。

不要忘记将cq.authoring.pagemodel.messaging类别包含到页面编辑器的上下文。

通信数据类型

通信数据类型使用data-cq-datatype属性在AEM页面组件中设置一个HTML元素。 当通信数据类型设置为JSON时,GET请求将点击组件的Sling Model端点。 在页面编辑器中进行更新后,已更新组件的JSON表示形式将发送到页面模型库。 页面模型库随后会警告SPA更新。

SPA页面组件-body.html

<div id="page"></div>

除了不延迟DOM生成的良好做法外,SPA框架还要求在主体末尾添加脚本。

SPA页面组件-customfooterlibs.html

<sly data-sly-use.clientLib="${'/libs/granite/sightly/templates/clientlib.html'}"></sly>
<sly data-sly-test="${wcmmode.edit || wcmmode.preview}"
     data-sly-call="${clientLib.js @ categories='cq.authoring.pagemodel.messaging'}"></sly>
<sly data-sly-call="${clientLib.js @ categories='we-retail-journal-react'}"></sly>

描述SPA内容的元资源属性:

SPA页面组件-customheaderlibs.html

<meta property="cq:datatype" data-sly-test="${wcmmode.edit || wcmmode.preview}" content="JSON"/>
<meta property="cq:wcmmode" data-sly-test="${wcmmode.edit}" content="edit"/>
<meta property="cq:wcmmode" data-sly-test="${wcmmode.preview}" content="preview"/>
<meta property="cq:pagemodel_root_url" data-sly-use.page="com.adobe.cq.sample.spa.journal.models.AppPage" content="${page.rootUrl}"/>
<sly data-sly-use.clientlib="/libs/granite/sightly/templates/clientlib.html">
    <sly data-sly-call="${clientlib.css @ categories='we-retail-journal-react'}"/>
</sly>
注意

在请求元件的“吊索模型”表示时,将静态设置缺省模型选择器。

元属性

  • cq:wcmmode:编辑器的WCM模式(例如,页面、模板)

  • cq:pagemodel_root_url:应用程序的根模型的URL。由于子页面模型是应用程序根模型的片段,因此在直接访问子页面时至关重要。 然后,PageModelManager系统地将应用程序初始模型重新组合为从其根入口点进入应用程序。

  • cq:pagemodel_router:启用或禁用 ModelRouter 库功 PageModelManager

  • cq:pagemodel_route_filters:以逗号分隔的列表或常规表达式提供必 ModelRouter 须忽略的路由。

注意

此文档仅将We.Retail日志应用程序用于演示目的。 它不应用于任何项目工作。

任何AEM项目都应利用AEM项目原型,它支持使用React或Angular的SPA项目并利用SPA SDK。所有AEM项目SPA都应基于SPA入门启动工具包的Maven Archetype。

页面编辑器叠加同步

叠加的同步由cq.authoring.page类别提供的相同的变异观察器来保证。

Sling Model JSON导出结构配置

启用路由功能后,假定SPA的JSON导出包含应用程序的不同路由,这要归功于AEM导航组件的JSON导出。 AEM导航组件的JSON输出可以通过以下两个属性在SPA根页面内容策略中进行配置:

  • structureDepth:与导出的树的深度对应的编号
  • structurePatterns:与要导出的页面对应的正则表达式数组的正则表达式

这可以显示在/conf/we-retail-journal/react/settings/wcm/policies/we-retail-journal/react/components/structure/page/root的SPA示例内容中。

在此页面上