Diseño de los componentes principales del CIF de AEM

El CIF Proyecto Venia en la es una base de código de referencia para utilizar Componentes principales del CIF. 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 puede crear un estilo utilizando CSS para actualizar el estilo predeterminado de Teaser de productos componente.

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.

Requisitos previos

Se requiere un entorno de desarrollo local para completar este tutorial. AEM Este entorno incluye una instancia en ejecución de la configurada y conectada a una instancia de Adobe Commerce. Revise los requisitos y pasos para AEM configuración de un desarrollo local con SDK as a Cloud Service.

Clonar el proyecto Venia

Va a clonar el Proyecto Veniay, a continuación, invalide los estilos predeterminados.

1. Ejecute el siguiente comando de Git para poder clonar el proyecto:

   $ git clone git@github.com:adobe/aem-cif-guides-venia.git
   

2. Cree e implemente el proyecto en una instancia local de AEM:

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

3. AEM Añada las configuraciones de OSGi necesarias para poder conectar la instancia de a una instancia de Adobe Commerce o agregar las configuraciones al proyecto 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.

   

Bibliotecas de cliente y módulo ui.frontend

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. Este webpack permite a los desarrolladores de front-end utilizar cualquier número de idiomas 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.

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

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:

   

   Observe que hay varios Sass (.scss) archivos debajo de la carpeta. Estos archivos 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:

   .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:

   $ cd <project-location>/aem-cif-guides-venia/ui.frontend
   

5. Ejecute el siguiente comando Maven:

   $ 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. Observe que el comando Maven ejecutó varios scripts NPM, incluidos npm run build. El npm run build se define en la variable package.json y compila el proyecto webpack y almacena en déclencheur la generación de la biblioteca de cliente.

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

   

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

   NOTA

   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.

   /* 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: {
   ...
   

   Este archivo de configuración es para aem-clientlib-generator AEM y determina dónde y cómo se transforman el CSS compilado y el JavaScript en una biblioteca de cliente de.

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

   

   Este archivo es site.css copiado en el 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.

   NOTA

   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:

   

   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 : una biblioteca de cliente vacía que simplemente incrusta las dependencias necesarias de AEM Componentes principales. La categoría es venia.base.

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

   clientlib-grid AEM : incluye el CSS para habilitar la función Cuadrícula interactiva de la respuesta de la aplicación. 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:

    

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

    NOTA

    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. Este proceso se inspecciona más adelante.

11. AEM Desde el terminal, cree e implemente todo el proyecto en una instancia local de:

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

Crear un teaser de productos

AEM Ahora que se han implementado las actualizaciones de código, añada una instancia del componente teaser de productos a la página de inicio del sitio con las herramientas de creación de. Al hacerlo, podemos 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.

   

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

   

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

Verificación de las bibliotecas de cliente en la página

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:

   

   AEM Esta página se abre 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:

   <!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 archivos 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

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:

   

   El Página de aterrizaje La plantilla se abre para que el Inicio se basa en.

   NOTA

   AEM Para ver todas las plantillas disponibles desde la pantalla de 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.

   

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

   

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

   • venia.dependencies : proporciona cualquier biblioteca de proveedor que venia.site depende de.
   • venia.site - La categoría para 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, se garantiza 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 son iguales. 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

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, observe cómo utilizar 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

   

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.

   <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>
   

   Estas "inclusiones" 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 van a 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:

   $ cd ui.frontend
   $ npm start
   

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

   PRECAUCIÓN

   Si aparece un error relacionado con Sass, detenga el servidor y ejecute el comando npm rebuild node-sass y repita los pasos anteriores. Este error se puede producir si tiene una versión diferente de npm y node de los especificados 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:

   

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

Implementar el estilo de tarjeta para el teaser de productos

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:

       .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.

    .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.

   .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.

   .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 poder apilar el nombre y el precio en pantallas de menor tamaño que 992 px.

   @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:

   

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

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

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

   NOTA

   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.

Visualización de teaser de productos actualizado

AEM Una vez que el código del proyecto se haya implementado para su uso en la aplicació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.

   

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.

   

Solución de problemas

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, archivos JavaScript o ambos, también es importante asegurarse de que el explorador no muestre archivos antiguos. Puede eliminar este posible problema 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

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

Desafío para una bonificación

Utilice el AEM Sistema de estilos de para crear dos estilos que un autor de contenido pueda activar o desactivar. Desarrollo con el sistema de estilos incluye pasos detallados e información sobre cómo realizar esta tarea.

Recursos adicionales

• Tipo de archivo del proyecto AEM
• Componentes principales del CIF de AEM
• Configuración de un Entorno de desarrollo de AEM local
• Bibliotecas de cliente
• Introducción a AEM Sites
• Desarrollo con el sistema de estilos