Show Menu
主题×

扩展AEM Screens组件

以下教程将介绍扩展开箱即用AEM Screens组件的步骤和最佳实践。 图像组件经过扩展以添加可创作的文本叠加。

概述

本教程面向不熟悉AEM Screens的开发人员。 在本教程中,Screens图像组件经过扩展以创建海报组件。 标题、描述和徽标叠加在图像顶部以在序列渠道中创建引人入胜的体验。
在开始本教程之前,建议先完成本教程:为 AEM Screens开发自定义组件
自定义海报组件是通过扩展图像组件来创建的。

前提条件

要完成本教程,需要执行以下操作:
  1. AEM 6.4或 AEM 6.3 +最新屏幕功能包
  2. 本地开发环境
教程步骤和屏幕截图是使用CRXDE-Lite执行的。 Eclipse IntelliJ IDE也可用于完成教程。 有关使用IDE与AEM进行开 发的更多信息,请访问此处

项目设置

Screens项目的源代码通常作为多模块Maven项目进行管理。 为了加速教程,使用 AEM Project Archetype 13预生成了一个项目 。 有关使用Maven AEM 项目原型创建项目的更多详细信息,请参阅此处
  1. 使用 CRX包管理下载并安装以下包 http://localhost:4502/crx/packmgr/index.jsp)r:
    获取文件 (可选 )如果使用Eclipse或其他IDE,请下载以下源包。 使用Maven命令将项目部署到本地AEM实例:
    mvn -PautoInstallPackage clean install
    SRC启动屏幕We.Retail运行项目
  2. CRX包管理器中 http://localhost:4502/crx/packmgr/index.jsp ,安装了以下两个包:
    1. screens-weretail-run.ui.content-0.0.1-SNAPSHOT.zip
    2. screens-weretail-run.ui.apps-0.0.1-SNAPSHOT.zip
    Screens We.Retail运行通过CRX包管理器安装的Ui.Apps和Ui.Content包

创建海报组件

