Guía de referencia de componentes

AEM Los componentes son el núcleo de la creación de una experiencia en la. El Componentes principales y el AEM Tipo de archivo del proyecto facilite la introducción a un conjunto de herramientas de componentes sólidos y listos para usar. El Tutorial de WKND AEM le explica al desarrollador cómo utilizar estas herramientas y cómo crear componentes personalizados para crear un sitio de.

Dado que el tutorial de WKND cubre la mayoría de los casos de uso, este documento está diseñado únicamente como complemento de esos recursos. AEM Ofrece detalles técnicos detallados sobre cómo se estructuran y configuran los componentes en los componentes de y no está diseñado como guía de introducción a la configuración de los componentes de.

Información general

Esta sección abarca conceptos y problemas clave como introducción a los detalles necesarios al desarrollar sus propios componentes.

Planificación

Antes de empezar a configurar o codificar el componente, debe preguntar lo siguiente:

• ¿Qué debe hacer exactamente el nuevo componente?
• ¿Necesita crear el componente desde cero o puede heredar los conceptos básicos de un componente existente?
• ¿Requerirá su componente lógica para seleccionar o manipular el contenido?
  • La lógica debe mantenerse separada de la capa de interfaz de usuario. HTL está diseñado para ayudar a garantizar que esto suceda.
• ¿Necesitará el componente formato CSS?
  • El formato CSS debe mantenerse separado de las definiciones de componentes. Defina convenciones para asignar un nombre a los elementos del HTML para que pueda modificarlos a través de archivos CSS externos.
• ¿Qué implicaciones de seguridad puede introducir su nuevo componente?

Reutilización de componentes existentes

Antes de invertir tiempo en crear un componente completamente nuevo, considere la posibilidad de personalizar o ampliar los componentes existentes. Los componentes principales ofrece un conjunto de componentes flexibles, sólidos y probados listos para la producción.

Ampliación de componentes principales

Los componentes principales también ofrecen borrar patrones de personalización que puede utilizar para adaptarlas a las necesidades de su propio proyecto.

Superposición de componentes

Los componentes también se pueden redefinir con una superposición en función de la lógica de ruta de búsqueda. Sin embargo, en tal caso, la Fusión de recursos de Sling no se activará y /apps debe definir toda la superposición.

Ampliación de cuadros de diálogo de componentes

También es posible anular un cuadro de diálogo de componente mediante la Fusión de recursos de Sling y definiendo la propiedad sling:resourceSuperType.

Esto significa que solo necesita redefinir las diferencias necesarias, en lugar de redefinir todo el cuadro de diálogo.

Lógica de contenido y marcado de procesamiento

El componente se procesará con HTML. El componente debe definir el HTML necesario para tomar el contenido necesario y luego procesarlo según sea necesario, en los entornos de creación y publicación.

Se recomienda mantener el código responsable del marcado y el procesamiento separado del código que controla la lógica utilizada para seleccionar el contenido del componente.

Esta filosofía está respaldada por HTL, un lenguaje de creación de plantillas que se limita intencionadamente para garantizar que se utiliza un lenguaje de programación real para definir la lógica empresarial subyacente. Este mecanismo resalta el código que se llama para una vista determinada y, si es necesario, permite una lógica específica para diferentes vistas del mismo componente.

Esta lógica (opcional) se puede implementar de diferentes maneras y se invoca desde HTL con comandos específicos:

• Uso de Java: La API de uso de Java de HTL permite que un archivo HTL acceda a los métodos de ayuda en una clase Java personalizada. Esto permite utilizar código Java para implementar la lógica de selección y configuración del contenido del componente.
• Uso de JavaScript - La API de uso de JavaScript de HTL permite que un archivo HTL acceda al código de ayuda escrito en JavaScript. Esto permite utilizar código JavaScript para implementar la lógica de selección y configuración del contenido del componente.
• Uso de bibliotecas del lado del cliente: los sitios web modernos dependen en gran medida del procesamiento del lado del cliente impulsado por código CSS y JavaScript complejo. Ver el documento AEM as a Cloud Service Uso de bibliotecas del lado del cliente en el uso de para obtener más información.

