AEM Desarrollo de componentes developing-aem-components

AEM Los componentes de se utilizan para mantener, dar formato y representar el contenido disponible en las páginas web.

Ejemplos de código code-samples

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

Estructura structure

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

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

Según el componente que desee implementar, podría ser posible extender o personalizar una instancia existente, en lugar de definir y desarrollar toda la 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 tipos de recursos y los mecanismos de herencia relacionados.

Cuadro de diálogo Personalizar un componente existente customizing-a-existing-component-dialog

También es posible anular un cuadro de diálogo de componentes mediante la Fusión de recursos de Sling y la 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 (con sling:resourceSuperType). Este método se recomienda ahora para ampliar el cuadro de diálogo de un componente

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 necesario y luego procesarlo según sea necesario, en los entornos de creación y publicación.

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

El Lenguaje de HTML AEM de plantillas (HTL), introducido con la versión 6.0, sustituye a JSP (JavaServer Pages) como sistema de plantillas preferido y recomendado en el lado del servidor para HTML. Para los desarrolladores web que necesitan crear sitios web empresariales sólidos, HTL les 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 procesará. Se invoca desde expresiones HTL con el patrón de API de uso adecuado.

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

Uso de Java using-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 using-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 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.

AEM Para ayudar a resolver este problema, 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.

Lea 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 las acciones disponibles para el componente, las características del editor local y los oyentes relacionados con los eventos del componente. La configuración es común tanto a la IU táctil como a la clásica, aunque con ciertas diferencias específicas.

El comportamiento de edición de un componente se ha configurado 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.

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

La cookie WCM Mode se establece al cambiar al modo Preview 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.

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 de diseño)

IU de Coral e IU de Granite coral-ui-and-granite-ui

AEM Coral UI y Granite UI definen la apariencia moderna de los usuarios de la interfaz de usuario de.

Granite UI proporciona una amplia gama de componentes básicos (widgets) 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 información detallada, 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 puede 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 a desarrollar un componente, ya que el cuadro de diálogo es en sí mismo un componente (es decir, 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 diálogo customizing-dialog-fields

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

Los widgets para la interfaz de usuario táctil se implementan como componentes de la interfaz de usuario de Granite.

Para crear un widget para utilizarlo en un cuadro de diálogo de componentes para la IU táctil, es necesario que cree un componente de campo de Granite UI.

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 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 amplia gama de componentes de campo que son adecuados para su uso en cuadros de diálogo (o, más generalmente, 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.

Crear una biblioteca de cliente para el estilo y el comportamiento creating-a-client-library-for-style-and-behavior

Si desea definir el estilo y el comportamiento del componente, puede crear una biblioteca de cliente dedicada que defina 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 en el nombre de categoría de la biblioteca de cliente que ha creado. 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 es necesario en otros cuadros de diálogo.

Para que se cargue la biblioteca de cliente para todos los cuadros de diálogo, establezca la propiedad category de la biblioteca de cliente en cq.authoring.dialog. 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 se puede reutilizar 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 hacer lo siguiente:

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

También puede utilizar 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"]

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

El método de administrar 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.

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

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. Esto es muy similar al proceso que tuvo 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, ya que el código de escucha JS (o cualquier código) 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 widgets sin necesidad de tocar la estructura de contenido.

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

Si tiene un JavaScript personalizado que necesita 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.

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 (IU de Granite) field-validation-granite-ui

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

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 utilizado para editar contenido, con la diferencia de que se define como un nodo:

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

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

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

Consulte Ampliación de la creación de páginas - Agregar nuevo editor local para obtener más información.

Personalizar la barra de herramientas de componentes customizing-the-component-toolbar

La 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 - Agregar 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/prestado) configuring-a-component-for-the-references-rail-borrowed-lent

Si el nuevo componente hace referencia a contenido de otras páginas, puede considerar si desea que afecte a las secciones Contenido prestado y Contenido prestado del carril de Referencias.

AEM La opción predeterminada solo comprueba el componente de referencia Para agregar el componente, debe configurar el paquete OSGi WCM Authoring Content Reference Configuration.

Cree una entrada en la definición para especificar 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 utilizarlo en un sistema de párrafos adecuado, de modo que se pueda utilizar en las páginas requeridas.

Esto se puede hacer mediante:

Configuración de 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 su página para que se cree automáticamente una instancia de su nuevo componente cuando un usuario arrastre un recurso (apropiado) a una instancia de esa página (en lugar de tener que arrastrar siempre un componente vacío a la página).

Se puede configurar este comportamiento y la relación de recurso a componente necesaria:

Para ver ejemplos, consulte:

CÓDIGO EN GITHUB

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

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

AEM AEM La extensión de Brackets proporciona un flujo de trabajo sin problemas para editar componentes y bibliotecas de cliente de los componentes de la. Se basa en el editor de código Brackets.

La extensión es la siguiente:

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

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

Migrando código cq:listener migrating-cq-listener-code

Si migra un proyecto diseñado para la interfaz de usuario clásica, el código cq:listener (y los clientlibs relacionados con componentes) podrían utilizar funciones específicas de la interfaz de usuario 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 completamente a la interfaz de usuario táctil, debe reemplazar dicho código para utilizar los objetos y las funciones relevantes para la interfaz de usuario táctil.

Sin embargo, si el proyecto debe adaptarse tanto a la IU clásica como a 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 los componentes para comprender rápidamente lo siguiente:

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

Coloque un archivo de README.md en la estructura del componente. Esta marca se muestra en la consola de componentes.

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