组件侧载

上次更新: 2023-12-07
  • 主题:
  • Communities
    查看有关此主题的更多信息
  • 创建对象:
  • User

概述

当网页设计为一个简单的单页面应用程序时,Communities组件旁加载会非常有用,该应用程序会根据网站访客选择的内容来动态更改显示的内容。

当页面模板中不存在Communities组件,而是根据网站访客的选择动态添加组件时,即可实现此目的。

由于社交组件框架(SCF)具有轻量级存在,因此仅注册初始页面加载时存在的SCF组件。 对于要在页面加载后注册的动态添加的SCF组件,必须调用SCF以“侧载”该组件。

当页面设计为侧载Communities组件时,可以缓存整个页面。

动态添加SCF组件的步骤如下:

  1. 将组件添加到DOM

  2. 侧载组件 使用以下两种方法之一:

注意

侧载 非现有资源 不受支持。

将组件动态添加到DOM

无论组件是动态包含还是动态加载,都必须首先将其添加到DOM。

添加SCF组件时,最常用的标记是DIV标记,但也可以使用其他标记。 由于SCF仅在最初加载页面时检查DOM,因此,在显式调用SCF之前,不会注意到对DOM的此添加。

无论使用什么标记,至少元素都必须通过包含这两个属性来符合正常的SCF根元素模式:

  • data-component-id

    所添加组件的有效路径。

  • data-scf-component

    组件的resourceType。

以下是已添加注释组件的示例:

<div
    class="scf-commentsystem scf translation-commentsystem"
    data-component-id="<%= currentPage.getPath()%>/jcr:content/content-left/comments"
    data-scf-component="social/commons/components/hbs/comments"
>
</div>

通过调用SCF进行侧载

动态包含

动态包含使用引导请求,该请求会导致SCF检查DOM并引导页面上的所有SCF组件。

要在页面加载后随时初始化SCF组件,只需触发如下所示的JQuery事件:

$(document).trigger(SCF.events.BOOTSTRAP_REQUEST);

动态加载

动态加载提供对SCF组件的加载控制。

可以使用此JavaScript方法指定要加载的特定SCF组件,而不是引导在DOM中找到的所有SCF组件:

SCF.addComponent(document.getElementById(*someId*));

位置 someId 的值为 data-component-id 属性。

在此页面上