海报组件扩展了现成的屏幕图像组件。 Sling的机制用 sling:resourceSuperType 于继承图像组件的核心功能,无需复制和粘贴。 有关 Sling请求处理基础知识的更多信息,请单击此处。
海报组件以预览/制作模式全屏呈现。 在编辑模式下,为便于创作序列渠道,必须以不同方式呈现组件。
  1. 在下 面的CRXDE-Lite (或选择的IDE)中, http://localhost:4502/crx/de/index.jsp 创建一个 /apps/weretail-run/components/content 新名称 cq:Component poster
    将以下属性添加到组 poster 件:
    <?xml version="1.0" encoding="UTF-8"?>
    <jcr:root xmlns:sling="https://sling.apache.org/jcr/sling/1.0" xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0"
        jcr:primaryType="cq:Component"
        jcr:title="Poster"
        sling:resourceSuperType="screens/core/components/content/image"
        componentGroup="We.Retail Run - Content"/>
    
    
    /apps/weretail-run/components/content/poster的属性
    通过将属性设 sling:resourceSuperType 置为与海报 screens/core/components/content/image 组件相等,可以有效地继承图像组件的所有功能。 可以在组件下方添加位于组 screens/core/components/content/image 件下方的对等节点和文 poster 件,以覆盖和扩展功能。
  2. 将节点复 cq:editConfig 制到组 /libs/screens/core/components/content/image. 件下方 cq:editConfig 的粘贴 /apps/weretail-run/components/content/poster 位置。
    在节 cq:editConfig/cq:dropTargets/image/parameters 点上,将属性 sling:resourceType 更新为相等 weretail-run/components/content/poster
    cq:editConfig的XML表示形式如下所示:
    <?xml version="1.0" encoding="UTF-8"?>
    <jcr:root xmlns:sling="https://sling.apache.org/jcr/sling/1.0" xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0" xmlns:nt="https://www.jcp.org/jcr/nt/1.0"
        jcr:primaryType="cq:EditConfig">
        <cq:dropTargets jcr:primaryType="nt:unstructured">
            <image
                jcr:primaryType="cq:DropTargetConfig"
                accept="[image/.*]"
                groups="[media]"
                propertyName="./fileReference">
                <parameters
                    jcr:primaryType="nt:unstructured"
                    sling:resourceType="weretail-run/components/content/poster"
                    imageCrop=""
                    imageMap=""
                    imageRotate=""/>
            </image>
        </cq:dropTargets>
    </jcr:root>
    
    
  3. 复制要用 image 于组件的WCM Foundation对 poster 话框。
    最简单的方法是从现有对话框开始,然后进行修改。
    1. 从以下位置复制对话框: /libs/wcm/foundation/components/image/cq:dialog
    2. 将对话框粘贴到下方 /apps/weretail-run/components/content/poster
    将对话框从/libs/wcm/foundation/components/image/cq:dialog复制到/apps/weretail-run/components/content/poster
    Screens组 image 件被超类型化为WCM Foundation组 image 件。 因此,组 poster 件会从两者继承功能。 海报组件的对话框由屏幕和基础对话框的组合组成。 Sling Resource Merage的功 ​能用于隐藏从超类型组件继承的不相关对话框字段和选项卡。
  4. 使用XML中表示的以 /apps/weretail-run/components/content/poster 下更改更新下方的cq:dialog:
    <?xml version="1.0" encoding="UTF-8"?>
    <jcr:root xmlns:sling="https://sling.apache.org/jcr/sling/1.0" xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0" xmlns:nt="https://www.jcp.org/jcr/nt/1.0"
        jcr:primaryType="nt:unstructured"
        jcr:title="Poster"
        sling:resourceType="cq/gui/components/authoring/dialog">
        <content
            jcr:primaryType="nt:unstructured"
            sling:resourceType="granite/ui/components/foundation/container">
            <layout
                jcr:primaryType="nt:unstructured"
                sling:resourceType="granite/ui/components/foundation/layouts/tabs"
                type="nav"/>
            <items jcr:primaryType="nt:unstructured">
                <image
                    jcr:primaryType="nt:unstructured"
                    jcr:title="Elements"
                    sling:resourceType="granite/ui/components/foundation/section">
                    <layout
                        jcr:primaryType="nt:unstructured"
                        sling:resourceType="granite/ui/components/foundation/layouts/fixedcolumns"
                        margin="{Boolean}false"/>
                    <items jcr:primaryType="nt:unstructured">
                        <column
                            jcr:primaryType="nt:unstructured"
                            sling:resourceType="granite/ui/components/foundation/container">
                            <items
                                jcr:primaryType="nt:unstructured"
                                sling:hideChildren="[linkURL,size]">
                                <file
                                    jcr:primaryType="nt:unstructured"
                                    sling:resourceType="cq/gui/components/authoring/dialog/fileupload"
                                    autoStart="{Boolean}false"
                                    class="cq-droptarget"
                                    fieldLabel="Image asset"
                                    fileNameParameter="./fileName"
                                    fileReferenceParameter="./fileReference"
                                    mimeTypes="[image]"
                                    multiple="{Boolean}false"
                                    name="./file"
                                    title="Upload Image Asset"
                                    uploadUrl="${suffix.path}"
                                    useHTML5="{Boolean}true"/>
                                <title
                                    jcr:primaryType="nt:unstructured"
                                    sling:resourceType="granite/ui/components/foundation/form/textfield"
                                    fieldLabel="Title"
                                    name="./jcr:title"/>
                                <description
                                    jcr:primaryType="nt:unstructured"
                                    sling:resourceType="granite/ui/components/foundation/form/textarea"
                                    fieldLabel="Description"
                                    name="./jcr:description"/>
                                <position
                                    jcr:primaryType="nt:unstructured"
                                    sling:resourceType="granite/ui/components/coral/foundation/form/select"
                                    fieldLabel="Text Position"
                                    name="./textPosition">
                                    <items jcr:primaryType="nt:unstructured">
                                        <left
                                            jcr:primaryType="nt:unstructured"
                                            text="Left"
                                            value="left"/>
                                        <center
                                            jcr:primaryType="nt:unstructured"
                                            text="Center"
                                            value="center"/>
                                        <right
                                            jcr:primaryType="nt:unstructured"
                                            text="Right"
                                            value="right"/>
                                    </items>
                                </position>
                                <color
                                    jcr:primaryType="nt:unstructured"
                                    sling:resourceType="granite/ui/components/coral/foundation/form/select"
                                    fieldLabel="Text Color"
                                    name="./textColor">
                                    <items jcr:primaryType="nt:unstructured">
                                        <light
                                            jcr:primaryType="nt:unstructured"
                                            text="Light"
                                            value="light"/>
                                        <dark
                                            jcr:primaryType="nt:unstructured"
                                            text="Dark"
                                            value="dark"/>
                                    </items>
                                </color>
                            </items>
                        </column>
                    </items>
                </image>
                <accessibility
                    jcr:primaryType="nt:unstructured"
                    sling:hideResource="{Boolean}true"/>
            </items>
        </content>
    </jcr:root>
    
    
    在节点 sling:hideChildren 上使 "[linkURL,size] 用属性 items = ",以确保linkURL和 size ​字段在对话框中处于隐藏状态。 仅从海报对话框中删除这些节点是不够的。 辅助功 sling:hideResource="{Boolean}true" 能选项卡上的属性用于隐藏整个选项卡。
    向对话框中添加了两个选择字段,使作者能够控制标题和说明的文本位置和颜色。
    海报——最终对话框结构
    此时,可以将组件的实 poster 例添加到We.Retail run项 目的Idle Channel (空闲渠道)页面: http://localhost:4502/editor.html/content/screens/we-retail-run/channels/idle-channel.edit.html .
    海报对话框字段
  5. 在名称下创建文 /apps/weretail-run/components/content/poster production.html.
    用以下内容填充文件:
    <!--/*
    
        /apps/weretail-run/components/content/poster/production.html
    
    */-->
    <div data-sly-use.image="image.js"
         data-duration="${properties.duration}"
         class="cmp-poster"
         style="background-image: url(${request.contextPath @ context='uri'}${image.src @ context='uri'});">
        <div class="cmp-poster__text
                    cmp-poster__text--${properties.textPosition @ context='attribute'}
                    cmp-poster__text--${properties.textColor @ context='attribute'}">
            <h1 class="cmp-poster__title">${properties.jcr:title}</h1>
             <h2 class="cmp-poster__description">${properties.jcr:description}</h2>
        </div>
     <img class="cmp-poster__logo" src="/content/dam/we-retail-run/logos/we-retail-run_dark.png" alt="we-retail-logo" />
    </div>
    
    
    以上是海报组件的制作标记。 HTL脚本将覆盖 screens/core/components/content/image/production.html 。 它 image.js 是创建类似于POJO的Image对象的服务器端脚本。 然后,可以调用Image对象以将其呈 src 现为内联样式背景图像。
    The h1 添加h2标记后,将根据组件属性显示标题和说明: ${properties.jcr:title} ${properties.jcr:description}
    在和标 h1 签周 h2 围是一个div包装器,包含三个CSS类,变量为“ cmp-poster__text ”。 和属性的值 textPosition 用于更 textColor 改根据作者的对话框选择呈现的CSS类。 在下一节中,将编写客户端库中的CSS,以在显示中启用这些更改。
    徽标也作为叠加包含在组件中。 在此示例中,We.Retail徽标的路径硬编码在DAM中。 根据用例,创建新对话框字段可使徽标路径成为动态填充的值可能更有意义。
    另请注意,BEM(块元素修饰符)记号用于组件。 BEM是一种CSS编码惯例,它使创建可重用组件更加容易。 BEM是 AEM核心组件使用的表示法 。 更多信息,请访问: https://getbem.com/
  6. 在名称下创建文 /apps/weretail-run/components/content/poster edit.html.
    用以下内容填充文件:
    <!--/*
    
        /apps/weretail-run/components/content/poster/edit.html
    
    */-->
    
    <div class="aem-Screens-editWrapper ${image.cssClass} cmp-poster" data-sly-use.image="image.js" data-emptytext="${'Poster' @ i18n, locale=request.locale}">
        <img class="cmp-poster__image" src="${request.contextPath}${image.src @ context='uri'}" width="100%" />
        <div class="cmp-poster__text
               cmp-poster__text--${properties.textPosition @ context='attribute'}
           cmp-poster__text--${properties.textColor @ context='attribute'}">
          <p class="cmp-poster__title">${properties.jcr:title}</p>
          <p class="cmp-poster__description">${properties.jcr:description}</p>
        </div>
    </div>
    
    
    上面是海 报组件 的编辑标记。 HTL脚本将覆盖 /libs/screens/core/components/content/image/edit.html 。 标记与标记类似, production.html 并将在图像顶部显示标题和说明。
    aem-Screens-editWrapper 加组件后,该组件将不会在编辑器中全屏显示。 该属 data-emptytext 性确保在未填充图像或内容时显示占位符。

