Diseño de los componentes principales del CIF de AEM style-aem-cif-core-components

El CIF Proyecto Venia en la es una base de código de referencia para utilizar CIF Componentes principales. AEM CIF En este tutorial, inspeccionará el proyecto de referencia de Venia y comprenderá cómo se organizan los componentes principales y CSS y JavaScript utilizados por los componentes principales de la. También creará un estilo con CSS para actualizar el estilo predeterminado del Teaser de productos componente.

TIP
Utilice el AEM Arquetipo de proyecto al iniciar su propia implementación de commerce.

Qué va a generar

En este tutorial, se implementa un nuevo estilo para el componente teaser de productos que se parece a una tarjeta. CIF Las lecciones aprendidas en el tutorial se pueden aplicar a otros componentes principales de la.

Qué va a generar

Requisitos previos prerequisites

Se requiere un entorno de desarrollo local para completar este tutorial. AEM Esto incluye una instancia de ejecución de la instancia de que está configurada y conectada a una instancia de Adobe Commerce. Revise los requisitos y pasos para AEM configuración de un desarrollo local con.

Clonar el proyecto Venia clone-venia-project

Clonamos el Proyecto Venia y, a continuación, invalide los estilos predeterminados.

NOTE
Siéntase libre de usar un proyecto existente AEM CIF (en función del Tipo de archivo del proyecto de la con el que se incluye la) y omita esta sección.
  1. Ejecute el siguiente comando de Git para clonar el proyecto:

    code language-shell
    $ git clone git@github.com:adobe/aem-cif-guides-venia.git
    
  2. Cree e implemente el proyecto en una instancia local de AEM:

    code language-shell
    $ cd aem-cif-guides-venia/
    $ mvn clean install -PautoInstallPackage,cloud
    
  3. AEM Añada las configuraciones de OSGi necesarias para conectar la instancia de a una instancia de Adobe Commerce o añadir las configuraciones al proyecto recién creado.

  4. En este punto, debería tener una versión de trabajo de una tienda conectada a una instancia de Adobe Commerce. Vaya a US > Home página en: http://localhost:4502/editor.html/content/venia/us/en.html.

    Hay que ver que la tienda esté usando actualmente el tema de Venia. Al expandir el menú principal de la tienda, verá varias categorías que indican que la conexión con Adobe Commerce está funcionando.

    Tienda configurada con tema de Venia

Bibliotecas de cliente y módulo ui.frontend introduction-to-client-libraries

AEM CSS y JavaScript responsables de procesar el tema o los estilos de la tienda se administran en la administración de la tienda a través de un administrador de estilos. biblioteca de cliente o clientlibs para abreviar. Las bibliotecas de cliente proporcionan un mecanismo para organizar CSS y JavaScript en el código de un proyecto y luego distribuirlas en la página.

AEM CIF Los estilos específicos de la marca se pueden aplicar a los componentes principales de la marca de añadiendo y anulando el CSS administrado por estas bibliotecas de cliente. Es fundamental comprender cómo se estructuran e incluyen las bibliotecas de cliente en la página.

El ui.frontend es un dedicado webpack proyecto para administrar todos los recursos front-end de un proyecto. Esto permite a los desarrolladores de front-end utilizar cualquier número de lenguajes y tecnologías como TypeScript, Sass y mucho más.

El ui.frontend El módulo también es un módulo Maven e integrado con el proyecto más grande mediante el uso de un módulo NPM el aem-clientlib-generator. Durante una compilación, la variable aem-clientlib-generator copia los archivos CSS y JavaScript compilados en una biblioteca de cliente en la ui.apps módulo.

arquitectura ui.frontend a ui.apps

CSS y JavaScript compilados se copian del ui.frontend en el módulo ui.apps como biblioteca de cliente durante una compilación de Maven

Actualizar el estilo del teaser ui-frontend-module

