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.
Esta página es una continuación del documento AEM Componentes de: 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 Creación). Si se utilizan en otra parte (por ejemplo, en un cuadro de diálogo del asistente), es posible que no se comporten según lo esperado.
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.
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.
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.
La ampliación de un componente existente se puede lograr con Jerarquía de tipos de recursos y los mecanismos de herencia relacionados.
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 Fusión de recursos de Sling no se activa y /apps
debe definir toda la superposición.
El componente de fragmento de contenido también se puede personalizar y ampliar, aunque se deben tener en cuenta la estructura y las relaciones completas con Assets.
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.
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.
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.
AEM Aunque tanto HTL como JSP se pueden utilizar para desarrollar componentes, ilustraremos el desarrollo con HTL en esta página, ya que es el lenguaje de script recomendado para la creación de scripts en entornos de desarrollo de entornos de trabajo.
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.
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.
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.
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.
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.
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.
En la IU táctil solo se muestran los valores EDIT
y PREVIEW
se utilizan para 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)
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
Granite UI
Debido a la naturaleza de los componentes de la interfaz de usuario de Granite (y a las diferencias con los widgets de ExtJS), existen algunas diferencias entre la forma en que los componentes interactúan con la interfaz de usuario táctil y la interfaz de usuario IU clásica.
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.
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
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 un cuadro de diálogo de este tipo, debe personalizar el cuadro de diálogo IU clásica. Consulte AEM Componentes para la IU clásica de.
Consulte:
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.
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 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).
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, el marco de ExtJS representó estos widgets del lado del cliente.
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 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
Según sus necesidades, puede hacer lo siguiente:
sling:resourceSuperType
)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"]
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.
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 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
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.
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.
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 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
/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 utilizado 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 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.
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.
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
AEM Al trabajar con los servicios de configuración, existen varios métodos para administrar los parámetros de configuración de dichos servicios. Consulte Configurar OSGi para obtener más información y las prácticas recomendadas.
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:
components
en el sistema de párrafos de una plantilla.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:
En la definición de párrafo del diseño de página. Por ejemplo:
/etc/designs/<myApp>/page/par
Cree un nodo:
cq:authoring
nt:unstructured
En esta sección, cree un nodo que contenga todas las asignaciones de recursos a componentes:
assetToComponentMapping
nt:unstructured
Para cada asignación de recursos a componentes, cree un nodo:
nt:unstructured
Cada uno 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 EN 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 cómo definir qué componentes se asocian automáticamente a determinados tipos de medios.
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:
Los corchetes son el mecanismo recomendado para crear componentes. Sustituye a la funcionalidad CRXDE Lite - Crear componente, que se diseñó para la IU clásica.
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
Componentes
cq:listener
código que utiliza funciones específicas de la IU clásicacq:listener
código que utiliza funciones específicas de la IU clásicaCuadros de diálogo
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
}
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.
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.