创建客户端库

客户端库提供了组织和管理AEM实施所需的CSS和JavaScript文件的机制。 有关使用客户端 库的更多信息,请单击此处。
在编辑模式与预览/生产模式下,AEM Screens组件的呈现方式不同。 将创建两组客户端库,一组用于编辑模式,另一组用于预览/制作。
  1. 为海报组件的客户端库创建一个文件夹。
    在下 /apps/weretail-run/components/content/poster, 面创建一个名为的新文件夹 clientlibs
  2. 在文件 clientlibs 夹下面创建一个名为的 shared 新节点 cq:ClientLibraryFolder.
  3. 将以下属性添加到共享客户端库:
    • allowProxy | 布尔型 | true
    • categories |字符串 # | cq.screens.components
    /apps/weretail-run/components/content/poster/clientlibs/shared的属性
    categories 属性是标识客户端库的字符串。 该类 cq.screens.components 别在“编辑”和“预览/生产”模式中都使用。 因此,在clientlib中定义的任何CSS/JS shared 都会在所有模式下加载。
    在生产环境中,绝不直接向/apps公开任何路径是最佳做法。 该属 allowProxy 性确保客户端库CSS和JS通过前缀引用 /etc.clientlibs 。 有关allowProxy属性 的更多信息,请单击此处。
  4. 创建名为共享 css.txt 文件夹下的文件。
    用以下内容填充文件:
    #base=css
    
    styles.less
    
    
  5. 创建名为文件夹 css 下的文 shared 件夹。 在文件夹下添加 style.less 一个名 css 称文件。 客户端库的结构现在应当如下:
    本教程不是直接编写CSS,而是使用LESS。 LESS 是一款流行的CSS预编译器,它支持CSS变量、混合和函数。 AEM客户端库本机支持LESS编译。 Sass或其他预编译器可用,但需要在AEM之外进行编译。
  6. 填充 /apps/weretail-run/components/content/poster/clientlibs/shared/css/styles.less 以下内容:
    /*
     /apps/weretail-run/components/content/poster/clientlibs/shared/css/styles.less
     Poster Component - Shared Style
    */
    
    @import url('https://fonts.googleapis.com/css?family=Fjalla+One|Open+Sans:400i');
    
    @text-light-color: #fff;
    @text-dark-color: #000;
    @title-font-family: 'Fjalla One', sans-serif;
    @description-font-family: 'Open Sans', sans-serif;
    
    .cmp-poster {
    
          &__text {
          position: absolute;
          color: @text-light-color;
          top: 0;
          text-align:center;
          width: 100%;
    
          &--left {
           text-align: left;
                 margin-left: 1em;
          }
    
          &--right {
           text-align: right;
                 margin-right: 1em;
          }
    
          &--dark {
           color: @text-dark-color;
          }
        }
    
        &__title {
          font-weight: bold;
             font-family: @title-font-family;
             font-size: 1.2em;
        }
    
        &__description {
      font-style: italic;
            font-family: @description-font-family;
     }
    
    }
    
    
    Google web字体用于字体系列。 Web字体需要Internet连接,并且并非所有屏幕实现都会可靠连接。 离线模式规划是Screens部署的重要考虑事项。
  7. 复制客 shared 户端库文件夹。 将其粘贴为同级,然后将其重命名为 production
  8. 将生产 categories 客户端库的属性更新为 cq.screens.components.production.
    该类 cq.screens.components.production 别确保样式仅在“预览”/“生产”模式下加载。
    /apps/weretail-run/components/content/poster/clientlibs/production的属性
  9. 填充 /apps/weretail-run/components/content/poster/clientlibs/production/css/styles.less 以下内容:
    /*
     /apps/weretail-run/components/content/poster/clientlibs/production/css/styles.less
     Poster Component - Production Style
    */
    
    .cmp-poster {
    
        background-size: cover;
     height: 100%;
     width: 100%;
     position:absolute;
    
         &__text {
    
            top: 2em;
    
            &--left {
                width: 40%;
                top: 5em;
            }
    
            &--right {
                width: 40%;
                right: 1em;
            }
        }
    
        &__title {
      font-size: 5rem;
      font-weight: 900;
      margin: 0.1rem;
     }
    
     &__description {
      font-size: 2rem;
      margin: 0.1rem;
      font-weight: 400;
    
     }
    
        &__logo {
      position: absolute;
      max-width: 200px;
      top: 1em;
      left: 0;
     }
    
    }
    
    
    以上样式在屏幕上的绝对位置显示标题和说明。 标题将显示得比描述大得多。 使用组件的BEM记号,可以很轻松地在cmp-poster类中仔细地调整样式范围。