Estructura del componente

AEM La estructura de un componente de es potente y flexible. Las partes principales son:

• Tipo de medio
• Definición del componente
• Propiedades y nodos secundarios de un componente
• Cuadros de diálogo
• Cuadros de diálogo de diseño

Tipo de medio

Un elemento clave de la estructura es el tipo de recurso.

• La estructura de contenido declara intenciones.
• El tipo de recurso los implementa.

Esta es una abstracción que ayuda a garantizar que incluso cuando la apariencia cambia con el tiempo, la intención se mantiene en el tiempo.

Definición del componente

La definición de un componente se puede desglosar de la siguiente manera:

• AEM Los componentes de la se basan en Sling.
• AEM Los componentes de la se encuentran en /libs/core/wcm/components.
• Los componentes específicos del proyecto/sitio se encuentran en /apps/<myApp>/components.
• AEM Los componentes estándar de la se definen como cq:Component y tienen los elementos clave:
  • Propiedades de jcr: una lista de propiedades de jcr. Son variables y algunas pueden ser opcionales a través de la estructura básica de un nodo de componente, sus propiedades y subnodos se definen mediante cq:Component definición.
  • Recursos: definen los elementos estáticos utilizados por el componente.
  • Scripts: se utilizan para implementar el comportamiento de la instancia resultante del componente.

Propiedades vitales

• Nodo raíz:
  • <mycomponent> (cq:Component) : nodo de jerarquía del componente.
• Propiedades vitales:
  • jcr:title : título del componente; por ejemplo, se utiliza como etiqueta cuando el componente aparece en la lista de Navegador de componentes y Consola Componentes
  • jcr:description : descripción del componente; se utiliza como sugerencia para pasar el ratón en el navegador de componentes y la consola de componentes.
  • Consulte la sección Icono de componente para obtener más información
• Nodos secundarios vitales:
  • cq:editConfig (cq:EditConfig) : define las propiedades de edición del componente y permite que este aparezca en el navegador de componentes
    • Si el componente tiene un cuadro de diálogo, aparecerá automáticamente en el explorador o Sidekick de componentes, aunque cq:editConfig no exista.
  • cq:childEditConfig (cq:EditConfig) : controla los aspectos de la IU de autor de los componentes secundarios que no definen los suyos propios cq:editConfig.
  • cq:dialog (nt:unstructured) : cuadro de diálogo para este componente. Define la interfaz que permite al usuario configurar el componente o editar contenido.
  • cq:design_dialog (nt:unstructured) - Edición de diseño para este componente

Icono de componente

El icono o la abreviatura del componente se define mediante las propiedades JCR del componente cuando el desarrollador lo crea. Estas propiedades se evalúan en el siguiente orden y se utiliza la primera propiedad válida encontrada.

1. cq:icon : propiedad de cadena que señala a un icono estándar en la variable Biblioteca de IU de Coral para mostrar en el navegador de componentes
   • Utilice el valor del atributo HTML del icono Coral.
2. abbreviation : propiedad de cadena para personalizar la abreviatura del nombre del componente en el explorador de componentes
   • La abreviatura debe estar limitada a dos caracteres.
   • Si se proporciona una cadena vacía, se creará la abreviatura a partir de los dos primeros caracteres del jcr:title propiedad.
     • Por ejemplo, "Im" para "Image"
     • El título localizado se utiliza para crear la abreviatura.
   • La abreviatura solo se traduce si el componente tiene un abbreviation_commentI18n , que luego se utiliza como sugerencia de traducción.
