Stil AEM CIF kärnkomponenter

Senaste uppdatering: 2024-02-23

The CIF Venia Project är en referenskodbas för att använda CIF kärnkomponenter. I den här självstudiekursen inspekterar du Venias referensprojekt och förstår hur CSS och JavaScript som används AEM kärnkomponenterna är ordnade. Du kan också skapa ett format med hjälp av CSS för att uppdatera standardformatet för Product Teaser -komponenten.

TIPS

Använd AEM projekttyp när du startar en egen implementering av e-handeln.

Vad du ska bygga

I den här självstudiekursen implementeras en ny stil för Product Teaser-komponenten som liknar ett kort. Lektioner du lär dig i självstudiekursen kan användas på andra CIF.

Vad du ska bygga

Förutsättningar

Det krävs en lokal utvecklingsmiljö för att slutföra den här självstudiekursen. Den här miljön innehåller en instans av AEM som körs och som är konfigurerad och ansluten till en Adobe Commerce-instans. Granska kraven och stegen för konfigurera en lokal utveckling med AEM as a Cloud Service SDK.

Klona Veniaprojektet

Du kommer att klona Venedig-projektetoch åsidosätt sedan standardformaten.

OBSERVERA

Du kan använda ett befintligt projekt (baserat på AEM Project Archetype med CIF inkluderat) och hoppa över det här avsnittet.

  1. Kör följande Git-kommando så att du kan klona projektet:

    $ git clone git@github.com:adobe/aem-cif-guides-venia.git
    
  2. Skapa och distribuera projektet till en lokal instans av AEM:

    $ cd aem-cif-guides-venia/
    $ mvn clean install -PautoInstallPackage,cloud
    
  3. Lägg till nödvändiga OSGi-konfigurationer så att du kan ansluta AEM till en Adobe Commerce-instans eller lägga till konfigurationerna i det skapade projektet.

  4. Nu bör du ha en fungerande version av en storefront som är ansluten till en Adobe Commerce-instans. Navigera till US > Home sida vid: http://localhost:4502/editor.html/content/venia/us/en.html.

    Du ser att butiken för närvarande använder temat Venia. När du expanderar huvudmenyn för butiken bör du se olika kategorier som anger att anslutningen till Adobe Commerce fungerar.

    Storefront konfigurerat med Venia-tema

Klientbibliotek och modulen ui.frontEdge

Den CSS och JavaScript som ansvarar för återgivningen av temat/formaten för butiken hanteras i AEM av en klientbibliotek eller"clientlibs" för kort tid. Klientbibliotek erbjuder en mekanism för att ordna CSS och JavaScript i ett projekts kod och sedan leverera på sidan.

Du kan använda varumärkesspecifika format på AEM kärnkomponenter genom att lägga till och åsidosätta den CSS som hanteras av dessa klientbibliotek. Det är viktigt att förstå hur klientbibliotek är strukturerade och inkluderas på sidan.

The ui.front är en dedikerad webbpaket projekt för att hantera alla resurser för ett projekt. Med det här webbpaketet kan utvecklare använda valfritt antal språk och tekniker som TypeScript, Sassoch mycket annat.

The ui.frontend modulen är också en Maven-modul och integrerad med det större projektet genom att använda en NPM-modul i aem-clientlib-generator. Under en byggprocess aem-clientlib-generator kopierar de kompilerade CSS- och JavaScript-filerna till ett klientbibliotek i ui.apps -modul.

ui.front-to-ui.apps-arkitektur

Kompilerad CSS och JavaScript kopieras från ui.frontend till ui.apps som ett klientbibliotek under uppbyggnaden av Maven

Uppdatera Teaser Style

