Sistema de estilos style-system
El sistema de estilos permite a un autor de plantillas definir clases de estilos en la política de contenido de un componente, de modo que un autor de contenido puede seleccionarlos al editar el componente en una página. Estos estilos pueden ser variaciones visuales alternativas de un componente, por lo que el componente es más flexible.
Esto elimina la necesidad de desarrollar un componente personalizado para cada estilo o de personalizar el cuadro de diálogo del componente para habilitar dicha funcionalidad de estilo. Genera componentes más reutilizables que se pueden adaptar rápida y fácilmente a las necesidades de los autores de contenido sin ningún desarrollo back-end AEM.
Caso práctico use-case
Los autores de plantillas no solo necesitan la capacidad de configurar cómo funcionan los componentes para los autores de contenido, sino también de configurar varias variaciones visuales alternativas de un componente.
Del mismo modo, los autores de contenido no solo necesitan la capacidad de estructurar y organizar su contenido, sino también de seleccionar cómo se presenta visualmente.
El sistema de estilos proporciona una solución unificada a los requisitos del autor de plantillas y del autor de contenido:
- Los autores de plantillas pueden definir clases de estilos en la política de contenido de los componentes.
- Los autores de contenido pueden seleccionar estas clases en una lista desplegable al editar el componente en una página para aplicar los estilos correspondientes.
A continuación, la clase de estilo se inserta en el elemento envolvente de la decoración del componente, de modo que el desarrollador de componentes no tenga que preocuparse por la gestión de los estilos más allá de proporcionar sus reglas CSS.
Información general overview
Por lo general, el uso del sistema de estilos se realiza de la siguiente manera.
-
El diseñador web crea diferentes variaciones visuales de un componente.
-
Se proporciona al desarrollador de HTML la salida HTML de los componentes y las variaciones visuales deseadas que se van a implementar.
-
El desarrollador de HTML define las clases CSS que corresponden a cada variación visual y que deben insertarse en el elemento que ajusta los componentes.
-
El desarrollador de HTML implementa el código CSS correspondiente (y opcionalmente el código JS) para cada una de las variaciones visuales para que su aspecto se corresponda a como están definidas.
-
El desarrollador de AEM coloca el CSS proporcionado (y el JS opcional) en una biblioteca de cliente y la implementa.
-
El desarrollador de AEM o el creador de plantillas configuran las plantillas de página, editan la política de cada componente diseñado, añaden las clases CSS definidas, asignan nombres de usuario sencillos a cada estilo e indican los estilos que se pueden combinar.
-
El autor de páginas de AEM puede seleccionar los estilos diseñados en el editor de página a través del menú Estilo de la barra de herramientas del componente.
Tenga en cuenta que solo los tres últimos pasos se llevan a cabo en AEM. Esto significa que todo el desarrollo del CSS y Javascript necesarios se puede realizar sin AEM.
La implementación de los estilos solo requiere implementación en AEM y selección dentro de los componentes de las plantillas deseadas.
En el diagrama siguiente, se ilustra la arquitectura del sistema de estilos.
Uso use
Para demostrar la función, utilizaremos como ejemplo la implementación por WKND del componente de título del componente principal.
En las secciones siguientes Como autor de contenido y Como autor de plantillas, se describe cómo probar la funcionalidad del sistema de estilos mediante el sistema de estilos de WKND.
Si desea utilizar el sistema de estilos para sus propios componentes, haga lo siguiente:
- Instale el CSS como bibliotecas de cliente como se explica en la sección Información general.
- Configure las clases CSS que desea poner a disposición de los autores de contenido, tal como se describe en la sección Como autor de plantillas.
- Los autores de contenido pueden utilizar los estilos como se describe en la sección Como autor de contenido.
Como autor de contenido as-a-content-author
-
Después de instalar el proyecto WKND, vaya a la página de inicio maestra en inglés de WKND en
http://<host>:<port>/sites.html/content/wknd/language-masters/eny edite la página. -
Seleccione un componente del Título más abajo en la página
-
Toque o haga clic en el botón Estilos de la barra de herramientas del componente Lista para abrir el menú Estilo y cambiar el aspecto del componente.
note note NOTE En este ejemplo, los estilos Colores (Negro, Blanco y Gris) se excluyen mutuamente, mientras que las opciones Estilo (Subrayado, Alinear a la derecha y Miniespaciado) se pueden combinar. Esto se puede configurar en la plantilla como el autor de la misma.
Como autor de plantillas as-a-template-author
-
Mientras edita la página de inicio maestra en inglés de WKND en
http://<host>:<port>/sites.html/content/wknd/language-masters/en, edite la plantilla de la página a través de Información de la página -> Editar plantilla.
-
Edite la política del componente Título al tocar o hacer clic en el botón Política del componente.
-
En la pestaña Estilos de las propiedades, puede ver cómo se han configurado los estilos.
- Nombre del grupo: Los estilos se pueden agrupar en el menú Estilo que verá el autor del contenido al configurar el estilo del componente.
- Los estilos se pueden combinar: Permite seleccionar varios estilos dentro de ese grupo al mismo tiempo.
- Nombre de estilo: Descripción del estilo que se mostrará al autor del contenido al configurar el estilo del componente.
- Clases CSS: Nombre real de la clase CSS asociada al estilo.
Utilice los controles de arrastre para organizar el orden de los grupos y los estilos dentro de los grupos. Utilice los iconos Agregar o Eliminar para agregar o quitar grupos o estilos dentro de los grupos.
Configuración setup
La versión 2 y versiones posteriores de los componentes principales están totalmente habilitadas para aprovechar el sistema de estilos y no requieren ninguna configuración adicional.
Los pasos siguientes solo son necesarios para habilitar el sistema de estilos para sus propios componentes personalizados o para habilitar la pestaña opcional Estilos en el cuadro de diálogo Editar.
Activar la pestaña Estilo en el cuadro de diálogo Diseño enable-styles-tab-design
Para que un componente funcione con el sistema de estilos de AEM y se muestre la pestaña Estilo en el cuadro de diálogo de diseño, el desarrollador de componentes debe incluir la pestaña de estilo en la siguiente configuración del componente:
path = "/mnt/overlay/cq/gui/components/authoring/dialog/style/tab_design/styletab"sling:resourceType = "granite/ui/components/coral/foundation/include"
Con el componente configurado, los estilos configurados por los autores de la página se insertarán automáticamente AEM en el elemento de decoración que AEM automáticamente ajusta alrededor de cada componente editable. El componente en sí no necesita hacer nada más para que esto ocurra.
Activar la pestaña Estilos en el cuadro de diálogo Editar enable-styles-tab-edit
A partir de AEM versión 6.4.7.0 ya está disponible una pestaña Estilos opcional en el cuadro de diálogo Editar. A diferencia de la pestaña Cuadro de diálogo de diseño, la pestaña en el cuadro de diálogo Editar no es esencial para que funcione el sistema de estilos, pero es una interfaz alternativa opcional para que un autor de contenido defina estilos.
La pestaña Editar del cuadro de diálogo se puede incluir de forma similar a la pestaña Diseño:
path = "/mnt/overlay/cq/gui/components/authoring/dialog/style/tab_edit/styletab"sling:resourceType = "granite/ui/components/coral/foundation/include"
Estilos con nombres de elemento styles-with-element-names
Un desarrollador también puede configurar una lista de nombres de elemento permitidos para los estilos del componente con la propiedad matriz de cadenas cq:styleElements. A continuación, en la pestaña Estilos de la política dentro del cuadro de diálogo de diseño, el autor de la plantilla también puede elegir un nombre de elemento para cada estilo. Esto establecerá el nombre del elemento del elemento envolvente.
Esta propiedad se establece en el nodo cq:Component. Por ejemplo:
/apps/<yoursite>/components/content/list@cq:styleElements=[div,section,span]
- HTL tiene prioridad sobre todo:
data-sly-resource="${'path/to/resource' @ decorationTagName='span'}. - A continuación, entre diversos estilos activos, se toma el primer estilo de la lista de estilos configurados en la política del componente.
- Por último, el valor
cq:htmlTag/cq:tagNamedel componente se considera como un valor alternativo.
Esta capacidad para definir nombres de estilo resulta útil para los componentes muy genéricos, como el contenedor de diseño o el componente Fragmento de contenido, a fin de complementar su significado.
Por ejemplo, permite que un contenedor de diseños reciba valores semánticos como <main>, <aside>, <nav>, etc.