AEM Desarrollo de componentes

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

• Cuándo creación de páginas, los componentes permiten a los autores editar y configurar el contenido.

  • Al construir un Comercio los componentes pueden, por ejemplo, recopilar y procesar información del catálogo.
    Consulte Desarrollo del comercio electrónico para obtener más información.

  • Al construir un Communities sitio los componentes pueden proporcionar información a los visitantes y recopilar información de ellos.
    Consulte Desarrollo de comunidades para obtener más información.

• En la instancia de publicación, los componentes procesan el contenido y lo presentan a los visitantes del sitio web según sea necesario.

Ejemplos de código

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. Consulte AEM Desarrollo de componentes: ejemplos de código para ver algunos ejemplos prácticos.

Estructura

La estructura básica de un componente se trata en la página AEM Componentes de: 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

Según el componente que desee implementar, puede ser posible ampliar o personalizar una instancia existente, en lugar de definir y desarrollar la instancia completa 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

La ampliación de un componente existente se puede lograr con Jerarquía de tipos de recursos y los mecanismos de herencia relacionados.

Cuadro de diálogo Personalizar un componente existente

También es posible anular una diálogo de componentes uso del 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 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

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

El Lenguaje de plantilla del HTML (HTL)AEM , que se introduce con la versión 6.0 de, 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

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

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 de HTML del lado del cliente

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

AEM Para ayudar a resolver este problema, proporciona lo siguiente: Carpetas de biblioteca del cliente, que 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.

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

Configuración del comportamiento de edición

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 se ha configurado el comportamiento de edición de un componente añadiendo una etiqueta cq:editConfig nodo 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

El Modo WCM se establece al cambiar a Previsualizar incluso cuando la página no se ha 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

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)

IU de Coral e IU de Granite

IU de Coral y Granite UI AEM define el aspecto y la sensación modernas de la.

La interfaz de usuario de Granite 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:

• IU de Coral

  • Proporciona una IU coherente en todas las soluciones de nube
  • AEM Conceptos de la interfaz de usuario táctil con capacidad de uso de la: Coral UI
  • Guía de la IU de Coral

• Granite UI

  • Proporciona marcado de la IU de Coral envuelto en componentes de Sling para crear consolas y cuadros de diálogo de IU
  • AEM Conceptos de la interfaz de usuario táctil de la aplicación de: Granite UI
  • Documentación de Granite UI

Creación de un nuevo cuadro de diálogo

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

• se denominan cq:dialog.

• se definen como un nt:unstructured nodo con el sling:resourceType conjunto de propiedades.

• se encuentran debajo de su cq:Component y junto a su definición de componente.

• se representan en el lado del servidor (como componentes de Sling), según su estructura de contenido y el sling:resourceType propiedad.

• Utilice el marco de trabajo de Granite UI.

• 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.

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:

• /libs/foundation/components/text/cq:dialog
• /libs/foundation/components/download/cq:dialog

Personalización de campos de diálogo

Creación de un nuevo campo

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, debe Creación de un componente de campo de IU 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 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.

Crear una biblioteca de cliente para el estilo y el comportamiento

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

Para que la biblioteca de cliente se cargue únicamente para el cuadro de diálogo del componente (es decir, no se cargará para otro componente), debe establecer la propiedad extraClientlibs del cuadro de diálogo al 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 la biblioteca de cliente se cargue 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:

• cqgems/customizingfield/components/colorpicker/clientlibs

  • proporcionadas por el Ejemplo de código

Ampliación (herencia) de un campo

Según sus necesidades, puede hacer lo siguiente:

• Ampliar un campo de IU de Granite determinado mediante la herencia de componentes ( sling:resourceSuperType)
• Amplíe un widget determinado desde la biblioteca de widgets subyacente (si hay una interfaz de usuario de Granite, es la interfaz de usuario de Coral), siguiendo la API de biblioteca de widgets (herencia JS/CSS)

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"]

Gestión de eventos de campo

El método de gestión de eventos en los campos de diálogo ahora se realiza con agentes de escucha 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

Para introducir lógica en el campo, debe:

1. Marque su campo con una clase CSS determinada (la variable gancho).
2. 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 afecta 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. 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:

• cqgems/customizingfield/components/clientlibs/customizingfield

  • proporcionadas por el Ejemplo de código

Oyentes en la estructura de contenido

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

Si tiene un JavaScript personalizado que solo debe ejecutarse 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.

Validación de campos

Campo obligatorio

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

• Nombre: required
• Tipo: Boolean

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)

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

Para ver ejemplos, consulte:

• cqgems/customizingfield/components/clientlibs/customizingfield/js/validations.js

  • proporcionadas por el Ejemplo de código

• /libs/cq/gui/components/authoring/dialog/clientlibs/dialog/js/validations.js

Creación y configuración de un cuadro de diálogo de diseño

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:

• Nombre del nodo: cq:design_dialog
• Tipo: nt:unstructured

Creación y configuración de un editor local

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: añadir nuevo editor local para obtener más información.

Personalizar la barra de herramientas de componentes

El Barra de herramientas 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)

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

AEM La opción predeterminada solo comprueba el componente de referencia Para agregar el componente, debe configurar el paquete OSGi Configuración de referencia del contenido de creación de WCM.

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

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:

• usando Modo de diseño al editar una página específica.
• definición del components en el sistema de párrafos de una plantilla.

Configuración de un sistema de párrafos para que, al arrastrar un recurso, se cree una instancia de componente

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

1. En la definición de párrafo del diseño de página. Por ejemplo:

   • /etc/designs/<myApp>/page/par

   Cree un nodo:

   • Nombre: cq:authoring
   • Tipo: nt:unstructured

2. En esta sección, cree un nodo que contenga todas las asignaciones de recursos a componentes:

   • Nombre: assetToComponentMapping
   • Tipo: nt:unstructured

3. Para cada asignación de recursos a componentes, cree un nodo:

   • Nombre: texto. Se recomienda que el nombre indique el recurso y el tipo de componente relacionado; por ejemplo, imagen
   • Tipo: nt:unstructured

   Cada uno con las siguientes propiedades:

   • assetGroup:

     • Tipo: String
     • Valor: el grupo al que pertenece el recurso relacionado; por ejemplo, media

   • assetMimetype:

     • Tipo: String
     • Valor: el tipo MIME del recurso relacionado; por ejemplo, image/*

   • droptarget:

     • Tipo: String
     • Valor: el destino de colocación; por ejemplo, image

   • resourceType:

     • Tipo: String
     • Valor: el recurso de componente relacionado; por ejemplo, foundation/components/image

   • type:

     • Tipo: String
     • Valor: el tipo, por ejemplo, Images

Para ver ejemplos, consulte:

• /etc/designs/geometrixx/jcr:content/page/par/cq:authoring
• /etc/designs/geometrixx-outdoors/jcr:content/page/par/cq:authoring
• /etc/designs/geometrixx-media/jcr:content/article/article-content-par/cq:authoring

CÓDIGO EN GITHUB

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

• Abra el proyecto aem-project-archetype en GitHub
• Descargue el proyecto como un archivo ZIP

AEM Uso de la extensión de corchetes de

El AEM Extensión de corchetes de AEM proporciona un flujo de trabajo fluido para editar componentes de la aplicación y bibliotecas de cliente. Se basa en la variable Corchetes editor de código.

La extensión es la siguiente:

• AEM Facilita la sincronización (no se requiere Maven ni File Vault) para ayudar a aumentar la eficacia del desarrollador y también ayuda a los desarrolladores de front-end con conocimientos limitados sobre la materia a participar en proyectos.
• Proporciona algunos HTL es el lenguaje de plantilla diseñado para simplificar el desarrollo de componentes y aumentar la seguridad.

Migración desde un componente clásico

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:

• HTL

  • Uso de HTL no es obligatorio, pero si el componente necesita actualizarse, es un momento ideal para tenerlo en cuenta migración de JSP a HTL.

• Componentes

  • Migrar cq:listener código que utiliza funciones específicas de la IU clásica
  • RTE, para obtener más información, consulte Configuración del editor de texto enriquecido.
  • Migrar cq:listener código que utiliza funciones específicas de la IU clásica

• Cuadros de diálogo

  • Cree un cuadro de diálogo para utilizarlo en la interfaz de usuario táctil. Sin embargo, por motivos de compatibilidad, la IU táctil puede utilizar la definición de un cuadro de diálogo de IU clásico cuando no se ha definido ningún cuadro de diálogo para la IU táctil.
  • El AEM Herramientas de modernización de se proporcionan para ayudarle a ampliar los componentes existentes.
  • Asignación de ExtJS a componentes de Granite UI proporciona una visión general práctica de los xtype de ExtJS y los tipos de nodo con sus tipos de recursos de interfaz de usuario de Granite equivalentes.
  • AEM Personalización de campos; para obtener más información, consulte la sesión de Gems de la sobre Personalización de campos de diálogo.
  • Migrar de vtypes a Validación de Granite UI
  • Uso de oyentes JS; para obtener más información, consulte Gestión de eventos de campo AEM y la sesión de Gems de la en Personalización de campos de diálogo.

Migrando código cq:listener

Si va a migrar un proyecto diseñado para la IU clásica, la variable cq:listener El código de (y los 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 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

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

• Descripción
• Uso previsto
• Estructura y propiedades del contenido
• API y puntos de extensión expuestos
• Y así sucesivamente

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

Colocar un README.md en la estructura del componente. Esta marca se muestra en la variable consola componentes.

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