El siguiente tutorial muestra los pasos para crear un componente personalizado para AEM Screens. AEM Screens AEM reutiliza muchos patrones de diseño y tecnologías existentes de otros productos de la. El tutorial destaca las diferencias y las consideraciones especiales al desarrollar para AEM Screens.
Este tutorial está diseñado para desarrolladores que son nuevos en AEM Screens. En este tutorial, se crea un componente "Hello World" simple para un canal de secuencia en AEM Screens. Un cuadro de diálogo permite a los autores actualizar el texto mostrado.
Para completar este tutorial, necesita lo siguiente:
Último paquete de funciones de Screens
Reproductor de AEM Screens
Entorno de desarrollo local
Los pasos y las capturas de pantalla del tutorial se realizan mediante CRXDE Lite. Los IDE también se pueden utilizar para completar el tutorial. Más información sobre cómo utilizar un IDE para desarrollar AEM con el que se puede encontrar aquí.
El código fuente de un proyecto de Screens se suele administrar como un proyecto Maven de varios módulos. Para acelerar el tutorial, se ha generado previamente un proyecto utilizando AEM Arquetipo de proyecto 13. Más información sobre AEM Puede encontrar aquí la creación de un proyecto con el tipo de archivo del proyecto de Maven.
Obtener archivo
Opcionalmente Si trabaja con Eclipse u otro IDE, descargue el siguiente paquete de origen. AEM Implemente el proyecto en una instancia de local mediante el comando Maven:
mvn -PautoInstallPackage clean install
Inicie el proyecto HelloWorld SRC Screens We.Retail Run
Entrada Administrador de paquetes CRX, compruebe que están instalados los dos paquetes siguientes:
Pantallas We.Retail Ejecutar paquetes Ui.Apps y Ui.Content instalados mediante el Administrador de paquetes CRX
El screens-weretail-run.ui.apps El paquete instala el 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.
En este tutorial, no se escribe ningún código Java™. Si se necesita una lógica empresarial más compleja, se puede crear e implementar el back-end Java™ mediante el paquete Java™ principal.
Representación del código ui.apps en CRXDE Lite
El helloworld
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 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 Screens. AEM El contenido debajo de todas estas rutas se actualiza principalmente en la sección de rutas de acceso 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 al proyecto AEM Screens > We.Retail Run:
AEM En el menú Inicio de la > Haga clic en el icono Screens. Compruebe que se puede ver el proyecto de ejecución de We.Retail.
El componente Hello World es un componente sencillo que permite al usuario introducir un mensaje para que se muestre en la pantalla. El componente se basa en Plantilla de componente de AEM Screens: https://github.com/Adobe-Marketing-Cloud/aem-screens-component-template.
AEM Screens tiene algunas restricciones interesantes que no son necesariamente verdaderas para los componentes tradicionales de WCM Sites.
Entrada CRXDE-Lite http://localhost:4502/crx/de/index.jsp
(o el IDE que prefiera), vaya a /apps/weretail-run/components/content/helloworld.
Añada las siguientes propiedades a helloworld
componente:
jcr:title="Hello World"
sling:resourceSuperType="foundation/components/parbase"
componentGroup="We.Retail Run - Content"
Propiedades de /apps/weretail-run/components/content/helloworld
El helloworld
El componente amplía el foundation/components/parbase para que pueda utilizarse correctamente dentro de un canal de secuencia.
Cree un archivo debajo de /apps/weretail-run/components/content/helloworld
nombrado helloworld.html.
Rellene el archivo con lo siguiente:
<!--/*
/apps/weretail-run/components/content/helloworld/helloworld.html
*/-->
<!--/* production: preview authoring mode + unspecified mode (that is, on publish) */-->
<sly data-sly-test.production="${wcmmode.preview || wcmmode.disabled}" data-sly-include="production.html" />
<!--/* edit: any other authoring mode, that is, edit, design, scaffolding, etc. */-->
<sly data-sly-test="${!production}" data-sly-include="edit.html" />
Los componentes de Screens requieren dos procesamientos diferentes, en función de qué modo de creación se está utilizando:
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 que utilizan los componentes de pantallas es tener un edit.html
para el modo de edición y una production.html
para el modo de producción.
Cree un archivo debajo de /apps/weretail-run/components/content/helloworld
nombrado 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>
El marcado de producción anterior es para el componente Hello World. A data-duration
se incluye ya que el componente se utiliza en un canal de secuencia. El data-duration
El canal de secuencia utiliza el atributo para saber durante cuánto tiempo se va a mostrar un elemento de secuencia.
El componente procesa un div
y un h1
etiqueta con texto. ${properties.message}
es una parte del script HTL que genera el contenido de una propiedad JCR denominada message
. Más adelante se crea un cuadro de diálogo que permite a un usuario introducir un valor para message
texto de propiedad.
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. BEM es la notación utilizada por AEM Componentes principales.
Cree un archivo debajo de /apps/weretail-run/components/content/helloworld
nombrado 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>
El marcado de edición anterior es para el componente Hello World. El primer bloque muestra una versión de edición 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 diálogo. El cq-placeholder
y data-emptytext
procesar la etiqueta Hello World como colocador en ese caso. La cadena de la etiqueta se puede internacionalizar con i18n para admitir la creación en varias configuraciones regionales.
Cuadro de diálogo Copiar imagen de Screens para utilizarlo en el componente Hello World.
Es más fácil comenzar desde un cuadro de diálogo existente y luego realizar modificaciones.
/libs/screens/core/components/content/image/cq:dialog
/apps/weretail-run/components/content/helloworld
Actualice el cuadro de diálogo Hola a todos 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 (ms)"
min="0"
name="./duration"/>
</items>
</column>
</items>
</sequence>
</items>
</content>
</jcr:root>
El textfield
para el mensaje se guarda en una propiedad denominada message
y que la numberfield
para la Duración se guarda en una propiedad denominada duration
. Ambas propiedades tienen referencias en /apps/weretail-run/components/content/helloworld/production.html
por HTL como ${properties.message}
y ${properties.duration}
.
Hello World: cuadro de diálogo completado
AEM Las bibliotecas del lado del cliente proporcionan un mecanismo para organizar y administrar los archivos CSS y JavaScript necesarios para una implementación de la.
Los componentes de AEM Screens se representan de forma diferente en el modo de edición frente al modo de previsualización/producción. Se crean dos bibliotecas de cliente: una para el modo de edición y otra para la vista previa/producción.
Cree una carpeta para las bibliotecas del lado del cliente para el componente Hello World.
Debajo /apps/weretail-run/components/content/helloworld
, cree una carpeta llamada clientlibs
.
Debajo del clientlibs
carpeta, cree un nodo llamado shared
de tipo cq:ClientLibraryFolder.
Agregue las siguientes propiedades a la biblioteca de cliente compartida:
allowProxy
| Booleana | 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/JS definido en sharedclientlib se carga en todos los modos.
Se recomienda no exponer nunca ninguna ruta directamente a /apps en un entorno de producción. La propiedad allowProxy garantiza que se haga referencia a la biblioteca de cliente CSS y JS mediante un prefijo of/etc.clientlibs.
Crear archivo con el nombre css.txt
debajo de la carpeta compartida.
Rellene el archivo con lo siguiente:
#base=css
styles.less
Cree una carpeta llamada css
debajo de shared
carpeta. Añada un archivo llamado style.less
debajo de css
carpeta. La estructura de las bibliotecas de cliente debería tener este aspecto:
En lugar de escribir CSS directamente, este tutorial utiliza LESS. MENOS 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.
Rellenar /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 shared
carpeta de biblioteca de cliente para crear una biblioteca de cliente llamada production
.
Copie la biblioteca de cliente compartida para crear una biblioteca de cliente de producción.
Actualice el categories
propiedad de la biblioteca de cliente de producción que se va a almacenar 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
Rellenar /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 de producción.
Una tercera categoría clientlibrary: cq.screens.components.edit
se puede usar para agregar estilos específicos de solo edición al componente.
Categoría de Clientlib | Uso |
---|---|
cq.screens.components |
Estilos y scripts compartidos entre los modos de edición y producción |
cq.screens.components.edit |
Estilos y scripts que solo se utilizan en el modo de edición |
cq.screens.components.production |
Estilos y scripts que solo se utilizan en el modo de producción |
AEM Screens utiliza Plantillas de página estáticas y Configuraciones de diseño para cambios globales. Las configuraciones de diseño se utilizan frecuentemente para configurar los componentes permitidos para Parsys en un canal. Una práctica recomendada es almacenar estas configuraciones de una manera específica de la aplicación.
A continuación se crea una página de diseño de ejecución de We.Retail que almacena todas las configuraciones específicas del proyecto de ejecución de We.Retail.
Entrada 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 diseños, con el nombre we-retail-run
con un tipo de cq:Page
.
Debajo del we-retail-run
, agregue otro nodo llamado jcr:content
de tipo nt:unstructured
. Añada las siguientes propiedades a jcr:content
nodo:
Nombre | Tipo | Valor |
---|---|---|
jcr:title | Cadena | Ejecución de We.Retail |
sling:resourceType | Cadena | wcm/core/components/designer |
cq:doctype | Cadena | html_5 |
Página de diseño en /apps/settings/wcm/designs/we-retail-run
El componente Hello World está diseñado para utilizarse en un canal de secuencias. Para probar el componente, se crea un nuevo Canal de secuencia.
AEM En el menú Inicio de la, vaya a Screens > Ejecución de We.Retail n > y seleccione Canales.
Haga clic en Crear botón
En el asistente Crear:
Paso de plantilla: elegir Canal de secuencia
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 a Diseño Modo.
Haga clic en llave Icono en Parsys para que pueda configurar los componentes permitidos.
Seleccione el Screens y el grupo Ejecución de We.Retail: contenido grupo.
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.
Entrada 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 el components
La propiedad ahora incluye group:Screens
, group:We.Retail Run - Content
.
Configuración de diseño en /apps/settings/wcm/designs/we-retail-run
Si el componente personalizado utiliza recursos externos, como recursos (imágenes, vídeos, fuentes e iconos), representaciones de recursos específicas o bibliotecas del lado del cliente (css y js), estos recursos no se añaden automáticamente a la configuración sin conexión. El motivo es que el Adobe solo agrupa el marcado del HTML de forma predeterminada.
Para permitirle personalizar y optimizar los recursos exactos que se descargan en el reproductor, Adobe ofrece un mecanismo de extensión para que los componentes personalizados expongan sus dependencias a la lógica de almacenamiento en caché sin conexión en Screens.
La sección siguiente muestra la plantilla para controladores de recursos sin conexión personalizados y los requisitos mínimos de la pom.xml
para ese proyecto específico.
package …;
import javax.annotation.Nonnull;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceUtil;
import org.apache.sling.api.resource.ValueMap;
import com.adobe.cq.screens.visitor.OfflineResourceHandler;
@Service(value = OfflineResourceHandler.class)
@Component(immediate = true)
public class MyCustomHandler extends AbstractResourceHandler {
@Reference
private …; // OSGi services injection
/**
* The resource types that are handled by the handler.
* @return the handled resource types
*/
@Nonnull
@Override
public String[] getSupportedResourceTypes() {
return new String[] { … };
}
/**
* Accept the provided resource, visit and traverse it as needed.
* @param resource The resource to accept
*/
@Override
public void accept(@Nonnull Resource resource) {
ValueMap properties = ResourceUtil.getValueMap(resource);
/* You can directly add explicit paths for offline caching using the `visit`
method of the visitor. */
// retrieve a custom property from the component
String myCustomRenditionUrl = properties.get("myCustomRenditionUrl", String.class);
// adding that exact asset/rendition/path to the offline manifest
this.visitor.visit(myCustomRenditionUrl);
/* You can delegate handling for dependent resources so they are also added to
the offline cache using the `accept` method of the visitor. */
// retrieve a referenced dependent resource
String referencedResourcePath = properties.get("myOtherResource", String.class);
ResourceResolver resolver = resource.getResourceResolver();
Resource referencedResource = resolver.getResource(referencedResourcePath);
// let the handler for that resource handle it
if (referencedResource != null) {
this.visitor.accept(referencedResource);
}
}
}
El siguiente código proporciona los requisitos mínimos en la pom.xml
para ese proyecto específico:
<dependencies>
…
<!-- Felix annotations -->
<dependency>
<groupId>org.apache.felix</groupId>
<artifactId>org.apache.felix.scr.annotations</artifactId>
<version>1.9.0</version>
<scope>provided</scope>
</dependency>
<!-- Screens core bundle with OfflineResourceHandler/AbstractResourceHandler -->
<dependency>
<groupId>com.adobe.cq.screens</groupId>
<artifactId>com.adobe.cq.screens</artifactId>
<version>1.5.90</version>
<scope>provided</scope>
</dependency>
…
</dependencies>
El siguiente vídeo muestra el componente terminado y cómo se puede añadir a un canal de secuencia. A continuación, el canal se añade a una pantalla de ubicación y, finalmente, se asigna a un reproductor de Screens.
A continuación se muestra el código terminado del tutorial. El screens-weretail-run.ui.apps-0.0.1-SNAPSHOT.zip y screens-weretail-run.ui.content-0.0.1-SNAPSHOT.zip AEM son los paquetes compilados de la. El ** **SRC-screens-weretail-run-0.0.1.zip es el código fuente no compilado que se puede implementar mediante Maven.