Personalizzare lo stile dei componenti core CIF di AEM style-aem-cif-core-components

Il progetto CIF Venia è una base di codice di riferimento per l'utilizzo di componenti core CIF. In questo tutorial, analizzerai il progetto di riferimento Venia e capirai come sono organizzati i CSS e il JavaScript utilizzati dai componenti core CIF dell’AEM. Puoi anche creare uno stile CSS con cui aggiornare lo stile predefinito del componente Product Teaser.

TIP
Utilizza l'archetipo del progetto AEM quando avvii l'implementazione di e-commerce.

Cosa verrà creato

In questo tutorial, viene implementato un nuovo stile per il componente Product Teaser, che assomiglia a una scheda. Le lezioni apprese nell’esercitazione possono essere applicate ad altri Componenti core CIF.

Cosa verrà creato

Prerequisiti prerequisites

Per completare questa esercitazione è necessario un ambiente di sviluppo locale. Questo ambiente include un’istanza in esecuzione dell’AEM configurata e connessa a un’istanza Adobe Commerce. Rivedi i requisiti e i passaggi per configurare uno sviluppo locale con AEM as a Cloud Service SDK.

Clonare il progetto Venia clone-venia-project

Stai per clonare il Progetto Venia, quindi sovrascrivere gli stili predefiniti.