A continuación, realice un pequeño cambio en el estilo Teaser para ver cómo se define la variable ui.frontend Las bibliotecas de módulo y cliente funcionan. Uso el IDE de su elección para importar el proyecto Venia. Las capturas de pantalla utilizadas son de IDE de código de Visual Studio.

  1. Navegue y expanda el ui.frontend y expanda la jerarquía de carpetas a: ui.frontend/src/main/styles/commerce:

    carpeta de comercio ui.frontend

    Observe que hay varios Sass (.scss) archivos debajo de la carpeta. Estos son los estilos específicos de Commerce para cada uno de los componentes de Commerce.

  2. Abra el archivo _productteaser.scss.

  3. Actualice el .item__image y modifique la regla de borde:

    code language-scss
    .item__image {
        border: #ea00ff 8px solid; /* <-- modify this rule */
        display: block;
        grid-area: main;
        height: auto;
        opacity: 1;
        transition-duration: 512ms;
        transition-property: opacity, visibility;
        transition-timing-function: ease-out;
        visibility: visible;
        width: 100%;
    }
    

    La regla anterior debe agregar un borde rosa en negrita al componente teaser de productos.

  4. Abra una nueva ventana de terminal y vaya al ui.frontend carpeta:

    code language-shell
    $ cd <project-location>/aem-cif-guides-venia/ui.frontend
    
  5. Ejecute el siguiente comando Maven:

    code language-shell
    $ mvn clean install
    ...
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time:  29.497 s
    [INFO] Finished at: 2020-08-25T14:30:44-07:00
    [INFO] ------------------------------------------------------------------------
    

    Inspect la salida del terminal. Puede ver que el comando Maven ejecutó varios scripts NPM, incluidos npm run build. El npm run build se define en la variable package.json y tiene el efecto de compilar el proyecto webpack y activar la generación de la biblioteca de cliente.

  6. Inspect el archivo ui.frontend/dist/clientlib-site/site.css:

    CSS de sitio compilado

    El archivo es la versión compilada y minificada de todos los archivos Sass del proyecto.

    note note
    NOTE
    Los archivos de este tipo se omiten desde el control de código fuente, ya que deben generarse durante la generación.
  7. Inspect el archivo ui.frontend/clientlib.config.js.

    code language-js
    /* clientlib.config.js*/
    ...
    // Config for `aem-clientlib-generator`
    module.exports = {
        context: BUILD_DIR,
        clientLibRoot: CLIENTLIB_DIR,
        libs: [
            {
                ...libsBaseConfig,
                name: 'clientlib-site',
                categories: ['venia.site'],
                dependencies: ['venia.dependencies', 'aem-core-cif-react-components'],
                assets: {
    ...
    

    Archivo de configuración para. aem-clientlib-generator AEM y determina dónde y cómo el CSS compilado y JavaScript se transformarán en una biblioteca de cliente de la biblioteca de la aplicación de cliente de la aplicación de datos de y de la aplicación de código de cliente de la aplicación de datos de cliente.

  8. En el ui.apps módulo inspeccione el archivo: ui.apps/src/main/content/jcr_root/apps/venia/clientlibs/clientlib-site/css/site.css:

    CSS del sitio compilado en ui.apps

    Esto copia el site.css en el archivo ui.apps proyecto. Ahora forma parte de una biblioteca de cliente llamada clientlib-site con una categoría de venia.site. Una vez que el archivo forme parte de ui.apps AEM módulo para el que se puede implementar el módulo de forma.

    note note
    NOTE
    Los archivos como este también se omiten desde el control de código fuente, ya que deben generarse durante la generación.
  9. A continuación, inspeccione las demás bibliotecas de cliente generadas por el proyecto:

    Otras bibliotecas de cliente

    El administrador no administra estas bibliotecas de cliente ui.frontend módulo. En su lugar, estas bibliotecas de cliente incluyen dependencias CSS y JavaScript proporcionadas por Adobe. La definición de estas bibliotecas de cliente se encuentra en .content.xml debajo de cada carpeta.

    clientlib-base : es una biblioteca de cliente vacía que simplemente incrusta las dependencias necesarias de AEM Componentes principales. La categoría es venia.base.

    clientlib-cif : también es una biblioteca de cliente vacía que simplemente incrusta las dependencias necesarias de AEM CIF Componentes principales de. La categoría es venia.cif.

    clientlib-grid AEM : Esto incluye el CSS necesario para habilitar la función Cuadrícula interactiva de. AEM El uso de la cuadrícula de habilita Modo de diseño AEM en el Editor de y permite a los autores de contenido cambiar el tamaño de los componentes. La categoría es venia.grid y está incrustado en venia.base biblioteca.

  10. Inspect los archivos customheaderlibs.html y customfooterlibs.html debajo ui.apps/src/main/content/jcr_root/apps/venia/components/page:

    Scripts personalizados de encabezado y pie de página

    Estos scripts incluyen venia.base y venia.cif como parte de todas las páginas.

    note note
    NOTE
    Solo las bibliotecas base están "codificadas" como parte de los scripts de página. venia.site no se incluye en estos archivos y, en su lugar, se incluye como parte de la plantilla de página para una mayor flexibilidad. Esto se inspecciona más tarde.
  11. AEM Desde el terminal, cree e implemente todo el proyecto en una instancia local de:

    code language-shell
    $ cd aem-cif-guides-venia/
    $ mvn clean install -PautoInstallPackage,cloud
    

Crear un teaser de productos author-product-teaser

AEM Ahora que se han implementado las actualizaciones de código, añada una nueva instancia del componente teaser de productos a la página de inicio del sitio con las herramientas de creación de. Esto nos permite ver los estilos actualizados.

  1. Abra una nueva pestaña del explorador y vaya a Página principal del sitio: http://localhost:4502/editor.html/content/venia/us/en.html.

  2. Expanda el Buscador de recursos (el carril lateral) en Editar modo. Cambiar el filtro de recursos a Productos.

    Expanda el Buscador de recursos y filtre por productos

  3. Arrastre y suelte un nuevo producto en la página de inicio del contenedor de diseño principal:

    Teaser de productos con borde rosa

    Debe ver que el teaser de productos ahora tiene un borde rosa brillante en función del cambio de regla CSS creado anteriormente.

Verificar las bibliotecas de cliente en la página verify-client-libraries

A continuación, compruebe la inclusión de las bibliotecas de cliente en la página.

  1. Vaya a Página principal del sitio: http://localhost:4502/editor.html/content/venia/us/en.html.

  2. Seleccione el menú Información de página y haga clic en Ver tal y como aparece publicado:

    Ver como aparece publicado

    AEM Esto abre la página sin que se haya cargado ninguno de los JavaScript de autor de la, ya que aparecería en el sitio publicado. Observe que la dirección URL tiene el parámetro de consulta ?wcmmode=disabled anexado. AEM Al desarrollar CSS y JavaScript, se recomienda utilizar este parámetro para simplificar la página sin nada del autor de la.

  3. Vea el origen de la página y para identificar varias bibliotecas de cliente:

    code language-html
    <!DOCTYPE html>
    <html lang="en-US">
    <head>
        ...
        <link rel="stylesheet" href="/etc.clientlibs/venia/clientlibs/clientlib-base.min.css" type="text/css">
        <link rel="stylesheet" href="/etc.clientlibs/venia/clientlibs/clientlib-site.min.css" type="text/css">
    </head>
    ...
        <script type="text/javascript" src="/etc.clientlibs/venia/clientlibs/clientlib-site.min.js"></script>
        <script type="text/javascript" src="/etc.clientlibs/core/wcm/components/commons/site/clientlibs/container.min.js"></script>
        <script type="text/javascript" src="/etc.clientlibs/venia/clientlibs/clientlib-base.min.js"></script>
    <script type="text/javascript" src="/etc.clientlibs/core/cif/clientlibs/common.min.js"></script>
    <script type="text/javascript" src="/etc.clientlibs/venia/clientlibs/clientlib-cif.min.js"></script>
    </body>
    </html>
    

    Las bibliotecas de cliente cuando se entregan a la página tienen el prefijo /etc.clientlibs y se sirven a través de una proxy para evitar exponer elementos confidenciales en /apps o /libs.

    Aviso venia/clientlibs/clientlib-site.min.css y venia/clientlibs/clientlib-site.min.js. Estos son los archivos CSS y JavaScript compilados derivados del ui.frontend módulo.

Inclusión de la biblioteca de clientes con plantillas de página client-library-inclusion-pagetemplates

Existen varias opciones para incluir una biblioteca del lado del cliente. A continuación, inspeccione cómo el proyecto generado incluye el clientlib-site bibliotecas mediante Plantillas de página.

  1. Vaya a Página principal AEM del sitio dentro del Editor de la: http://localhost:4502/editor.html/content/venia/us/en.html.

  2. Seleccione el Información de página y haga clic en Editar plantilla:

    Editar la plantilla

    Esto abre el Página de aterrizaje plantilla el Inicio se basa en.

    note note
    NOTE
    AEM Para ver todas las plantillas disponibles desde la pantalla Inicio de la, vaya a Herramientas > General > Plantillas.
  3. En la esquina superior izquierda, seleccione el icono Información de página y haga clic en Política de página.

    Elemento de menú de directiva de página

  4. Se abre la directiva de página para la plantilla Página de aterrizaje:

    Política de página: página de aterrizaje

    A la derecha puede ver una lista de bibliotecas de clientes categorías que se incluirán en todas las páginas que utilicen esta plantilla.

    • venia.dependencies : proporciona cualquier biblioteca de proveedor que venia.site depende de.
    • venia.site - Esta es la categoría de clientlib-site que el ui.frontend genera el módulo.

    Observe que otras plantillas utilizan la misma directiva, Página de contenido, Página de aterrizaje, etc. Al reutilizar la misma directiva, podemos garantizar que se incluyan las mismas bibliotecas de cliente en todas las páginas.

    La ventaja de utilizar las plantillas y las directivas de página para administrar la inclusión de bibliotecas de cliente es que puede cambiar la directiva por plantilla. Por ejemplo: quizás esté administrando dos marcas diferentes dentro de la misma instancia de AEM. Cada marca tiene su propio estilo único o tema pero las bibliotecas base y el código serán los mismos. Otro ejemplo: si tiene una biblioteca de cliente más grande que solo desea que aparezca en determinadas páginas, puede crear una directiva de página única solo para esa plantilla.

Desarrollo de Webpack local local-webpack-development

En el ejercicio anterior, se realizó una actualización de un archivo Sass en el ui.frontend AEM y, a continuación, después de realizar una compilación de Maven, los cambios se implementan en el módulo de. A continuación, analizamos el uso de un webpack-dev-server para desarrollar rápidamente los estilos front-end.

AEM El webpack-dev-server proporciona imágenes y algunos de los elementos CSS/JavaScript de la instancia local de la aplicación, pero permite al desarrollador modificar los estilos y el código JavaScript de la aplicación de forma predeterminada. ui.frontend módulo.

  1. En el explorador, vaya a Inicio página y Ver como aparece publicado: http://localhost:4502/content/venia/us/en.html?wcmmode=disabled.

  2. Ver el origen de la página y el copia el HTML sin procesar de la página.

  3. Vuelva al IDE de su elección debajo de ui.frontend módulo abra el archivo: ui.frontend/src/main/static/index.html

    Archivo de HTML estático

  4. Sobrescribir el contenido de index.html y pegar el HTML copió en el paso anterior.

  5. Busque las inclusiones para clientlib-site.min.css, clientlib-site.min.js y quitar a ellos.

    code language-html
    <head>
        <!-- remove this link -->
        <link rel="stylesheet" href="/etc.clientlibs/venia/clientlibs/clientlib-base.min.css" type="text/css">
        ...
    </head>
    <body>
        ...
         <!-- remove this link -->
        <script type="text/javascript" src="/etc.clientlibs/venia/clientlibs/clientlib-site.min.js"></script>
    </body>
    

    Se eliminan porque representan la versión compilada de CSS y JavaScript generados por ui.frontend módulo. AEM Deje las demás bibliotecas de cliente tal como se procesarán como proxy desde la instancia de la instancia de la instancia de en ejecución.

  6. Abra una nueva ventana de terminal y navegue hasta la ui.frontend carpeta. Ejecute el comando npm start:

    code language-shell
    $ cd ui.frontend
    $ npm start
    

    Esto inicia el webpack-dev-server en http://localhost:8080/

    note caution
    CAUTION
    Si aparece un error relacionado con Sass, detenga el servidor y ejecute el comando npm rebuild node-sass y repita los pasos anteriores. Esto puede ocurrir si tiene una versión diferente de npm y node luego se especifica en el proyecto aem-cif-guides-venia/pom.xml.
  7. Vaya a http://localhost:8080/ AEM en una nueva pestaña con el mismo explorador que una instancia de inicio de sesión de. Debería ver la página de inicio de Venia a través del webpack-dev-server:

    Servidor de desarrollo de Webpack en el puerto 80

    Deje el webpack-dev-server en ejecución. Se utiliza en el siguiente ejercicio.

Implementar el estilo de tarjeta para el teaser de productos update-css-product-teaser

A continuación, modifique los archivos Sass en ui.frontend para implementar un estilo de tarjeta para el teaser de productos. El webpack-dev-server se utiliza para ver rápidamente los cambios.

Vuelva al IDE y al proyecto generado.

  1. En el ui.frontend , vuelva a abrir el archivo _productteaser.scss en ui.frontend/src/main/styles/commerce/_productteaser.scss.

  2. Realice los siguientes cambios en el borde del teaser de productos:

    code language-diff
        .item__image {
    -       border: #ea00ff 8px solid;
    +       border-bottom: 1px solid #c0c0c0;
            display: block;
            grid-area: main;
            height: auto;
            opacity: 1;
            transition-duration: 512ms;
            transition-property: opacity, visibility;
            transition-timing-function: ease-out;
            visibility: visible;
            width: 100%;
        }
    

    Guarde los cambios y el webpack-dev-server debe actualizarse automáticamente con los nuevos estilos.

  3. En el teaser de productos, añada una sombra paralela e incluya esquinas redondeadas.

    code language-scss
     .item__root {
         position: relative;
         box-shadow: 0 4px 8px 0 rgba(0,0,0,0.2);
         transition: 0.3s;
         border-radius: 5px;
         float: left;
         margin-left: 12px;
         margin-right: 12px;
    }
    
    .item__root:hover {
       box-shadow: 0 8px 16px 0 rgba(0,0,0,0.2);
    }
    
  4. Actualice el nombre del producto para que aparezca en la parte inferior del teaser y modifique el color del texto.

    code language-css
    .item__name {
        color: #000;
        display: block;
        float: left;
        font-size: 22px;
        font-weight: 900;
        line-height: 1em;
        padding: 0.75em;
        text-transform: uppercase;
        width: 75%;
    }
    
  5. Actualice el precio del producto para que también aparezca en la parte inferior del teaser y modifique el color del texto.

    code language-css
    .price {
        color: #000;
        display: block;
        float: left;
        font-size: 18px;
        font-weight: 900;
        padding: 0.75em;
        padding-bottom: 2em;
        width: 25%;
    
        ...
    
  6. Actualice la consulta de medios en la parte inferior para apilar el nombre y el precio en pantallas de menos de 992 px.

    code language-css
    @media (max-width: 992px) {
        .productteaser .item__name {
            font-size: 18px;
            width: 100%;
        }
        .productteaser .item__price {
            font-size: 14px;
            width: 100%;
        }
    }
    

    Ahora debería ver el estilo de tarjeta reflejado en el webpack-dev-server:

    Cambios en el teaser de Webpack Dev Server

    AEM Sin embargo, aún no se han implementado los cambios en la configuración de los recursos de la. Puede descargar el archivo de solución aquí.

  7. AEM Implemente las actualizaciones para que se utilicen sus habilidades con Maven, desde un terminal de línea de comandos:

    code language-shell
    $ cd aem-cif-guides-venia/
    $ mvn clean install -PautoInstallPackage,cloud
    
    note note
    NOTE
    Existen herramientas y configuración IDE adicionales que pueden sincronizar los archivos de proyecto directamente con una instancia de AEM local sin tener que realizar una compilación completa de Maven.

Ver teaser de productos actualizado view-updated-product-teaser

AEM Una vez que el código del proyecto se haya implementado para su implementación, debería poder ver los cambios en el teaser de productos.

  1. Vuelva al explorador y actualice la página principal: http://localhost:4502/editor.html/content/venia/us/en.html. Debe ver los estilos aplicados del teaser de productos actualizado.

    Estilo del teaser de productos actualizado

  2. Experimente añadiendo teaser de productos adicionales. Utilice el modo Diseño para cambiar la anchura y el desplazamiento de los componentes y mostrar varios teasers en una fila.

    Varios teasers de producto

Solución de problemas troubleshooting

Puede verificarlo en CRXDE-Lite Compruebe que se ha implementado el archivo CSS actualizado: http://localhost:4502/crx/de/index.jsp#/apps/venia/clientlibs/clientlib-site/css/site.css

Al implementar nuevos archivos CSS o JavaScript, también es importante asegurarse de que el explorador no muestre archivos antiguos. Se pueden eliminar borrando la caché del explorador o iniciando una nueva sesión del explorador.

AEM también intenta almacenar en caché las bibliotecas de cliente para el rendimiento. En ocasiones, tras una implementación de código, se muestran los archivos más antiguos. Puede invalidar manualmente la caché de la biblioteca de cliente de AEM con la herramienta Reconstruir bibliotecas de cliente. Invalidar cachés es el método preferido si sospecha que AEM ha almacenado en caché una versión antigua de una biblioteca de cliente. La reconstrucción de bibliotecas es ineficiente y lleva mucho tiempo.

Felicitaciones congratulations

AEM CIF Ha diseñado su primer componente principal de la y ha utilizado un servidor de desarrollo de Webpack.

Desafío de bonificación bonus-challenge

Utilice el sistema de estilos de AEM para crear dos estilos que se puedan activar o desactivar con el autor de contenido. El desarrollo con el sistema de estilos incluye pasos detallados e información sobre cómo hacerlo.

Desafío para una bonificación: Sistema de estilos

Recursos adicionales additional-resources

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2