Stil AEM CIF-kärnkomponenter

The CIF Venia Project är en referenskodbas för att använda CIF-kärnkomponenter. I den här självstudiekursen kommer du att granska Venias referensprojekt och förstå hur CSS och JavaScript som används AEM CIF Core-komponenter är organiserade. Du kommer också att skapa ett nytt format med CSS för att uppdatera standardformatet för Product Teaser -komponenten.

TIPS

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

Vad du ska bygga

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

Vad du ska bygga

Förutsättningar

Det krävs en lokal utvecklingsmiljö för att slutföra den här självstudiekursen. Detta inkluderar 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

Vi klonar Venedig-projektet och å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.

Kör följande Git-kommando för att klona projektet:

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

Bygg och distribuera projektet till en lokal instans av AEM:

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

Lägg till nödvändiga OSGi-konfigurationer för att ansluta AEM till en Adobe Commerce-instans eller lägga till konfigurationerna i det nyskapade projektet.
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.

Klientbibliotek och modulen ui.front

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

Märkesspecifika format kan användas på AEM CIF Core-komponenter 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 i ett projekt. Detta gör att gränssnittsutvecklare kan använda valfritt antal språk och tekniker som TypeScript, Sass och 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 en Maven-byggen

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.

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

Observera att det finns flera Sass (.scss) filer under mappen. Det här är de Commerce-specifika formaten för var och en av Commerce-komponenterna.
Öppna filen _productteaser.scss.

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 mycket fet rosa ram i Product Teaser Component.

Öppna ett nytt terminalfönster och navigera till ui.frontend mapp:
```
$ cd <project-location>/aem-cif-guides-venia/ui.frontend
```

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. Du kommer att se att Maven-kommandot har kört flera NPM-skript, inklusive npm run build. The npm run build -kommandot definieras i package.json och har effekten att kompilera webbpaketprojektet och utlösa genereringen av klientbiblioteket.

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

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.

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

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

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

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

OBSERVERA

Filer som detta ignoreras också i källkontrollen eftersom de ska genereras under byggtiden.
Kontrollera sedan de andra klientbiblioteken som genereras av projektet:

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 - Det här är ett tomt klientbibliotek som helt enkelt bäddar in nödvändiga beroenden från AEM kärnkomponenter. Kategorin är venia.base.

klientlib-cif - Det här är också 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 - Detta inkluderar den CSS som behövs för att aktivera funktionen AEM responsivt stödraster. Med AEM stödraster aktiveras Layoutläge i AEM och ger innehållsförfattare möjlighet att ändra storlek på komponenter. Kategorin är venia.grid och är inbäddad i venia.base bibliotek.
Inspect filerna customheaderlibs.html och customfooterlibs.html under ui.apps/src/main/content/jcr_root/apps/venia/components/page:

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. Detta kommer att inspekteras senare.

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 ny instans av Product Teaser-komponenten på webbplatsens startsida med hjälp av AEM utvecklingsverktyg. På så sätt kan vi visa de uppdaterade formaten.

Öppna en ny flik i webbläsaren och gå till Hemsida för platsen: http://localhost:4502/editor.html/content/venia/us/en.html.
Expandera tillgångssökaren (sidospåret) i Redigera läge. Växla resursfiltret till Produkter.
Dra och släpp en ny produkt på startsidan i huvudlayoutbehållaren:

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

Verifiera klientbibliotek på sidan

Kontrollera sedan att klientbiblioteken finns med på sidan.

Navigera till Hemsida för platsen: http://localhost:4502/editor.html/content/venia/us/en.html.
Välj Sidinformation meny och klicka Visa som publicerad:

Sidan öppnas utan att någon av författarens javascript-skript AEM, som det 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 skriva ut något från AEM författare.

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

Navigera till Hemsida för webbplatsen i AEM Editor: http://localhost:4502/editor.html/content/venia/us/en.html.
Välj Sidinformation meny och klicka Redigera mall:

Detta öppnar Landningssida mallen 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.
I det övre vänstra hörnet väljer du Sidinformation ikon och klicka Sidprofil.
Då öppnas sidprincipen för mallen Landningssida:

Till höger ser du en lista över klientbibliotek kategorier som kommer att inkluderas på alla sidor som använder den här mallen.
- venia.dependencies - Tillhandahåller eventuella leverantörsbibliotek som venia.site beroende av.
- venia.site - Det här är kategorin för clientlib-site som ui.frontend modulen genererar.
Observera att samma policy används för andra mallar, Innehållssida, Landningssida, osv… Genom att återanvända samma policy kan vi se till 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 blir 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 använda en webbpack-dev-server för att snabbt utveckla frontendformaten.

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.

Navigera till Startsida sida och Visa som publicerad: http://localhost:4502/content/venia/us/en.html?wcmmode=disabled.
Visa sidans och copy HTML i obearbetat format på sidan.
Gå tillbaka till den utvecklingsmiljö du valt under ui.frontend för att öppna filen: ui.frontend/src/main/static/index.html
Skriv över innehållet i index.html och klistra in HTML som kopierades i föregående steg.

Sök efter inkluderingar för clientlib-site.min.css, clientlib-site.min.js och 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 tas bort eftersom de representerar den kompilerade versionen av CSS och JavaScript som genereras av ui.frontend -modul. Lämna kvar de andra klientbiblioteken så att de proxideras från den AEM som körs.

Öppna ett nytt terminalfönster och navigera till ui.frontend mapp. Kör kommandot npm start:
```
$ cd ui.frontend
$ npm start
```
Detta 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 kan inträffa om en annan version av npm och node anges sedan i projektet aem-cif-guides-venia/pom.xml.
Navigera till http://localhost:8080/ på en ny flik med samma webbläsare som en inloggad instans av AEM. Webbsidan Venia finns på webbpack-dev-server:

Låt webbpack-dev-server vara igång. Det kommer att användas 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.

I ui.front öppna filen igen _productteaser.scss på ui.frontend/src/main/styles/commerce/_productteaser.scss.

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.

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

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

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

    ...

Uppdatera mediefrågan längst ned för att 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:

Ändringarna har dock inte distribuerats till AEM än. Du kan ladda ned lösningsfil här.
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 bör vi nu kunna se ändringarna i Product Teaser.

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.
Experimentera genom att lägga till ytterligare produktutbildningar. Använd layoutläget om du vill ändra komponenternas bredd och förskjutning för att visa flera scener på en rad.

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- och/eller JavaScript-filer är det också viktigt att kontrollera att webbläsaren inte hanterar inaktuella filer. Du kan ta bort detta 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 formaterade just 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/inaktiveras av en innehållsförfattare. Utveckla med Style System innehåller detaljerade steg och information om hur du uppnår detta.

Bonus Challenge - system av olika slag

Stil AEM CIF-kärnkomponenter

Vad du ska bygga

Förutsättningar

Klona Veniaprojektet

Klientbibliotek och modulen ui.front

Uppdatera Teaser Style

Skapa en produkttekniker

Verifiera klientbibliotek på sidan

Inkludering av klientbibliotek med sidmallar

Utveckling av lokala webbpaket

Implementera kortstil för Product Teaser

Visa uppdaterad Product Teaser

Felsökning

Grattis

Bonus Challenge

Ytterligare resurser

Resurser för Business.Adobe.com

På denna sida

Visa nästa:

Lär

Dokumentation

Community

Support

Resurser

Adobe-konto

Adobe