NOTE
Puoi utilizzare un progetto esistente (basato sull'archetipo di progetto AEM con CIF incluso) e saltare questa sezione.
  1. Esegui il seguente comando Git per clonare il progetto:

    code language-shell
    $ git clone git@github.com:adobe/aem-cif-guides-venia.git
    
  2. Crea e implementa il progetto in un’istanza locale di AEM:

    code language-shell
    $ cd aem-cif-guides-venia/
    $ mvn clean install -PautoInstallPackage,cloud
    
  3. Aggiungi le configurazioni OSGi necessarie per collegare l’istanza AEM a un’istanza Adobe Commerce o aggiungere le configurazioni al progetto creato.

  4. A questo punto, devi disporre di una versione funzionante di una vetrina connessa a un’istanza di Adobe Commerce. Passare alla pagina US > Home all'indirizzo: http://localhost:4502/editor.html/content/venia/us/en.html.

    Dovresti vedere che la vetrina si basa al momento sul tema Venia. Espandendo il menu principale della vetrina, dovresti vedere diverse categorie, a indicare che la connessione ad Adobe Commerce funziona.

    Vetrina configurata con il tema Venia

Librerie client e modulo ui.frontend introduction-to-client-libraries

I CSS e JavaScript responsabili del rendering del tema o degli stili della vetrina sono gestiti nell'AEM da una libreria client o "clientlibs". Le librerie client forniscono un meccanismo per organizzare CSS e JavaScript nel codice di un progetto e quindi distribuirle sulla pagina.

Gli stili specifici del brand possono essere applicati ai componenti core CIF dell’AEM aggiungendo e ignorando i CSS gestiti da queste librerie client. È fondamentale comprendere in che modo le librerie client sono strutturate e incluse nella pagina.

ui.frontend è un progetto webpack dedicato per gestire tutte le risorse front-end di un progetto. Questo webpack consente agli sviluppatori front-end di utilizzare un numero qualsiasi di lingue e tecnologie come TypeScript, Sass e molto altro.

Il modulo ui.frontend è anche un modulo Maven e integrato con il progetto più grande utilizzando un modulo NPM come aem-clientlib-generator. Durante una compilazione, aem-clientlib-generator copia i file CSS e JavaScript compilati in una libreria client nel modulo ui.apps.

ui.frontend allarchitettura ui.apps

I file CSS e JavaScript compilati vengono copiati dal modulo ui.frontend nel modulo ui.apps come libreria client durante una build Maven

Aggiornare lo stile del teaser ui-frontend-module

Apportare quindi una piccola modifica allo stile Teaser per verificare il funzionamento del modulo ui.frontend e delle librerie client. Utilizza l'IDE che preferisci per importare il progetto Venia. Le schermate utilizzate provengono dall'IDE codice di Visual Studio.

  1. Passa al modulo ui.frontend ed espandilo, quindi espandi la gerarchia delle cartelle fino a: ui.frontend/src/main/styles/commerce:

    cartella di e-commerce ui.frontend

    Si noti che nella cartella sono presenti più file Sass (.scss). Questi file sono gli stili specifici di Commerce per ciascuno dei componenti di Commerce.

  2. Aprire il file _productteaser.scss.

  3. Aggiorna la regola .item__image e modifica la regola del bordo:

    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 regola di cui sopra deve aggiungere un bordo rosa grassetto al componente Product Teaser.

  4. Aprire una nuova finestra del terminale e passare alla cartella ui.frontend:

    code language-shell
    $ cd <project-location>/aem-cif-guides-venia/ui.frontend
    
  5. Esegui il seguente 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 l’uscita del terminale. Il comando Maven ha eseguito diversi script NPM, tra cui npm run build. Il comando npm run build è definito nel file package.json, compila il progetto Webpack e attiva la generazione della libreria client.

  6. Inspect il file ui.frontend/dist/clientlib-site/site.css:

    Sito compilato CSS

    Il file è la versione compilata e minimizzata di tutti i file Sass nel progetto.

    note note
    NOTE
    File di questo tipo vengono ignorati dal controllo del codice sorgente poiché devono essere generati durante il tempo di creazione.
  7. Inspect il file 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: {
    ...
    

    Questo file di configurazione è per aem-clientlib-generator e determina dove e come i file CSS e JavaScript compilati vengono trasformati in una libreria client AEM.

  8. Nel modulo ui.apps, esaminare il file: ui.apps/src/main/content/jcr_root/apps/venia/clientlibs/clientlib-site/css/site.css:

    CSS sito compilato in ui.apps

    Il file è site.css copiato nel progetto ui.apps. Ora fa parte di una libreria client denominata clientlib-site con categoria venia.site. Una volta che il file fa parte del modulo ui.apps, può essere distribuito all'AEM.

    note note
    NOTE
    File di questo tipo vengono ignorati anche dal controllo del codice sorgente in quanto devono essere generati durante il tempo di creazione.
  9. Quindi, esamina le altre librerie client generate dal progetto:

    Altre librerie client

    Queste librerie client non sono gestite dal modulo ui.frontend. Queste librerie client includono invece le dipendenze CSS e JavaScript fornite da Adobe. La definizione di queste librerie client si trova nel file .content.xml sotto ogni cartella.

    clientlib-base - Libreria client vuota che incorpora semplicemente le dipendenze necessarie dai Componenti core AEM. La categoria è venia.base.

    clientlib-cif - Libreria client vuota che incorpora semplicemente le dipendenze necessarie dai componenti core CIF dell'AEM. La categoria è venia.cif.

    clientlib-grid - Include il CSS per abilitare la funzione Griglia reattiva dell'AEM. L'utilizzo della griglia AEM abilita la modalità layout nell'editor AEM e consente agli autori di contenuto di ridimensionare i componenti. La categoria è venia.grid ed è incorporata nella libreria venia.base.

  10. Inspect i file customheaderlibs.html e customfooterlibs.html sotto ui.apps/src/main/content/jcr_root/apps/venia/components/page:

    Script personalizzati per intestazione e piè di pagina

    Questi script includono venia.base e venia.cif librerie come parte di tutte le pagine.

    note note
    NOTE
    Solo le librerie di base sono "hardcoded" come parte degli script di pagina. venia.site non è incluso in questi file ma come parte del modello della pagina per una maggiore flessibilità. Questo processo viene esaminato successivamente.
  11. Dal terminale, crea e implementa l’intero progetto in un’istanza locale dell’AEM:

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

Creare un Product Teaser author-product-teaser

Ora che gli aggiornamenti del codice sono stati distribuiti, aggiungi un’istanza del componente Product Teaser alla home page del sito utilizzando gli strumenti di creazione AEM. In questo modo è possibile visualizzare gli stili aggiornati.

  1. Apri una nuova scheda del browser e passa alla home page del sito: http://localhost:4502/editor.html/content/venia/us/en.html.

  2. Espandi il Finder risorse (barra laterale) in modalità Modifica. Cambia il filtro risorse in Prodotti.

    Espandi il Finder risorse e filtra per Prodotti

  3. Trascina e rilascia un nuovo prodotto nella home page nel Contenitore di layout principale:

    Product Teaser con bordo rosa

    Dovresti notare che il Product Teaser ora presenta un bordo rosa brillante in base alla modifica della regola CSS creata in precedenza.

Verificare le librerie client sulla pagina verify-client-libraries

Verifica quindi l’inclusione delle librerie client nella pagina.

  1. Passare alla home page del sito: http://localhost:4502/editor.html/content/venia/us/en.html.

  2. Seleziona il menu Informazioni pagina e fai clic su Visualizza come pubblicato:

    Visualizza come pubblicato

    Questa pagina si apre senza caricare nessuno dei JavaScript dell’autore dell’AEM, come apparirebbe sul sito pubblicato. All'URL è stato aggiunto il parametro di query ?wcmmode=disabled. Quando si sviluppano CSS e JavaScript, è buona norma utilizzare questo parametro per semplificare la pagina senza alcun intervento da parte dell’autore AEM.

  3. Visualizza il codice sorgente della pagina e individua diverse librerie client incluse:

    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>
    

    Le librerie client recapitate alla pagina hanno il prefisso /etc.clientlibs e vengono servite tramite un proxy per evitare di esporre elementi sensibili in /apps o /libs.

    Avviso venia/clientlibs/clientlib-site.min.css e venia/clientlibs/clientlib-site.min.js. Questi file sono i file CSS e JavaScript compilati derivati dal modulo ui.frontend.

Inclusione della libreria client con i modelli di pagina client-library-inclusion-pagetemplates

Sono disponibili diverse opzioni per includere una libreria lato client. Verifica in che modo il progetto generato include le librerie clientlib-site tramite Modelli di pagina.

  1. Passa alla home page del sito nell'editor AEM: http://localhost:4502/editor.html/content/venia/us/en.html.

  2. Seleziona il menu Informazioni pagina e fai clic su Modifica modello:

    Modifica il modello

    Il modello Pagina di destinazione è aperto su cui si basa la Home pagina.

    note note
    NOTE
    Per visualizzare tutti i modelli disponibili nella schermata iniziale dell'AEM, passa a Strumenti > Generale > Modelli.
  3. Nell’angolo in alto a sinistra, seleziona l’icona Informazioni pagina e fai clic su Criterio pagina.

    Voce di menu Criterio pagina

  4. Criterio pagina viene aperto per il modello Pagina di destinazione:

    Criterio pagina - pagina di destinazione

    Sul lato destro è disponibile un elenco delle librerie client categorie incluse in tutte le pagine che utilizzano questo modello.

    • venia.dependencies - Fornisce tutte le librerie fornitori da cui dipende venia.site.
    • venia.site - Categoria per clientlib-site generata dal modulo ui.frontend.

    Altri modelli utilizzano lo stesso criterio: Pagina contenuto, Pagina di destinazione e così via. Riutilizzando lo stesso criterio, si garantisce che le stesse librerie client vengano incluse in tutte le pagine.

    Quando si gestisce l’inclusione delle librerie client mediante l’uso di modelli e criteri di pagina, si può modificare il criterio a livello di modello. Ad esempio, supponiamo di dover gestire due marchi diversi nella stessa istanza di AEM. Ogni marchio ha un proprio stile o tema, ma le librerie e il codice di base sono gli stessi. Un altro esempio, se disponi di una libreria client più grande che desideri visualizzare solo su determinate pagine, puoi creare un criterio di pagina univoco solo per quel modello.

Sviluppo Webpack locale local-webpack-development

Nell'esercizio precedente è stato effettuato un aggiornamento a un file Sass nel modulo ui.frontend e quindi, dopo aver eseguito una build Maven, le modifiche vengono distribuite all'AEM. Quindi, puoi utilizzare un webpack-dev-server per sviluppare rapidamente gli stili front-end.

Il webpack-dev-server esegue il proxy delle immagini e di alcuni CSS/JavaScript dall'istanza locale dell'AEM, ma consente allo sviluppatore di modificare gli stili e il JavaScript nel modulo ui.frontend.

  1. Nel browser passa alla pagina Home e Visualizza come pubblicato: http://localhost:4502/content/venia/us/en.html?wcmmode=disabled.

  2. Visualizza l'origine della pagina e copia il HTML non elaborato della pagina.

  3. Torna all'IDE scelto sotto il modulo ui.frontend apri il file: ui.frontend/src/main/static/index.html

    File HTML statico

  4. Sovrascrivi il contenuto di index.html e incolla il HTML copiato nel passaggio precedente.

  5. Trovare le "inclusioni" per clientlib-site.min.css, clientlib-site.min.js e rimuoverle.

    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>
    

    Queste "inclusioni" vengono rimosse perché rappresentano la versione compilata di CSS e JavaScript generata dal modulo ui.frontend. Lascia le altre librerie client così come verranno abilitate al proxy dall’istanza AEM in esecuzione.

  6. Aprire una nuova finestra del terminale e passare alla cartella ui.frontend. Eseguire il comando npm start:

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

    Con questo comando viene avviato Webpack-dev-server su http://localhost:8080/

    note caution
    CAUTION
    Se si verifica un errore relativo a Sass, arrestare il server, eseguire il comando npm rebuild node-sass e ripetere i passaggi precedenti. Questo errore può verificarsi se la versione di npm e node è diversa da quella specificata nel progetto aem-cif-guides-venia/pom.xml.
  7. Passa a http://localhost:8080/ in una nuova scheda con lo stesso browser di un'istanza registrata di AEM. Dovresti vedere la home page di Venia tramite il webpack-dev-server:

    Server di sviluppo Webpack sulla porta 80

    Lascia web pack-dev-server in esecuzione. Viene utilizzato nell'esercizio successivo.

Implementare lo stile della scheda per Product Teaser update-css-product-teaser

Modificare quindi i file Sass nel modulo ui.frontend per implementare uno stile di tipo scheda per il Product Teaser. Webpack-dev-server viene utilizzato per visualizzare rapidamente le modifiche.

Torna all’IDE e al progetto generato.

  1. Nel modulo ui.frontend, riaprire il file _productteaser.scss in ui.frontend/src/main/styles/commerce/_productteaser.scss.

  2. Apporta le seguenti modifiche al bordo del Product Teaser:

    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%;
        }
    

    Salva le modifiche; webpack-dev-server verrà aggiornato automaticamente con i nuovi stili.

  3. Aggiungi un’ombra esterna e includi angoli arrotondati al Product Teaser.

    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. Aggiorna il nome del prodotto in modo che venga visualizzato nella parte inferiore del teaser e modifica il colore del testo.

    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. Aggiorna il prezzo del prodotto in modo che venga visualizzato nella parte inferiore del teaser e modifica il colore del testo.

    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. Aggiorna la query multimediale nella parte inferiore, in modo da poter impilare il nome e il prezzo in schermi più piccoli di 992px.

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

    Ora dovresti vedere lo stile della scheda riflesso nel webpack-dev-server:

    Modifiche al teaser di Webpack Dev Server

    Tuttavia, le modifiche non sono ancora state implementate nell'AEM. Puoi scaricare il file della soluzione qui.

  7. Distribuisci gli aggiornamenti a AEM utilizzando le tue competenze Maven, da un terminale della riga di comando:

    code language-shell
    $ cd aem-cif-guides-venia/
    $ mvn clean install -PautoInstallPackage,cloud
    
    note note
    NOTE
    Sono disponibili strumenti e configurazione IDE aggiuntivi per sincronizzare i file di progetto direttamente con un’istanza AEM locale senza dover eseguire una generazione Maven completa.

Visualizzare il Product Teaser aggiornato view-updated-product-teaser

Dopo aver implementato il codice per il progetto nell’AEM, dovresti essere in grado di visualizzare le modifiche apportate al Product Teaser.

  1. Torna al browser e aggiorna la home page: http://localhost:4502/editor.html/content/venia/us/en.html. Dovresti vedere gli stili del product teaser aggiornati.

    Stile del Product Teaser aggiornato

  2. Prova ad aggiungere altri Product Teaser. Utilizza la modalità Layout per modificare la larghezza e l’offset dei componenti in modo da visualizzare più teaser su una riga.

    Product Teaser multipli

Risoluzione dei problemi troubleshooting

In CRXDE-Lite puoi verificare che il file CSS aggiornato sia stato distribuito: http://localhost:4502/crx/de/index.jsp#/apps/venia/clientlibs/clientlib-site/css/site.css

Durante la distribuzione di nuovi file CSS, JavaScript o entrambi, è importante assicurarsi che il browser non distribuisca file non aggiornati. Puoi eliminare questo potenziale problema cancellando la cache del browser o avviando una nuova sessione del browser.

AEM inoltre tenta di memorizzare nella cache le librerie client per migliorare le prestazioni. A volte, dopo la distribuzione del codice, vengono distribuiti i file meno recenti. Puoi annullare manualmente la validità della cache della libreria client di AEM utilizzando lo strumento Rigenera librerie client. Se si sospetta che AEM abbia memorizzato nella cache una versione precedente di una libreria client, è meglio annullare la validità della cache. La rigenerazione delle librerie è infatti inefficiente e richiede molto tempo.

Complimenti congratulations

Hai terminato di creare lo stile del primo componente core CIF AEM e hai utilizzato un server di sviluppo Webpack.

Sfida bonus bonus-challenge

Utilizza il sistema di stili AEM per creare due stili che possono essere attivati o disattivati da un autore di contenuti. Lo sviluppo con il sistema di stili include passaggi dettagliati e informazioni su come eseguire questa attività.

Sfida bonus - Sistema di stili

Risorse aggiuntive additional-resources

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab