Explicación de cómo codificar para el sistema de estilos

En este vídeo echaremos un vistazo a la anatomía del CSS (o LESS) y JavaScript se utilizan para aplicar estilo al componente de título principal de Experience Manager mediante el sistema de estilos, así como la forma en que se aplican estos estilos al HTML y al DOM.

Explicación de cómo codificar para el sistema de estilos

AEM El paquete de datos proporcionado (technical-review.sites.style-system-1.0.0.zip) instala el estilo de título de ejemplo, las directivas de ejemplo para los componentes Contenedor de diseño y Título de We.Retail y una página de ejemplo.

technical-review.sites.style-system-1.0.0.zip

El CSS

El siguiente es el LESS definición del estilo de ejemplo que se encuentra en:

• /apps/demo/sites/style-system/clientlib-example/components/titles/styles/example.less

Para aquellos que prefieren CSS, debajo de este fragmento de código está CSS esto LESS se compila en.

/* LESS */
.cmp-title--example {
 .cmp-title {
  text-align: center;

  .cmp-title__text {
   color: #EB212E;
   font-weight: 600;
   font-size: 5rem;
   border-bottom: solid 1px #ddd;
   padding-bottom: 0;
   margin-bottom: .25rem
  }

  // Last Modified At element injected via JS
  .cmp-title__last-modified-at {
   color: #999;
   font-size: 1.5rem;
   font-style: italic;
   font-weight: 200;
  }
 }
}

Lo anterior LESS es compilado de forma nativa por el Experience Manager en el siguiente CSS.

/* CSS */
.cmp-title--example .cmp-title {
 text-align: center;
}

.cmp-title--example .cmp-title .cmp-title__text {
 color: #EB212E;
 font-weight: 600;
 font-size: 5rem;
 border-bottom: solid 1px #ddd;
 padding-bottom: 0;
 margin-bottom: 0.25rem;
}

.cmp-title--example .cmp-title .cmp-title__last-modified-at {
 color: #999;
 font-size: 1.5rem;
 font-style: italic;
 font-weight: 200;
}

El JavaScript

El siguiente JavaScript recopila e inserta la fecha y la hora de la última modificación de la página actual debajo del texto del título cuando se aplica el estilo de ejemplo al componente Título.

El uso de jQuery es opcional, así como las convenciones de nomenclatura utilizadas.

El siguiente es el LESS definición del estilo de ejemplo que se encuentra en:

• /apps/demo/sites/style-system/clientlib-example/components/titles/styles/js/title.js

/**
 * JavaScript supporting Styles may be re-used across multi Component Styles.
 *
 * For example:
 * Many styles may require the Components Image (provided via an <img> element) to be set as the background-image.
 * A single JavaScript function may be used to adjust the DOM for all styles that required this effect.
 *
 * JavaScript must react to the DOMNodeInserted event to handle style-switching in the Page Editor Authoring experience.
 * JavaScript must also run on DOM ready to handle the initial page load rendering (AEM Publish).
 * JavaScript must mark and check for elements as processed to avoid cyclic processing (ie. if the JavaScript inserts a DOM node of its own).
 */
jQuery(function ($) {
    "use strict;"

    moment.locale("en");

    /**
     * Method that injects p element, containing the current pages last modified date/time, under the title text.
     *
     * Similar to the CSS Style application, component HTML elements should be targeted via the BEM class names (as they define the stable API)
     * and targeting "raw" elements (ex. "li", "a") should be avoided.
     */
    function applyComponentStyles() {

        $(".cmp-title--example").not("[data-styles-title-last-modified-processed]").each(function () {
            var title = $(this).attr("data-styles-title-last-modified-processed", true),
                url = Granite.HTTP.getPath() + ".model.json";

            $.getJSON(url, function(data) {
                var dateObject = moment(data['lastModifiedDate']),
                    titleText = title.find('.cmp-title__text');

                titleText.after($("<p>").addClass("cmp-title__last-modified-at").text("Last modified " + dateObject.fromNow()));
            });
        });
    }

    // Handle DOM Ready event
    applyComponentStyles();

    // Apply Styles when a component is inserted into the DOM (ie. during Authoring)
    $(".responsivegrid").bind("DOMNodeInserted", applyComponentStyles);
});

Prácticas recomendadas de desarrollo

Prácticas recomendadas para HTML

• El HTML (generado mediante HTL) debe ser lo más estructuralmente semántico posible, evitando la agrupación/anidación innecesaria de elementos.
• Los elementos HTML deben poder direccionarse mediante clases CSS de estilo BEM.

Bueno - Todos los elementos del componente se pueden dirigir mediante la notación BEM:

<!-- Good practice -->
<div class="cmp-list">
    <ul class="cmp-list__item-group">
        <li class="cmp-list__item">...</li>
    </ul>
</div>

Malo - Los elementos de lista y lista solo se pueden dirigir por nombre de elemento:

<!-- Bad practice -->
<div class="cmp-list">
    <ul>
        <li>...</li>
    </ul>
</div>

• Es mejor exponer más datos y ocultarlos que exponer demasiado pocos datos que requieran un futuro desarrollo back-end para exponerlos.

  • La implementación de alternancias de contenido con capacidad de creación puede ayudar a mantener este HTML ágil, por lo que los autores pueden seleccionar qué elementos de contenido se escriben en el HTML. El puede ser especialmente importante a la hora de escribir imágenes en el HTML que pueden no utilizarse para todos los estilos.

  • La excepción a esta regla se produce cuando los recursos caros, como las imágenes, se exponen de forma predeterminada, ya que las imágenes de evento ocultas por CSS se recuperan, en este caso, de forma innecesaria.

    • Los componentes de imagen modernos suelen utilizar JavaScript para seleccionar y cargar la imagen más adecuada para el caso de uso (ventanilla).

Prácticas recomendadas de CSS

• Utilice preprocesadores como MENOS AEM (compatible con la opción de forma nativa con) o SCSS (requiere un sistema de compilación personalizado) para permitir una definición de CSS clara y la reutilización.

• Mantenga la uniformidad en cuanto a peso/especificidad del selector. Esto ayuda a evitar y resolver conflictos en cascada de CSS difíciles de identificar.

• Organice cada estilo en un archivo discreto.

  • Estos archivos se pueden combinar con LESS/SCSS @imports o si se requiere CSS sin procesar, mediante la inclusión de archivos de la biblioteca de cliente de HTML o sistemas personalizados de compilación de recursos front-end.

• Evite mezclar muchos estilos complejos.

  • Cuantos más estilos se puedan aplicar a un componente en un solo momento, mayor será la variedad de permutaciones. Esto puede resultar difícil de mantener, realizar controles de calidad o garantizar la alineación de la marca.

• Utilice siempre clases CSS (siguiendo la notación de BEM) para definir reglas CSS.

  • Si es absolutamente necesario seleccionar elementos sin clases CSS (es decir, elementos vacíos), muévalos más arriba en la definición CSS para dejar claro que tienen una especificidad menor que cualquier conflicto con elementos de ese tipo que no tienen clases CSS seleccionables.

• Evite aplicar estilo al BLOCK--MODIFIER directamente, ya que se adjunta a la cuadrícula adaptable. Cambiar la visualización de este elemento puede afectar al procesamiento y la funcionalidad de la cuadrícula adaptable, por lo que solo aplicar estilo en este nivel cuando la intención es cambiar el comportamiento de la cuadrícula adaptable.

• Aplicar ámbito de estilo utilizando BLOCK--MODIFIER. El BLOCK__ELEMENT--MODIFIERS se puede utilizar en el componente, pero como el BLOCK representa el componente, y el componente es el que tiene estilo, el estilo se "define" y se define mediante BLOCK--MODIFIER.

Ejemplo de estructura del selector de CSS debe ser la siguiente:

En el caso de los componentes anidados, la profundidad del selector CSS para estos elementos de componente anidados excederá el selector de tercer nivel. Repita el mismo patrón para el componente anidado, pero con el ámbito del componente principal BLOCK. O en otras palabras, inicie el componente anidado de BLOCK en el tercer nivel y en el del componente anidado ELEMENT se encuentra en el nivel del selector 4.

Prácticas recomendadas de JavaScript

Las prácticas recomendadas definidas en esta sección pertenecen a style-JavaScript o JavaScript, que está diseñado específicamente para manipular el componente con fines estilísticos en lugar de funcionales.

• Style-JavaScript debe utilizarse con prudencia y es un caso de uso minoritario.
• Style-JavaScript debe utilizarse principalmente para manipular el DOM del componente para admitir el estilo mediante CSS.
• Vuelva a evaluar el uso de Javascript si los componentes aparecerán muchas veces en una página y comprenda el coste de cálculo/extracción y de volver a dibujar.
• AJAX Vuelva a evaluar el uso de Javascript si extrae nuevos datos o contenido de forma asíncrona (a través de la función de búsqueda) cuando el componente puede aparecer muchas veces en una página.
• Gestionar las experiencias de publicación y creación.
• Vuelva a utilizar style-Javascript cuando sea posible.
  • Por ejemplo, si varios estilos de un componente requieren que su imagen se mueva a una imagen de fondo, el estilo de JavaScript se puede implementar una vez y adjuntarse a varias BLOCK--MODIFIERs.
• Separe style-JavaScript de JavaScript funcional cuando sea posible.
• Evalúe el coste de JavaScript frente a la manifestación de estos cambios DOM en el HTML directamente a través de HTL.
  • Cuando un componente que utiliza style-JavaScript requiera una modificación del lado del servidor, evalúe si la manipulación de JavaScript se puede realizar en este momento y cuáles son los efectos/ramificaciones para el rendimiento y la compatibilidad del componente.

Consideraciones de rendimiento

• Style-JavaScript debe mantenerse ligero y delgado.
• Para evitar parpadeos y rediseños innecesarios, oculte inicialmente el componente mediante BLOCK--MODIFIER BLOCKy mostrarlo cuando se hayan completado todas las manipulaciones de DOM en JavaScript.
• El rendimiento de las manipulaciones de estilo de JavaScript es similar a los complementos básicos de jQuery que se adjuntan y modifican elementos en DOMReady.
• Asegúrese de que las solicitudes estén comprimidas en gzip y de que CSS y JavaScript estén minificados.

Recursos adicionales

• Documentación del sistema de estilos
• AEM Creación de bibliotecas de cliente
• Sitio web de documentación de BEM (Modificador de elementos de bloque)
• Sitio web de documentación de LESS
• sitio web de jQuery