Guía de referencia de componentes components-reference-guide

AEM Los componentes son el núcleo de la creación de una experiencia en la. AEM Los componentes principales y el tipo de archivo del proyecto de facilitan la introducción a un conjunto de herramientas de componentes sólidos y listos para usar. AEM El Tutorial WKND guía al desarrollador sobre cómo usar estas herramientas y cómo crear componentes personalizados para crear un sitio de la.

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 overview

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

Planificación planning

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

Reutilización de componentes existentes reusing-components

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

Ampliación de componentes principales extending-core-components

Los componentes principales también ofrecen patrones de personalización claros que puede usar para adaptarlos a las necesidades de su propio proyecto.

Superposición de componentes overlying-components

Los componentes también se pueden redefinir con una superposición basada en la lógica de ruta de búsqueda. Sin embargo, en ese 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 extending-component-dialogs

También es posible anular un cuadro de diálogo de componentes 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 content-logic-and-rendering-markup

El componente se procesó 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 es compatible con HTL, un lenguaje de creación de plantillas que está limitado a propósito para garantizar que se use 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:

Estructura del componente structure

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

Tipo de medio resource-type

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

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 component-definition

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

Propiedades vitales vital-properties

Icono de componente component-icon

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.

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

Para cancelar la herencia de los iconos de los supercomponentes, al establecer una propiedad abbreviation vacía en el componente, se volverá al comportamiento predeterminado.

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

Ejemplo de icono de SVG svg-icon-example

<?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 properties-and-child-nodes-of-a-component

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 observa el componente Texto, verá varios de estos elementos:

Las propiedades de interés particular incluyen:

Los nodos secundarios de interés particular incluyen:

Cuadros de diálogo dialogs

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 detalles 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:

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

Cuadros de diálogo de diseño design-dialogs

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 la plantilla para obtener detalles 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, los componentes Título e Imagen tienen cuadros de diálogo de diseño, mientras que el componente Compartir en redes sociales no.

IU de Coral e IU de Granite coral-and-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.

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:

Personalización de campos de diálogo customizing-dialog-fields

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 (con 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 cuadros de diálogo o, más en general, en formularios.

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

Acceso a campos de diálogo access-to-dialog-fields

También puede usar condiciones de procesamiento (rendercondition) para controlar quién tiene acceso a fichas/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 using-components

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 adding-your-component-to-the-template

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 la plantilla para obtener detalles sobre cómo se crean las plantillas.

Componentes y el contenido que crean components-and-the-content-they-create

Si creamos y configuramos una instancia del componente Title 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 un componente Título:

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 component-hierarchy-and-inheritance

AEM Los componentes dentro de los recursos están sujetos a la Jerarquía de tipos de recursos. Se usa para ampliar componentes con 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 edit-behavior

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 agregando un nodo cq:editConfig 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:

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

Marcadores de posición de componentes component-placeholders

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 sea 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 solamente cuando el componente no tiene contenido y es invisible para el autor.

Para evitar la repetición, Adobe recomienda que los implementadores de componentes utilicen una plantilla HTL para estos marcadores de posición, como la proporcionada por 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 solamente cuando el contenido tiene contenido y es visible.

Se 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 configuring-with-cq-editconfig-child-nodes

Colocar Assets en un cuadro de diálogo: cq:dropTargets cq-droptargets

El nodo cq:dropTargets (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 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, los componentes estándar Text y Title tienen un editor local.

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

El nodo cq:inplaceEditing (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 habilita la edición in situ del componente y define plaintext como el tipo de editor:

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

Gestión de eventos de campo - cq:listeners cq-listeners

El método de administrar eventos en campos de diálogo se realiza con oyentes en una biblioteca de cliente personalizada.

Para introducir lógica en el campo, debe:

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

El nodo cq:listeners (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 configuración de REFRESH_INSERTED:

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 field-validation

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

Detectar la disponibilidad del cuadro de diálogo dialog-ready

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

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 usar 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 preview-behavior

La cookie WCM Mode se establece al cambiar al modo de vista previa aunque la página no se haya actualizado.

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 documenting-components

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

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 debe hacer es colocar un archivo de README.md en la estructura del componente.

Este marcado se mostrará en la consola de componentes.

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