Desarrollo de un componente personalizado para AEM Screens developing-a-custom-component-for-aem-screens

AEM 6.5 más el último paquete de funciones de Screens.

Reproductor de AEM Screens

Entorno de desarrollo local

En Administrador de paquetes de CRX, compruebe que estén instalados los dos paquetes siguientes:

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 Ejecutar Ui.Apps y Ui.Content paquetes instalados mediante el Administrador de paquetes de CRX.

El paquete screens-weretail-run.ui.apps instala código debajo de /apps/weretail-run.

Este paquete contiene el código responsable de procesar los componentes personalizados del proyecto. Este paquete incluye código de componente y cualquier JavaScript o CSS necesario. Este paquete también incrusta screens-weretail-run.core-0.0.1-SNAPSHOT.jar que contiene cualquier código Java™ necesario para el proyecto.

Representación del código ui.apps en CRXDE Lite

El componente Hello World es solo un marcador de posición. A lo largo del tutorial, se añade una funcionalidad que permite al autor actualizar el mensaje mostrado por el componente.

El paquete screens-weretail-run.ui.content instala el código debajo de:

• /conf/we-retail-run
• /content/dam/we-retail-run
• /content/screens/we-retail-run

Este paquete contiene el contenido de inicio y la estructura de configuración necesaria para el proyecto. /conf/we-retail-run contiene todas las configuraciones para el proyecto de ejecución de We.Retail. /content/dam/we-retail-run incluye el inicio de recursos digitales para el proyecto. /content/screens/we-retail-run contiene la estructura de contenido de Screens. AEM El contenido de todas estas rutas se actualiza principalmente en la página de la página de la página de la página de la. Para promover la coherencia entre entornos (local, Dev, Stage, Prod), a menudo se guarda una estructura de contenido base en el control de código fuente.

Vaya a AEM Screens > We.Retail Ejecutar proyecto:

AEM En el menú Inicio de la, haga clic en el icono Screens. Compruebe que se ve el proyecto de ejecución We.Retail.

En CRXDE-Lite http://localhost:4502/crx/de/index.jsp (o IDE de su elección), vaya a /apps/weretail-run/components/content/helloworld.

Agregue las siguientes propiedades al componente helloworld:

    jcr:title="Hello World"
    sling:resourceSuperType="foundation/components/parbase"
    componentGroup="We.Retail Run - Content"

Propiedades de /apps/weretail-run/components/content/helloworld

El componente Hello World amplía el componente foundation, components, parbase para que pueda utilizarse correctamente dentro de un canal de secuencia.

Crear un archivo debajo de /apps/weretail-run/components/content/helloworld con el nombre helloworld.html.

Rellene el archivo con lo siguiente:

<!--/*

 /apps/weretail-run/components/content/helloworld/helloworld.html

*/-->

<!--/* production: preview authoring mode + unspecified mode (i.e. on publish) */-->
<sly data-sly-test.production="${wcmmode.preview || wcmmode.disabled}" data-sly-include="production.html" />

<!--/* edit: any other authoring mode, i.e. edit, design, scaffolding, etc. */-->
<sly data-sly-test="${!production}" data-sly-include="edit.html" />

Los componentes de Screens requieren dos procesamientos diferentes según el modo de creación que se esté usando:

1. Producción: modo de vista previa o Publish (wcmmode=disabled)
2. Editar: se usa para todos los demás modos de creación, es decir, edición, diseño, andamiaje, desarrollador…

helloworld.html actúa como un conmutador, comprobando qué modo de creación está activo y redirigiendo a otro script HTL. Una convención común utilizada por los componentes de pantallas es tener un script edit.html para el modo de edición y un script production.html para el modo de producción.

Crear un archivo debajo de /apps/weretail-run/components/content/helloworld con el nombre production.html.

Rellene el archivo con lo siguiente:

<!--/*
 /apps/weretail-run/components/content/helloworld/production.html

*/-->

<div data-duration="${properties.duration}" class="cmp-hello-world">
 <h1 class="cmp-hello-world__message">${properties.message}</h1>
</div>

Lo anterior es el marcado de producción para el componente Hello World. Se incluye un atributo data-duration porque el componente se usa en un canal de secuencia. El canal de secuencia utiliza el atributo data-duration para saber durante cuánto tiempo se va a mostrar un elemento de secuencia.

El componente procesa una etiqueta div y una etiqueta h1 con texto. ${properties.message} es una parte del script HTL que genera el contenido de una propiedad JCR llamada message. Más adelante se crea un cuadro de diálogo que permite al usuario escribir un valor para el texto de la propiedad message.

