SPA 页面组件

上次更新: 2023-06-29

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

页面模型管理

页面模型的决议案和管理委托给提供的团队。 PageModelManager 模块。 SPA必须与 PageModelManager 模块(初始化时用于获取初始页面模型并注册模型更新) — 大多在作者通过页面编辑器编辑页面时生成。 此 PageModelManager 可由SPA项目作为npm包访问。 作为AEM和SPA之间的解释者, PageModelManager 旨在伴随SPA。

要允许创作页面,请指定一个名为的客户端库 cq.authoring.pagemodel.messaging 必须添加才能在SPA和页面编辑器之间提供通信渠道。 如果SPA页面组件继承自页面wcm/核心组件,则可以使用以下选项来将 cq.authoring.pagemodel.messaging 可用的客户端库类别:

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

别忘了限制包含 cq.authoring.pagemodel.messaging 类别映射到页面编辑器的上下文。

通信数据类型

使用在AEM Page组件中设置HTML元素的通信数据类型 data-cq-datatype 属性。 当通信数据类型设置为JSON时,GET请求会命中组件的Sling模型端点。 在页面编辑器中执行更新后,已更新组件的 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>
注意

请求组件的Sling模型表示时,会静态设置默认模型选择器。

元属性

  • cq:wcmmode:编辑器的WCM模式(例如,页面、模板)
  • cq:pagemodel_root_url:应用程序的根模型的URL。 由于子页面模型是应用程序根模型的片段,因此直接访问子页面时至关重要。 此 PageModelManager 然后,系统化地重新构建应用程序初始模型,使其从根入口点进入应用程序。
  • cq:pagemodel_router:启用或禁用 ModelRouterPageModelManager
  • cq:pagemodel_route_filters:逗号分隔列表或正则表达式,用于提供路由 ModelRouter 必须忽略。

页面编辑器覆盖同步

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

Sling模型JSON导出结构配置

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

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

在此页面上