3. cq:icon.png o cq:icon.svg : icono para este componente, que se muestra en el navegador de componentes
   • 20 x 20 píxeles es el tamaño de los iconos de los componentes estándar.
     • Los iconos más grandes se reducen (del lado del cliente).
   • El color recomendado es rgb(112, 112, 112) > #707070
   • El fondo de los iconos de componentes estándar es transparente.
   • Solo .png y .svg son compatibles.
   • Si se realiza la importación desde el sistema de archivos mediante el complemento Eclipse, los nombres de archivo deben evitarse como _cq_icon.png o _cq_icon.svg por ejemplo.
   • .png tiene precedentes sobre .svg si ambos están presentes.

Si ninguna de las propiedades anteriores (cq:icon, abbreviation, cq:icon.png o cq:icon.svg) se encuentran en el componente:

• El sistema buscará las mismas propiedades en los supercomponentes siguiendo el sling:resourceSuperType propiedad.
• Si no se encuentra nada o una abreviatura vacía en el nivel de supercomponente, el sistema creará la abreviatura a partir de las primeras letras del jcr:title del componente actual.

Para cancelar la herencia de los iconos de los supercomponentes, configure un valor empty abbreviation La propiedad en el componente volverá al comportamiento predeterminado.

El Consola de componente muestra cómo se define el icono de un componente en particular.

Ejemplo de icono de SVG

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "https://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="https://www.w3.org/2000/svg" xmlns:xlink="https://www.w3.org/1999/xlink" x="0px" y="0px"
     width="20px" height="20px" viewBox="0 0 20 20" enable-background="new 0 0 20 20" xml:space="preserve">
    <ellipse cx="5" cy="5" rx="3" ry="3" fill="#707070"/>
    <ellipse cx="15" cy="5" rx="4" ry="4" fill="#707070"/>
    <ellipse cx="5" cy="15" rx="5" ry="5" fill="#707070"/>
    <ellipse cx="15" cy="15" rx="4" ry="4" fill="#707070"/>
</svg>

Propiedades y nodos secundarios de un componente

Muchos de los nodos o propiedades necesarios para definir un componente son comunes a ambas IU, y las diferencias permanecen independientes para que el componente pueda trabajar en ambos entornos.

Un componente es un nodo de tipo cq:Component y tiene las siguientes propiedades y nodos secundarios:

Si mira el Texto puede ver varios de estos elementos:

Las propiedades de interés particular incluyen:

• jcr:title : título del componente utilizado para identificar el componente en el navegador de componentes.
• jcr:description : esta es la descripción del componente.
• sling:resourceSuperType - Indica la ruta de la herencia al ampliar un componente (anulando una definición).

Los nodos secundarios de interés particular incluyen:

• cq:editConfig : controla los aspectos visuales del componente al editarlo.
• cq:dialog : define el cuadro de diálogo para editar el contenido de este componente.
• cq:design_dialog : especifica las opciones de edición de diseño de este componente.

Cuadros de diálogo

Los cuadros de diálogo son un elemento clave del componente, ya que proporcionan una interfaz para que los autores configuren el componente en una página de contenido y proporcionen entradas para ese componente. Consulte la documentación de creación para obtener más información sobre cómo los autores de contenido interactúan con los componentes.

Según la complejidad del componente, el cuadro de diálogo puede necesitar una o más pestañas.

AEM Cuadros de diálogo para componentes de la:

• Son cq:dialog nodos de tipo nt:unstructured.
• Se encuentran debajo de su cq:Component y junto a sus definiciones de componentes.
• Defina el cuadro de diálogo para editar el contenido de este componente.
• Se definen con los componentes de la interfaz de usuario de Granite.
• Se procesan en el lado del servidor (como componentes de Sling), según su estructura de contenido y el sling:resourceType propiedad.
• Contiene una estructura de nodos que describe los campos del cuadro de diálogo
  • Estos nodos son nt:unstructured con el requerido sling:resourceType propiedad.