Tenga en cuenta también que la notación BEM (Modificador de elementos de bloque) se utiliza con el componente. BEM es una convención de codificación CSS que facilita la creación de componentes reutilizables. AEM BEM es la notación utilizada por componentes principales de la clasede la clase .

Crear un archivo debajo de /apps/weretail-run/components/content/helloworld con el nombre edit.html.

Rellene el archivo con lo siguiente:

<!--/*

 /apps/weretail-run/components/content/helloworld/edit.html

*/-->

<!--/* if message populated */-->
<div
 data-sly-test.message="${properties.message}"
 class="aem-Screens-editWrapper cmp-hello-world">
 <p class="cmp-hello-world__message">${message}</p>
</div>

<!--/* empty place holder */-->
<div data-sly-test="${!message}"
     class="aem-Screens-editWrapper cq-placeholder cmp-hello-world"
     data-emptytext="${'Hello World' @ i18n, locale=request.locale}">
</div>

Lo anterior es el marcado editado para el componente Hello World. El primer bloque muestra una versión editada del componente si se ha rellenado el mensaje de diálogo.

El segundo bloque se representa si no se ha introducido ningún mensaje de cuadro de diálogo. cq-placeholder y data-emptytext representan la etiqueta Hello World como marcador de posición en ese caso. La cadena de la etiqueta se puede internacionalizar con i18n para admitir la creación en varias configuraciones regionales.

Copiar cuadro de diálogo de imagen de Screens para usar en el componente Hello World.

Es más fácil comenzar desde un cuadro de diálogo existente y luego realizar modificaciones.

1. Copiar el cuadro de diálogo de: /libs/screens/core/components/content/image/cq:dialog
2. Pegar el cuadro de diálogo debajo de /apps/weretail-run/components/content/helloworld

Actualice el cuadro de diálogo Hello World para incluir una ficha para el mensaje.

Actualice el cuadro de diálogo para que coincida con lo siguiente. La estructura del nodo JCR del cuadro de diálogo final se presenta a continuación en 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="nt:unstructured"
    jcr:title="Hello World"
    sling:resourceType="cq/gui/components/authoring/dialog">
    <content
        jcr:primaryType="nt:unstructured"
        sling:resourceType="granite/ui/components/coral/foundation/tabs"
        size="L">
        <items jcr:primaryType="nt:unstructured">
            <message
                jcr:primaryType="nt:unstructured"
                jcr:title="Message"
                sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns">
                <items jcr:primaryType="nt:unstructured">
                    <column
                        jcr:primaryType="nt:unstructured"
                        sling:resourceType="granite/ui/components/coral/foundation/container">
                        <items jcr:primaryType="nt:unstructured">
                            <message
                                jcr:primaryType="nt:unstructured"
                                sling:resourceType="granite/ui/components/coral/foundation/form/textfield"
                                fieldDescription="Message for component to display"
                                fieldLabel="Message"
                                name="./message"/>
                        </items>
                    </column>
                </items>
            </message>
            <sequence
                jcr:primaryType="nt:unstructured"
                jcr:title="Sequence"
                sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns">
                <items jcr:primaryType="nt:unstructured">
                    <column
                        jcr:primaryType="nt:unstructured"
                        sling:resourceType="granite/ui/components/coral/foundation/container">
                        <items jcr:primaryType="nt:unstructured">
                            <duration
                                jcr:primaryType="nt:unstructured"
                                sling:resourceType="granite/ui/components/coral/foundation/form/numberfield"
                                defaultValue=""
                                fieldDescription="Amount of time the image is shown in the sequence, in milliseconds"
                                fieldLabel="Duration (milliseconds)"
                                min="0"
                                name="./duration"/>
                        </items>
                    </column>
                </items>
            </sequence>
        </items>
    </content>
</jcr:root>

El campo de texto del mensaje se guarda en una propiedad denominada message y el campo de número de la propiedad Duration se guarda en una propiedad denominada duration. HTL hace referencia a estas dos propiedades en /apps/weretail-run/components/content/helloworld/production.html como ${properties.message} y ${properties.duration}.

Hello World - diálogo completado

Cree una carpeta para las bibliotecas del lado del cliente para el componente Hello World.

Debajo de /apps/weretail-run/components/content/helloworld, cree una carpeta denominada clientlibs.

Bajo la carpeta clientlibs, cree un nodo denominado shared de tipo cq:ClientLibraryFolder.

Agregue las siguientes propiedades a la biblioteca de cliente compartida:

• allowProxy | Booleano | true

• categories| Cadena[] | cq.screens.components

Propiedades de /apps/weretail-run/components/content/helloworld/clientlibs/shared