第三个clientlibrary类别:只能 cq.screens.components.edit 用于向组件添加“编辑”特定样式。
Clientlib类别
使用情况
cq.screens.components
在编辑模式和生产模式之间共享的样式和脚本
cq.screens.components.edit
仅在编辑模式中使用的样式和脚本
cq.screens.components.production
仅在生产模式中使用的样式和脚本

将海报组件添加到序列渠道

海报组件旨在用于序列渠道。 本教程的启动包包含一个空闲渠道。 空闲渠道已预配置为允许组 We.Retail Run —— 内容的组件 。 海报组件的组设置为并 We.Retail Run - Content 且可添加到渠道中。
  1. 从We.Retail Run项目打开Idle Channel: http://localhost:4502/editor.html/content/screens/we-retail-run/channels/idle-channel.edit.html
  2. 将海报组件的新实例从 侧栏拖放到页面上
  3. 编辑海报组件的对话框以添加图像、标题和说明。 使用“文本位置”和“文本颜色”选项可确保在图像上可读“标题/说明”。
  4. 重复上述步骤以添加几个海报组件。 在组件之间添加过渡。

整合

以下视频显示完成的组件以及如何将其添加到序列渠道。 然后,该渠道会添加到位置显示屏,并最终分配给Screens播放器。

完成的代码

下面是教程中完成的代码。 screens-weretail-run.ui.ap ps-0.0.1-SNAPSHOT.zip ​screens-weretail-run.ui.content-0.0.1-SNAPSHOT.zip是编译的AEM包。 SRC-screens-weretail-run-0.0.1.zip 是可使用Maven部署的未编译源代码。
SRC Final Screens We.Retail运行项目