En el cuadro de diálogo, se definen campos individuales:

Cuadros de diálogo de diseño

Los cuadros de diálogo de diseño son similares a los utilizados para editar y configurar contenido, pero proporcionan la interfaz para que los autores de plantillas preconfiguren y proporcionen detalles de diseño para ese componente en una plantilla de página. Los autores de contenido utilizan las plantillas de página para crear páginas de contenido. Consulte la documentación de plantilla para obtener más información sobre cómo se crean las plantillas.

Los cuadros de diálogo de diseño se utilizan al editar una plantilla de página, aunque no son necesarios para todos los componentes. Por ejemplo, la variable Título y Componentes de imagen ambos tienen cuadros de diálogo de diseño, mientras que la variable Componente Compartir en redes sociales no lo tiene.

IU de Coral e IU de Granite

AEM La interfaz de usuario de Coral y la interfaz de usuario de Granite definen la apariencia de los recursos de la interfaz de usuario de.

• IU de Coral proporciona una IU coherente en todas las soluciones de la nube.
• Granite UI proporciona marcado de la IU de Coral envuelto en componentes de Sling para crear consolas y cuadros de diálogo de IU.

La interfaz de usuario de Granite proporciona una amplia gama de widgets básicos necesarios para crear el cuadro de diálogo en el entorno de creación. Si es necesario, puede ampliar esta selección y crear su propio widget.

Para obtener más información, consulte los siguientes recursos:

• Estructura de la IU de AEM

Personalización de campos de diálogo

Para crear un widget para utilizarlo en un cuadro de diálogo de componentes, es necesario crear un componente de campo de interfaz de usuario de Granite.

Si considera el cuadro de diálogo como un contenedor simple para un elemento de formulario, también puede ver el contenido principal del cuadro de diálogo como campos de formulario. La creación de un nuevo campo de formulario requiere la creación de un tipo de recurso; esto equivale a la creación de un componente. Para ayudarle en esa tarea, la interfaz de usuario de Granite ofrece un componente de campo genérico del que heredar (mediante sling:resourceSuperType):

/libs/granite/ui/components/coral/foundation/form/field

Más específicamente, la interfaz de usuario de Granite proporciona una serie de componentes de campo que son adecuados para su uso en diálogos o, más generalmente, en formularios.

Una vez creado el tipo de recurso, puede crear una instancia del campo añadiendo un nuevo nodo en el cuadro de diálogo, con la propiedad sling:resourceType haciendo referencia al tipo de recurso que acaba de introducir.

Acceso a campos de diálogo

También puede utilizar condiciones de procesamiento (rendercondition) para controlar quién tiene acceso a pestañas/campos específicos del cuadro de diálogo; por ejemplo:

+ mybutton
  - sling:resourceType = granite/ui/components/coral/foundation/button
  + rendercondition
    - sling:resourceType = myapp/components/renderconditions/group
    - groups = ["administrators"]

Uso de componentes

Una vez creado un componente, debe habilitarlo para utilizarlo. Su uso muestra cómo se relaciona la estructura del componente con la estructura del contenido resultante en el repositorio.

Adición del componente a la plantilla

Una vez definido un componente, debe estar disponible para su uso. Para que un componente esté disponible para utilizarlo en una plantilla, debe habilitarlo en la directiva del contenedor de diseño de la plantilla.

Consulte la documentación de plantilla para obtener más información sobre cómo se crean las plantillas.

Componentes y el contenido que crean

Si creamos y configuramos una instancia de Título en la página: /content/wknd/language-masters/en/adventures/extreme-ironing.html

A continuación, podemos ver la estructura del contenido creado dentro del repositorio:

En particular, si observa el texto real de una Componente Título:

• El contenido contiene un jcr:title propiedad que contiene el texto real del título introducido por el autor.
• También contiene un sling:resourceType referencia a la definición del componente.