La propiedad categories es una cadena que identifica la biblioteca de cliente. La categoría cq.screens.components se utiliza en los modos Edición y Previsualización-Producción. Por lo tanto, cualquier CSS o JS definido en sharedclientlib se carga en todos los modos.

Como práctica recomendada, las rutas de acceso directas a /apps en un entorno de producción nunca deben exponerse. La propiedad allowProxy garantiza que se haga referencia a CSS y JS de la biblioteca de cliente mediante un prefijo de /etc.clientlibs.

Cree un archivo con el nombre css.txt debajo de la carpeta compartida.

Rellene el archivo con lo siguiente:

#base=css

styles.less

Cree una carpeta denominada css debajo de la carpeta shared. Agregue un archivo de nombre style.less debajo de la carpeta css. La estructura de las bibliotecas de cliente debería tener este aspecto:

En lugar de escribir CSS directamente, este tutorial utiliza LESS. LESS es un precompilador de CSS popular que admite variables, mezclas y funciones CSS. AEM Las bibliotecas de cliente de admiten de forma nativa la compilación LESS. AEM Sass u otros pre-compiladores pueden ser utilizados pero deben ser compilados fuera de la.

Rellene /apps/weretail-run/components/content/helloworld/clientlibs/shared/css/styles.less con lo siguiente:

/**
    Shared Styles
   /apps/weretail-run/components/content/helloworld/clientlibs/shared/css/styles.less

**/

.cmp-hello-world {
    background-color: #fff;

 &__message {
  color: #000;
  font-family: Helvetica;
  text-align:center;
 }
}

Copie y pegue la carpeta de biblioteca de cliente shared para crear una biblioteca de cliente llamada production.

Copie la biblioteca de cliente compartida para crear una biblioteca de cliente de producción.

Actualizar la propiedad categories de la biblioteca de cliente de producción a cq.screens.components.production.

Al hacerlo, se garantiza que los estilos solo se carguen en el modo de Previsualización-Producción.

Propiedades de /apps/weretail-run/components/content/helloworld/clientlibs/production.

Rellene /apps/weretail-run/components/content/helloworld/clientlibs/production/css/styles.less con lo siguiente:

/**
    Production Styles
   /apps/weretail-run/components/content/helloworld/clientlibs/production/css/styles.less

**/
.cmp-hello-world {

    height: 100%;
    width: 100%;
    position: fixed;

 &__message {

  position: relative;
  font-size: 5rem;
  top:25%;
 }
}

Los estilos anteriores muestran el mensaje centrado en el centro de la pantalla, pero solo en el modo Producción.

En CRXDE Lite http://localhost:4502/crx/de/index.jsp#/apps/settings/wcm/designs, vaya a /apps/settings/wcm/designs.

Cree un nodo debajo de la carpeta de diseños, denominado we-retail-run con un tipo de cq:Page.

Bajo la página we-retail-run, agregue otro nodo denominado jcr:content de tipo nt:unstructured. Agregue las siguientes propiedades al nodo jcr:content:

Página de diseño en /apps/settings/wcm/designs/we-retail-run.

AEM En el menú Inicio de la, vaya a Screens > We.RetailEjecutar > y haga clic en Canales.

Haga clic en el botón Crear

1. Elija Crear entidad

En el asistente Crear:

Paso de plantilla: elija Canal de secuencia

1. Paso Propiedades

• Pestaña básica > Título = Canal inactivo
• Pestaña Canal > marca Hacer canal en línea

Abra las propiedades de página del canal inactivo.

Actualice el campo Diseño para que señale a /apps/settings/wcm/designs/we-retail-run, la página de diseño creada en la sección anterior.

Configuración de diseño que señala a /apps/settings/wcm/designs/we-retail-run

Edite el canal inactivo recién creado para poder abrirlo.

Cambiar el modo de página al modo Diseño.

1. Haga clic en el icono wrench en Parsys para que pueda configurar los componentes permitidos.

2. Haga clic en el grupo Screens y en el grupo We.RetailEjecutar - Contenido.

Cambiar el modo de página a Editar. Ahora, el componente Hello World se puede agregar a la página y combinarse con otros componentes de canal de secuencia.

En CRXDE Lite http://localhost:4502/crx/de/index.jsp#/apps/settings/wcm/designs/we-retail-run/jcr%3Acontent/sequencechannel/par, vaya a /apps/settings/wcm/designs/we-retail-run/jcr:content/sequencechannel/par. Observe que la propiedad components ahora incluye group:Screens, group:We.Retail Run - Content.

Configuración de diseño en /apps/settings/wcm/designs/we-retail-run