Desarrollo de componentes AEM developing-aem-components

AEM componentes se utilizan para guardar, dar formato y procesar el contenido disponible en las páginas web.

Ejemplos de código code-samples

Esta página proporciona la documentación de referencia (o vínculos a la documentación de referencia) necesaria para desarrollar nuevos componentes para AEM. Consulte Desarrollo de componentes de AEM: ejemplos de código para algunos ejemplos prácticos.

Estructura structure

La estructura básica de un componente se cubre en la página Componentes AEM: conceptos básicos. Ese documento cubre tanto las IU táctiles como las clásicas. Aunque no necesite utilizar la configuración clásica en el nuevo componente, puede ser útil que los tenga en cuenta al heredar de componentes existentes.

Ampliación de los componentes y cuadros de diálogo existentes extending-existing-components-and-dialogs

Según el componente que desee implementar, podría ser posible ampliar o personalizar una instancia existente en lugar de definir y desarrollar el conjunto estructura desde cero.

Al ampliar o personalizar un componente o cuadro de diálogo existente, puede copiar o replicar toda la estructura o la estructura necesaria para el cuadro de diálogo antes de realizar los cambios.

Ampliación de un componente existente extending-an-existing-component

Se puede ampliar un componente existente con Jerarquía de tipo de recurso y los mecanismos de herencia conexos.

Personalización de un cuadro de diálogo de componente existente customizing-a-existing-component-dialog

También es posible anular un cuadro de diálogo de componentes usando la variable Fusión de recursos de Sling y definición de la propiedad sling:resourceSuperType.

Esto significa que solo necesita redefinir las diferencias necesarias, en lugar de redefinir todo el cuadro de diálogo (mediante sling:resourceSuperType). Este es ahora el método recomendado para ampliar un cuadro de diálogo de componentes

Consulte la Fusión de recursos de Sling para obtener más información.

Definición del marcado defining-the-markup

El componente se procesará con HTML. El componente debe definir el HTML necesario para tomar el contenido requerido y luego procesarlo según sea necesario, tanto en el entorno de autor como de publicación.

Uso del lenguaje de plantilla del HTML using-the-html-template-language

La variable Lenguaje de plantilla del HTML (HTL), introducido con AEM 6.0, sustituye a JSP (páginas de JavaServer) como sistema de plantillas preferido y recomendado del lado del servidor para HTML. Para los desarrolladores web que necesitan crear sitios web empresariales sólidos, HTL ayuda a lograr una mayor seguridad y eficacia en el desarrollo.

Desarrollo de la lógica de contenido developing-the-content-logic

Esta lógica opcional selecciona o calcula el contenido que se va a procesar. Se invoca desde expresiones HTL con el patrón de Use-API apropiado.

El mecanismo para separar la lógica de la apariencia ayuda a aclarar lo que se necesita para una vista determinada. También permite lógicas diferentes para vistas diferentes del mismo recurso.

Uso de Java using-java

HTL Java Use-API permite que un archivo HTL acceda a los métodos de ayuda en una clase Java personalizada. Esto le permite utilizar código Java para implementar la lógica de selección y configuración del contenido del componente.

Uso de JavaScript using-javascript

La HTL JavaScript Use-API permite que un archivo HTL acceda al código de ayuda escrito en JavaScript. Esto le permite utilizar código JavaScript para implementar la lógica de selección y configuración del contenido del componente.

Uso de bibliotecas de HTML del lado del cliente using-client-side-html-libraries

Los sitios web modernos dependen en gran medida del procesamiento del lado del cliente impulsado por código CSS y JavaScript complejo. Organizar y optimizar el servicio de este código puede ser un problema complicado.

Para ayudar a resolver este problema, AEM proporciona Carpetas de biblioteca del lado del cliente, que le permiten almacenar el código del lado del cliente en el repositorio, organizarlo en categorías y definir cuándo y cómo se debe servir cada categoría de código al cliente. A continuación, el sistema de biblioteca del lado del cliente se encarga de producir los vínculos correctos en la página web final para cargar el código correcto.

Lectura Uso de bibliotecas de HTML del lado del cliente para obtener más información.

Configuración del comportamiento de edición configuring-the-edit-behavior

Puede configurar el comportamiento de edición de un componente, incluidos atributos como acciones disponibles para el componente, características del editor in situ y los oyentes relacionados con eventos en el componente. La configuración es común a la IU táctil y a la clásica, aunque con ciertas diferencias específicas.

La variable el comportamiento de edición de un componente está configurado añadiendo un cq:editConfig nodo de tipo cq:EditConfig debajo del nodo del componente (de tipo cq:Component) y añadiendo propiedades específicas y nodos secundarios.

Configuración del comportamiento de vista previa configuring-the-preview-behavior

