AEM componentes se utilizan para guardar, dar formato y procesar el contenido disponible en las páginas web.
When creación de páginas, los componentes permiten a los autores editar y configurar el contenido.
Al crear un Comercio sitio en el que 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 crear un Comunidades sitio en el que los componentes pueden proporcionar información a sus visitantes y recopilarla.
Consulte Desarrollo de comunidades para obtener más información.
En la instancia de publicación, los componentes representan el contenido, presentándolo como lo necesita a los visitantes del sitio web.
Esta página es una continuación del documento Componentes AEM: conceptos básicos.
Componentes a continuación /libs/cq/gui/components/authoring/dialog
están pensados para utilizarse únicamente en el Editor (cuadros de diálogo de componentes en la creación). Si se utilizan en otra parte (como en un cuadro de diálogo de asistente, por ejemplo), es posible que no se comporten del modo esperado.
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.
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.
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.
Se puede ampliar un componente existente con Jerarquía de tipo de recurso y los mecanismos de herencia conexos.
Los componentes también se pueden redefinir con una superposición basada en la lógica de ruta de búsqueda. Sin embargo, en tal caso, la variable Fusión de recursos de Sling no se activará y /apps
debe definir la superposición completa.
La variable componente de fragmento de contenido también se puede personalizar y ampliar, aunque se deben tener en cuenta la estructura completa y las relaciones con Assets.
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.
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.
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.
Aunque tanto HTL como JSP pueden utilizarse para desarrollar componentes, ilustraremos el desarrollo con HTL en esta página, ya que es el lenguaje de secuencias de comandos recomendado para AEM.
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.
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.
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.
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.
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.
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.
En la IU táctil solo se muestran los valores EDIT
y PREVIEW
se usan para la variable Modo WCM cookie.
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 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:
Interfaz de usuario de Coral
Interfaz de usuario de Granite
Debido a la naturaleza de los componentes de la interfaz de usuario de Granite (y a las diferencias con los widgets de ExtJS), hay algunas diferencias entre la forma en que los componentes interactúan con la IU táctil y la IU clásica.
Cuadros de diálogo para la IU táctil:
tienen nombre cq:dialog
.
se definen como nt:unstructured
con el nodo sling:resourceType
conjunto de propiedades.
se encuentran debajo de sus cq:Component
y junto a su definición de componente.
se procesan en el lado del servidor (como componentes de Sling), según su estructura de contenido y el sling:resourceType
propiedad.
utilice el marco de la interfaz de usuario de Granite.
contiene una estructura de nodos que describe los campos dentro del cuadro de diálogo.
nt:unstructured
con el sling:resourceType
propiedad.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:
/libs/foundation/components/text/cq:dialog
/libs/foundation/components/download/cq:dialog
Si un componente no tiene ningún cuadro de diálogo definido para la IU táctil, el cuadro de diálogo de la IU clásica se utiliza como alternativa dentro de una capa de compatibilidad. Para personalizar este cuadro de diálogo, debe personalizar el cuadro de diálogo IU clásica. Consulte Componentes AEM para la IU clásica.
Consulte:
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.
Para obtener más información sobre la interfaz de usuario de Granite, consulte la Documentación 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 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).
Esto difiere de la IU clásica, donde los widgets se representan mediante cq:Widgets
nodos, cada uno con un xtype
para establecer la relación con su widget ExtJS correspondiente. Desde el punto de vista de la implementación, estas utilidades se representaron en el lado del cliente mediante el marco de trabajo de ExtJS.
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.
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:
cqgems/customizingfield/components/colorpicker/clientlibs
Según sus necesidades, puede:
sling:resourceSuperType
)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"]
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.
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:
cqgems/customizingfield/components/clientlibs/customizingfield
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.
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.
Para marcar un campo determinado como obligatorio, establezca la siguiente propiedad en el nodo de contenido del campo:
required
Boolean
Para ver un ejemplo, consulte:
/libs/foundation/components/page/cq:dialog/content/items/tabs/items/basic/items/column/items/title/items/title
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:
cqgems/customizingfield/components/clientlibs/customizingfield/js/validations.js
/libs/cq/gui/components/authoring/dialog/clientlibs/dialog/js/validations.js
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:
cq:design_dialog
nt:unstructured
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.
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.
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
Al trabajar con AEM, existen varios métodos para administrar los parámetros de configuración de dichos servicios. Consulte Configuración de OSGi para obtener más información y las prácticas recomendadas.
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:
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:
En la definición de párrafo del diseño de la página. Por ejemplo:
/etc/designs/<myApp>/page/par
Cree un nuevo nodo:
cq:authoring
nt:unstructured
En este nodo, cree un nuevo nodo para albergar todas las asignaciones de recursos a componentes:
assetToComponentMapping
nt:unstructured
Para cada asignación de recursos a componentes, cree un nodo:
nt:unstructured
Cada una con las siguientes propiedades:
assetGroup
:
String
media
assetMimetype
:
String
image/*
droptarget
:
String
image
resourceType
:
String
foundation/components/image
type
:
String
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 DE GITHUB
Puede encontrar el código de esta página en GitHub
La creación automática de instancias de componentes ahora se puede configurar fácilmente dentro de la interfaz de usuario al utilizar Componentes principales y plantillas editables. Consulte Creación de plantillas de página para obtener más información sobre la definición de los componentes que se asocian automáticamente a determinados tipos de medios.
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:
Brackets es el mecanismo recomendado para crear componentes. Reemplaza la funcionalidad CRXDE Lite - Crear componente , que se diseñó para la IU clásica.
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:
HTL
Componentes
cq:listener
código que utiliza funciones específicas de la IU clásicacq:listener
code que utiliza funciones específicas de la IU clásicaCuadros de diálogo
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
}
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.