Gör sedan en liten ändring av Teaser-stilen för att se hur ui.frontend modul- och klientbibliotek fungerar. Använd den utvecklingsmiljö du vill för att importera Venia-projektet. Skärmbilder som används finns i Visual Studio Code IDE.

  1. Navigera och expandera ui.front och expandera mapphierarkin till: ui.frontend/src/main/styles/commerce:

    ui.front.commerce, mapp

    Observera att det finns flera Sass (.scss) filer under mappen. Dessa filer är de handelsspecifika formaten för var och en av Commerce-komponenterna.

  2. Öppna filen _productteaser.scss.

  3. Uppdatera .item__image och ändra kantlinjalen:

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

    Regeln ovan bör lägga till en fet rosa ram i Product Teaser Component.

  4. Öppna ett nytt terminalfönster och navigera till ui.frontend mapp:

    $ cd <project-location>/aem-cif-guides-venia/ui.frontend
    
  5. Kör följande Maven-kommando:

    $ 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 terminalutdata. Observera att kommandot Maven körde flera NPM-skript, inklusive npm run build. The npm run build -kommandot definieras i package.json och sammanställer webbpaketprojektet och aktiverar genereringen av klientbiblioteket.

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

    Kompilerad CSS för webbplats

    Filen är den kompilerade och minimerade versionen av alla Sass-filer i projektet.

    OBSERVERA

    Filer som detta ignoreras från källkontrollen eftersom de ska genereras under byggtiden.

  7. Inspect filen 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: {
    ...
    

    Den här konfigurationsfilen är avsedd för aem-clientlib-generator och avgör var och hur kompilerad CSS och JavaScript omvandlas till ett AEM klientbibliotek.

  8. I ui.apps kontrollerar du filen: ui.apps/src/main/content/jcr_root/apps/venia/clientlibs/clientlib-site/css/site.css:

    Kompilerad CSS för webbplats i ui.apps

    Filen är site.css kopieras till ui.apps projekt. Den ingår nu i ett klientbibliotek med namnet clientlib-site med en kategori venia.site. När filen ingår i ui.apps -modul som den kan distribueras till AEM.

    OBSERVERA

    Filer som detta ignoreras också i källkontrollen eftersom de ska genereras under byggtiden.

  9. Kontrollera sedan de andra klientbiblioteken som genereras av projektet:

    Andra klientbibliotek

    Dessa klientbibliotek hanteras inte av ui.frontend -modul. I stället innehåller dessa klientbibliotek CSS- och JavaScript-beroenden från Adobe. Definitionen för dessa klientbibliotek finns i .content.xml under varje mapp.

    clientlib-base - Ett tomt klientbibliotek som helt enkelt bäddar in nödvändiga beroenden från AEM kärnkomponenter. Kategorin är venia.base.

    klientlib-cif - Ett tomt klientbibliotek som helt enkelt bäddar in nödvändiga beroenden från AEM CIF kärnkomponenter. Kategorin är venia.cif.

    clientlib-grid - Innehåller CSS för att aktivera funktionen AEM responsivt stödraster. Med AEM stödraster aktiveras Layoutläge i AEM Editor och ger innehållsförfattare möjlighet att ändra storlek på komponenter. Kategorin är venia.grid och är inbäddad i venia.base bibliotek.

  10. Inspect filerna customheaderlibs.html och customfooterlibs.html under ui.apps/src/main/content/jcr_root/apps/venia/components/page:

    Anpassade skript för sidhuvud och sidfot

    Dessa skript innehåller venia.base och venia.cif bibliotek som en del av alla sidor.

    OBSERVERA

    Endast basbiblioteken är"hårdkodade" som en del av sidskripten. venia.site tas inte med i de här filerna utan inkluderas i sidmallen för större flexibilitet. Den här processen granskas senare.

  11. Bygg och distribuera hela projektet till en lokal instans av AEM:

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

Skapa en produkttekniker

Nu när koduppdateringarna har distribuerats lägger du till en instans av Product Teaser-komponenten på webbplatsens startsida med hjälp av AEM utvecklingsverktyg. Då kan vi visa de uppdaterade formaten.

  1. Öppna en ny flik i webbläsaren och gå till Hemsida för platsen: http://localhost:4502/editor.html/content/venia/us/en.html.

  2. Expandera tillgångssökaren (sidospåret) i Redigera läge. Växla resursfiltret till Produkter.

    Expandera Resurssökning och filtrera efter produkter

  3. Dra och släpp en ny produkt på startsidan i huvudlayoutbehållaren:

    Product Teaser med rosa kantlinje

    Du bör se att Product Teaser nu har en ljusrosa kantlinje som baseras på CSS-regeländringen som skapades tidigare.

Verifiera klientbibliotek på sidan

Kontrollera sedan att klientbiblioteken finns med på sidan.

  1. Navigera till Hemsida för platsen: http://localhost:4502/editor.html/content/venia/us/en.html.

  2. Välj Sidinformation meny och klicka Visa som publicerad:

    Visa som publicerad

    Den här sidan öppnas utan att någon av författarna till JavaScript har lästs in, som den skulle se ut på den publicerade webbplatsen. Observera att URL:en har frågeparametern ?wcmmode=disabled tillagd. När du utvecklar CSS och JavaScript är det en god vana att använda den här parametern för att förenkla sidan utan att behöva skriva något AEM.

  3. Visa sidkällan så bör du kunna identifiera flera klientbibliotek:

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

    Klientbibliotek som levereras till sidan har prefix /etc.clientlibs och hanteras via proxy för att undvika att exponera något känsligt i /apps eller /libs.

    Meddelande venia/clientlibs/clientlib-site.min.css och venia/clientlibs/clientlib-site.min.js. Dessa filer är de kompilerade CSS- och JavaScript-filerna som kommer från ui.frontend -modul.

Inkludering av klientbibliotek med sidmallar

Det finns flera alternativ för hur du inkluderar ett klientbibliotek. Kontrollera sedan hur det genererade projektet innehåller clientlib-site bibliotek via Sidmallar.

  1. Navigera till Hemsida för webbplatsen i AEM: http://localhost:4502/editor.html/content/venia/us/en.html.

  2. Välj Sidinformation meny och klicka Redigera mall:

    Redigera mallen

    The Landningssida mallen öppnas när Startsida sidan baseras på.

    OBSERVERA

    Om du vill visa alla tillgängliga mallar från AEM startskärmen går du till verktyg > Allmänt > Mallar.

  3. I det övre vänstra hörnet väljer du Sidinformation ikon och klicka Sidprofil.

    Menyalternativ för sidpolicy

  4. Sidprofilen öppnas för mallen Landningssida:

    Sidprofil - landningssida

    Till höger ser du en lista över klientbibliotek kategorier som finns på alla sidor som använder den här mallen.

    • venia.dependencies - Tillhandahåller eventuella leverantörsbibliotek som venia.site beroende av.
    • venia.site - kategorin för clientlib-site som ui.frontend modulen genererar.

    Observera att samma policy används för andra mallar, Innehållssida, Landningssida och så vidare. Genom att återanvända samma princip säkerställs att samma klientbibliotek inkluderas på alla sidor.

    Fördelen med att använda mallar och sidprofiler för att hantera inkludering av klientbibliotek är att du kan ändra principen per mall. Du kanske hanterar två olika varumärken inom samma AEM. Varje varumärke har sin egen stil eller tema men basbiblioteken och koden är desamma. Om du har ett större klientbibliotek som du bara vill visa på vissa sidor kan du skapa en unik sidprofil för just den mallen.

Utveckling av lokala webbpaket

I föregående övning gjordes en uppdatering av en Sass-fil i ui.frontend och sedan efter att ha utfört en Maven-bygge distribueras ändringarna till AEM. Därefter ska vi titta på hur du använder en webpack-dev-server för att snabbt utveckla front end-formaten.

Webbpack-dev-server-proxies bilder och en del CSS/JavaScript från den lokala instansen av AEM men gör det möjligt för utvecklaren att ändra formaten och JavaScript i ui.frontend -modul.

  1. Navigera till Startsida sida och Visa som publicerad: http://localhost:4502/content/venia/us/en.html?wcmmode=disabled.

  2. Visa sidans och copy HTML i obearbetat format på sidan.

  3. Gå tillbaka till den utvecklingsmiljö du valt under ui.frontend för att öppna filen: ui.frontend/src/main/static/index.html

    Statisk HTML-fil

  4. Skriv över innehållet i index.html och klistra in HTML som kopierades i föregående steg.

  5. Sök efter"inkluderar" för clientlib-site.min.css, clientlib-site.min.jsoch ta bort dem.

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

    Dessa inkluderingar tas bort eftersom de representerar den kompilerade versionen av CSS och JavaScript som genereras av ui.frontend -modul. Lämna kvar de andra klientbiblioteken som de kommer att proxideras från den AEM som körs.

  6. Öppna ett nytt terminalfönster och navigera till ui.frontend mapp. Kör kommandot npm start:

    $ cd ui.frontend
    $ npm start
    

    Det här kommandot startar webbpack-dev-server på http://localhost:8080/

    FÖRSIKTIGHET

    Om du får ett Sass-relaterat fel stoppar du servern och kör kommandot npm rebuild node-sass och upprepa stegen ovan. Detta fel kan uppstå om du har en annan version av npm och node än vad som anges i projektet aem-cif-guides-venia/pom.xml.

  7. Navigera till http://localhost:8080/ på en ny flik med samma webbläsare som en inloggad instans av AEM. Du kan se Venias hemsida via webbpack-dev-server:

    Webbpaketets dev-server på port 80

    Låt webbpack-dev-server vara igång. Det används i nästa övning.

Implementera kortstil för Product Teaser

Ändra sedan Sass-filerna i dialogrutan ui.frontend för att implementera en kortliknande stil för Product Teaser. Webbpack-dev-server används för att snabbt se ändringarna.

Återgå till utvecklingsmiljön och det genererade projektet.

  1. I ui.front modul, öppna filen igen _productteaser.scssui.frontend/src/main/styles/commerce/_productteaser.scss.

  2. Gör följande ändringar i Product Teaser-gränsen:

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

    Spara ändringarna och webbpack-dev-server uppdateras automatiskt med de nya formaten.

  3. Lägg till en skugga och ta med rundade hörn i Product Teaser.

     .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. Uppdatera produktens namn så att det visas längst ned på teaser och ändra textfärgen.

    .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. Uppdatera produktens pris så att det också visas längst ned på teaser och ändra textfärgen.

    .price {
        color: #000;
        display: block;
        float: left;
        font-size: 18px;
        font-weight: 900;
        padding: 0.75em;
        padding-bottom: 2em;
        width: 25%;
    
        ...
    
  6. Uppdatera mediefrågan längst ned så att du kan stapla namnet och priset på skärmar som är mindre än 992px.

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

    Nu bör du se kortstilen återspeglas i webbpack-dev-server:

    Ändringar av Dev Server-teaser i Webpack

    Ändringarna har dock inte distribuerats till AEM än. Du kan ladda ned lösningsfil här.

  7. Distribuera uppdateringarna till AEM med hjälp av dina Maven-kunskaper från en kommandoradsterminal:

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

    Det finns ytterligare IDE-inställningar och -verktyg som kan synkronisera projektfiler direkt till en lokal AEM utan att behöva utföra en fullständig Maven-konstruktion.

Visa uppdaterad Product Teaser

När koden för projektet har distribuerats till AEM kan du nu se ändringarna i Product Teaser.

  1. Gå tillbaka till webbläsaren och uppdatera hemsidan: http://localhost:4502/editor.html/content/venia/us/en.html. Du bör se hur de uppdaterade produktmallarna används.

    Uppdaterad Product Teaser-stil

  2. Experimentera genom att lägga till ytterligare produktutbildningar. Använd layoutläget om du vill ändra komponenternas bredd och förskjutning så att flera scener visas på en rad.

    Flera produktteam

Felsökning

Du kan verifiera CRXDE-Lite att den uppdaterade CSS-filen har distribuerats: http://localhost:4502/crx/de/index.jsp#/apps/venia/clientlibs/clientlib-site/css/site.css

När du distribuerar nya CSS-filer, JavaScript-filer eller båda, är det också viktigt att se till att webbläsaren inte hanterar inaktuella filer. Du kan eliminera det här potentiella problemet genom att rensa webbläsarens cache eller starta en ny webbläsarsession.

AEM försöker också cachelagra klientbibliotek för att få prestandan. Efter en koddistribution skickas de äldre filerna ibland. Du kan göra AEM klientbibliotekscachen ogiltig manuellt med Återskapa verktyget Klientbibliotek. Ogiltiga cacheminnen är att föredra om du misstänker att AEM har cachelagrat en gammal version av ett klientbibliotek. Det är ineffektivt och tidskrävande att återskapa bibliotek.

Grattis

Du har utformat din första AEM CIF Core Component och du använde en webbpaketdev-server!

Bonus Challenge

Använd AEM om du vill skapa två format som kan aktiveras och avaktiveras av en innehållsförfattare. Utveckla med Style System innehåller detaljerade steg och information om hur du utför den här uppgiften.

Bonus Challenge - system av olika slag

Ytterligare resurser

På denna sida