La variable Modo WCM se establece al cambiar a Vista previa incluso cuando la página no se actualiza.

Para los componentes con una renderización que son sensibles al modo WCM, deben definirse para actualizarse específicamente y luego depender del valor de la cookie.

Creación y configuración de un cuadro de diálogo creating-and-configuring-a-dialog

Los cuadros de diálogo se utilizan para permitir que el autor interactúe con el componente. El uso de un cuadro de diálogo permite a los autores o administradores editar contenido, configurar el componente o definir parámetros de diseño (mediante un Cuadro de diálogo Diseño)

Interfaz de usuario de Coral y Granite coral-ui-and-granite-ui

Interfaz de usuario de Coral y Interfaz de usuario de Granite define el aspecto moderno de AEM.

La interfaz de usuario de Granite proporciona una amplia gama de componentes básicos (widgets) necesario 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:

Creación de un nuevo cuadro de diálogo creating-a-new-dialog

Cuadros de diálogo para la IU táctil:

Un ejemplo de estructura de nodos podría ser:

newComponent (cq:Component)
  cq:dialog (nt:unstructured)
    content
      layout
      items
        column
          items
            file
            description

La personalización de un cuadro de diálogo es similar al desarrollo de un componente, ya que el cuadro de diálogo es en sí mismo un componente (es decir, el marcado procesado por un script de componente junto con el comportamiento/estilo proporcionado por una biblioteca de cliente).

Para ver ejemplos, consulte:

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

Creación de un nuevo campo creating-a-new-field

Las utilidades de la IU táctil se implementan como componentes de Granite UI.

Para crear un nuevo widget para utilizarlo en un cuadro de diálogo de componentes para la IU táctil, es necesario que crear un nuevo 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 contenido 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 crear un componente nuevo. 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, en términos más generales, 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.

Creación de una biblioteca de cliente para estilos y comportamientos creating-a-client-library-for-style-and-behavior

Si desea definir el estilo y el comportamiento del componente, puede crear una biblioteca cliente que define su CSS/LESS y JS personalizados.

Para que la biblioteca de cliente se cargue únicamente para el cuadro de diálogo de componentes (es decir, no se cargará para otro componente), debe establecer la propiedad extraClientlibs del cuadro de diálogo con el nombre de categoría de la biblioteca de cliente que acaba de crear. Esto es aconsejable si la biblioteca de cliente es bastante grande o si el campo es específico de ese cuadro de diálogo y no lo necesitará en otros cuadros de diálogo.

Para que la biblioteca de cliente se cargue en todos los cuadros de diálogo, establezca la propiedad category de la biblioteca de cliente en cq.authoring.dialog. Este es el nombre de categoría de la biblioteca de cliente que se incluye de forma predeterminada al procesar todos los cuadros de diálogo. Desea hacerlo si la biblioteca de cliente es pequeña o si el campo es genérico y podría reutilizarse en otros cuadros de diálogo.

Para ver un ejemplo, consulte:

Ampliación (herencia) de un campo extending-inheriting-from-a-field

Según sus necesidades, puede:

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

También puede utilizar condiciones de renderización ( 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"]

Gestión de eventos de campo handling-field-events

El método para gestionar eventos en campos de diálogo ahora se realiza con oyentes en una biblioteca de cliente personalizada. Esto supone un cambio con respecto al método anterior de tener oyentes en la estructura de contenido.

Oyentes en una biblioteca de cliente personalizada listeners-in-a-custom-client-library

Para insertar 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 Coral UI para identificar a qué evento desea reaccionar. Esto es muy similar al proceso que tenía que realizar con ExtJS en el pasado: busque la página de documentación de un widget determinado y, a continuación, compruebe los detalles de su API de evento.

Para ver un ejemplo, consulte:

Oyentes en la estructura de contenido listeners-in-the-content-structure

En la IU clásica con ExtJS, era habitual tener oyentes para un widget determinado en la estructura de contenido. Lograr lo mismo en la IU táctil es diferente cuando el código de oyente de JS (o cualquier código en absoluto) ya no está definido en el contenido.

La estructura de contenido describe la estructura semántica; no debe implicar la naturaleza del widget subyacente. Al no tener código JS en la estructura de contenido, puede cambiar los detalles de implementación sin tener que cambiar la estructura de contenido. En otras palabras, puede cambiar la biblioteca de utilidades sin necesidad de tocar la estructura de contenido.

Detección de 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 la dialog-ready evento.

Este evento se activa cada vez que se carga (o recarga) el cuadro de diálogo y está listo para utilizarse, 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 conectar en código personalizado JavaScript que realiza personalizaciones en los campos dentro de un cuadro de diálogo o tareas similares.

Validación de campos field-validation

Campo obligatorio mandatory-field

Para marcar un campo determinado como obligatorio, establezca la siguiente propiedad en el nodo de contenido del campo:

Para ver un ejemplo, consulte:

/libs/foundation/components/page/cq:dialog/content/items/tabs/items/basic/items/column/items/title/items/title

Validación de campos (interfaz de usuario de Granite) field-validation-granite-ui

La validación de campos en la interfaz de usuario de Granite y los componentes de Granite UI (equivalentes a las utilidades) se realiza mediante el uso de la variable foundation-validation API. Consulte la foundation-valdiation Documentación de Granite para más detalles.

Para ver ejemplos, consulte:

Creación y configuración de un cuadro de diálogo de diseño creating-and-configuring-a-design-dialog

El cuadro de diálogo Diseño se proporciona cuando un componente tiene detalles de diseño que se pueden editar en Modo de diseño.

La definición es muy similar a la de un cuadro de diálogo usado para editar contenido, con la diferencia de que se define como un nodo:

Creación y configuración de un editor in situ creating-and-configuring-an-inplace-editor

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

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

Consulte Ampliación de la creación de páginas: agregar nuevo editor in situ para obtener más información.

Personalización de la barra de herramientas del componente customizing-the-component-toolbar

La variable Barra de herramientas de componentes proporciona al usuario acceso a una serie de acciones para el componente, como editar, configurar, copiar y eliminar.

Consulte Ampliación de la creación de páginas: añadir nueva acción a una barra de herramientas de componentes para obtener más información.

Configuración de un componente para el carril de referencias (prestado/alquilado) configuring-a-component-for-the-references-rail-borrowed-lent

Si el nuevo componente hace referencia al contenido de otras páginas, puede considerar si desea que afecte a la variable Contenido prestado y Contenido prestado secciones de Referencias Carril.

La AEM predeterminada solo comprueba el componente de referencia. Para añadir su componente, debe configurar el paquete OSGi Configuración de referencia de contenido de creación de WCM.

Cree una nueva entrada en la definición, especificando el componente, junto con la propiedad que se va a comprobar. Por ejemplo:

/apps/<your-Project>/components/reference@parentPath

Activación y adición del componente al sistema de párrafos enabling-and-adding-your-component-to-the-paragraph-system

Una vez desarrollado el componente, debe habilitarse para su uso en un sistema de párrafos apropiado, de modo que se pueda utilizar en las páginas requeridas.

Esto se puede hacer mediante:

Configurar un sistema de párrafos para que al arrastrar un recurso se cree una instancia de componente configuring-a-paragraph-system-so-that-dragging-an-asset-creates-a-component-instance

AEM ofrece la posibilidad de configurar un sistema de párrafos en la página para que se crea automáticamente una instancia del nuevo componente cuando un usuario arrastra un recurso (adecuado) a una instancia de esa página (en lugar de arrastrar siempre un componente vacío a la página).

Se puede configurar este comportamiento y la relación entre activos y componentes necesaria:

Para ver ejemplos, consulte:

CÓDIGO DE GITHUB

Puede encontrar el código de esta página en GitHub

Uso de la extensión AEM Brackets using-the-aem-brackets-extension

La variable Extensión de AEM Brackets proporciona un flujo de trabajo suave para editar componentes de AEM y bibliotecas de cliente. Se basa en la variable Brackets editor de código.

La extensión:

Migración desde un componente clásico migrating-from-a-classic-component

Al migrar un componente diseñado para su uso con la IU clásica a un componente que se pueda utilizar con la IU táctil (solo o conjuntamente), se deben tener en cuenta los siguientes problemas:

Migración de código cq:listener migrating-cq-listener-code

Si está migrando un proyecto diseñado para la IU clásica, la variable cq:listener (y clientlibs relacionados con componentes) pueden utilizar funciones específicas de la IU clásica (como CQ.wcm.*). Para la migración, debe actualizar dicho código utilizando los objetos o funciones equivalentes en la IU táctil.

Si el proyecto se está migrando por completo a la IU táctil, deberá reemplazarlo para que utilice los objetos y funciones relevantes para la IU táctil.

Sin embargo, si el proyecto debe ocuparse tanto de la IU clásica como de la IU táctil durante el período de migración (el escenario habitual), debe implementar un conmutador para diferenciar el código independiente que hace referencia a los objetos adecuados.

Este mecanismo de conmutación se puede implementar de la siguiente manera:

if (Granite.author) {
    // touch UI
} else {
    // classic UI
}

Documentar el componente documenting-your-component

Como desarrollador, desea acceder fácilmente a la documentación de componentes para que pueda comprender rápidamente:

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

Todo lo que debe hacer es colocar un README.md en la estructura de componentes. Este marcador se muestra en la sección consola de componentes.

El margen admitido es el mismo que para fragmentos de contenido.