Las propiedades definidas dependen de las definiciones individuales. Aunque pueden ser más complejos que los anteriores, siguen los mismos principios básicos.

Jerarquía y herencia de componentes

AEM Los componentes dentro de la lista de componentes de están sujetos a la Jerarquía de tipos de recursos. Se utiliza para ampliar componentes mediante la propiedad sling:resourceSuperType. Esto permite que el componente herede de otro componente.

Consulte la sección Reutilización de componentes para obtener más información.

Editar comportamiento

En esta sección se explica cómo configurar el comportamiento de edición de un componente. Esto incluye atributos como las acciones disponibles para el componente, las características del editor in.situ y los oyentes relacionados con los eventos del componente.

El comportamiento de edición de un componente se configura añadiendo una variable cq:editConfig nodo de tipo cq:EditConfig debajo del nodo de componente (de tipo cq:Component) y agregando propiedades específicas y nodos secundarios. Están disponibles las siguientes propiedades y nodos secundarios:

• cq:editConfig propiedades del nodo
• cq:editConfig nodos secundarios:
  • cq:dropTargets (tipo de nodo) nt:unstructured): define una lista de destinos de colocación que pueden aceptar una colocación desde un recurso del buscador de contenido (se permite un solo destino de colocación).
  • cq:inplaceEditing (tipo de nodo) cq:InplaceEditingConfig): define una configuración de edición in situ para el componente
  • cq:listeners (tipo de nodo) cq:EditListenersConfig): define lo que sucede antes o después de que se produzca una acción en el componente

AEM Hay muchas configuraciones existentes en la. Puede buscar fácilmente propiedades específicas o nodos secundarios mediante la herramienta de consulta en CRXDE Lite.

Marcadores de posición de componentes

Los componentes siempre deben procesar algún HTML visible para el autor, incluso cuando el componente no tenga contenido. De lo contrario, podría desaparecer visualmente de la interfaz del editor, lo que lo haría técnicamente presente, pero invisible en la página y en el editor. En tal caso, los autores no podrán seleccionar e interactuar con el componente vacío.

Por este motivo, los componentes deben representar un marcador de posición siempre que no representen ningún resultado visible cuando la página se procese en el editor de páginas (cuando el modo WCM esté edit o preview).
El marcado de HTML típico para un marcador de posición es el siguiente:

<div class="cq-placeholder" data-emptytext="Component Name"></div>

La secuencia de comandos HTL típica que procesa el HTML de marcador de posición anterior es la siguiente:

<div class="cq-placeholder" data-emptytext="${component.properties.jcr:title}"
     data-sly-test="${(wcmmode.edit || wcmmode.preview) && isEmpty}"></div>

En el ejemplo anterior, isEmpty es una variable que es verdadera solo cuando el componente no tiene contenido y es invisible para el autor.

Para evitar repeticiones, Adobe recomienda que los implementadores de componentes utilicen una plantilla HTL para estos marcadores de posición, como el que proporcionan los componentes principales.

El uso de la plantilla en el vínculo anterior se realiza con la siguiente línea de HTL:

<sly data-sly-use.template="core/wcm/components/commons/v1/templates.html"
     data-sly-call="${template.placeholder @ isEmpty=!model.text}"></sly>

En el ejemplo anterior, model.text es la variable que es verdadera solo cuando el contenido tiene contenido y es visible.

Puede ver un ejemplo de uso de esta plantilla en los componentes principales, como en el Componente Título.

Configurar con nodos secundarios cq:EditConfig

Colocación de recursos en un cuadro de diálogo: cq:dropTargets

El cq:dropTargets node (tipo de nodo) nt:unstructured) define el destino de colocación que puede aceptar una colocación de un recurso arrastrado desde el buscador de contenido. Es un nodo de tipo cq:DropTargetConfig.

El nodo secundario de tipo cq:DropTargetConfig define un destino de colocación en el componente.

Edición in situ: cq:inplaceEditing

Un editor in situ permite al usuario editar contenido directamente en el flujo de contenido, sin necesidad de abrir un cuadro de diálogo. Por ejemplo, el estándar Texto y Título ambos componentes tienen un editor en contexto.

Un editor in situ no es necesario ni significativo para cada tipo de componente.

El cq:inplaceEditing node (tipo de nodo) cq:InplaceEditingConfig) define una configuración de edición in situ para el componente. Puede tener las siguientes propiedades:

La siguiente configuración permite la edición in situ del componente y define lo siguiente plaintext como tipo de editor:

    <cq:inplaceEditing
        jcr:primaryType="cq:InplaceEditingConfig"
        active="{Boolean}true"
        editorType="plaintext"/>

Gestión de eventos de campo - cq:listeners

El método de control de eventos en los campos de diálogo se realiza con los oyentes en un biblioteca de cliente.

Para introducir lógica en el campo, debe:

• Marque el campo con una clase CSS determinada (el vínculo ).
• Defina en la biblioteca de cliente un oyente JS conectado a ese nombre de clase CSS (esto garantiza que la lógica personalizada solo esté vinculada al campo y no afecte a otros campos del mismo tipo).

Para conseguirlo, debe conocer la biblioteca de widgets subyacente con la que desea interactuar. Consulte la documentación de Coral UI para identificar a qué evento desea reaccionar.

El cq:listeners node (tipo de nodo) cq:EditListenersConfig) define lo que sucede antes o después de una acción en el componente. La siguiente tabla define sus posibles propiedades.

El controlador de eventos se puede implementar con una implementación personalizada. Por ejemplo, (donde project.customerAction es un método estático):

afteredit = "project.customerAction"

El siguiente ejemplo equivale a la variable REFRESH_INSERTED configuración:

afterinsert="function(path, definition) { this.refreshCreated(path, definition); }"

Con la siguiente configuración, la página se actualiza después de eliminar, editar, insertar o mover el componente:

    <cq:listeners
        jcr:primaryType="cq:EditListenersConfig"
        afterdelete="REFRESH_PAGE"
        afteredit="REFRESH_PAGE"
        afterinsert="REFRESH_PAGE"
        afterMove="REFRESH_PAGE"/>

Validación de campos

La validación de campos en la IU de Granite y en los widgets de la IU de Granite se realiza mediante la variable foundation-validation API. Consulte la foundation-valdiation Documentación de Granite para obtener más información.

Detectar la disponibilidad del cuadro de diálogo

Si tiene un JavaScript personalizado que debe ejecutarse solo cuando el cuadro de diálogo esté disponible y listo, debe escuchar el dialog-ready evento.

Este evento se activa cada vez que se carga el cuadro de diálogo (o se vuelve a cargar) y está listo para usarse, lo que significa que siempre que haya un cambio (crear/actualizar) en el DOM del cuadro de diálogo.

dialog-ready se puede utilizar para vincular código personalizado de JavaScript que realice personalizaciones en los campos de un cuadro de diálogo o tareas similares.

Comportamiento de previsualización

El Modo WCM La cookie se establece al cambiar al modo de vista previa incluso cuando la página no se actualiza.

Para los componentes con una renderización sensible al modo WCM, deben definirse para actualizarse específicamente y, a continuación, basarse en el valor de la cookie.

Documentación de componentes

Como desarrollador, desea acceder fácilmente a la documentación de los componentes para comprender rápidamente sus características:

• Descripción
• Uso previsto
• Estructura y propiedades del contenido
• API y puntos de extensión expuestos
• Etc

Por este motivo, es bastante fácil hacer que cualquier Markdown de documentación existente que tenga disponible dentro del propio componente.

Todo lo que tienes que hacer es colocar un README.md en la estructura del componente.

Esta marca se muestra en la variable Consola de componente.

El Markdown admitido es el mismo que para Fragmentos de contenido.