Använda kärnkomponenter using-core-components
För att komma igång med Core Components i ditt eget projekt finns det fyra steg, som beskrivs individuellt i avsnitten nedan:
Komma igång med AEM Sites - WKND-självstudiekurs
Hämta och installera download-and-install
En av de drivande idéerna bakom kärnkomponenterna är flexibilitet. Genom att lansera nya versioner av de centrala komponenterna oftare kan Adobe bli mer flexibelt när det gäller att leverera nya funktioner. Utvecklarna kan i sin tur vara flexibla när det gäller vilka komponenter de väljer att integrera i sina projekt och hur ofta de vill uppdatera dem. Detta resulterar i en separat versionsprocess för både AEM och kärnkomponenterna.
Därför avgör installationsstegen om du kör AEM som en molntjänst eller en lokal tjänst.
AEM as a Cloud Service aemaacs
Det finns inget steg ett! AEM as a Cloud Service har automatiskt den senaste versionen av Core Components. Precis som AEMaaCS erbjuder de senaste funktionerna i AEM håller AEMaaCS automatiskt dig uppdaterad med den senaste versionen av Core Components.
Tänk på några saker när du använder kärnkomponenterna i AEMaaCS:
- Kärnkomponenterna ingår i
/libs. - Projektets pipeline genererar varningar i loggen om den innehåller kärnkomponenterna igen som en del av
/appsoch ignorerar den version som är inbäddad som en del av ditt projekt.- I en kommande version, inklusive Core Components igen, kommer pipeline-bygget att misslyckas.
- Om ditt projekt tidigare innehöll kärnkomponenterna i
/appskan du behöva justera ditt projekt. - Även om kärnkomponenterna nu finns i
/libsrekommenderar vi inte att du skapar någon övertäckning med samma sökväg i/apps. Proxykomponentmönstretbör användas i stället om någon aspekt av komponenterna behöver anpassas. - För att komponenten Innehållsförteckning ska kunna återge sitt innehåll måste ett filter konfigureras i OSGi.
AEM 6.5 och tidigare aem-65
Kärnkomponenterna är inte en del av snabbstarten när de startas i produktionsläge (utan exempelinnehåll). Därför är det första steget att hämta det senaste släppta innehållspaketet från GitHub och installera det i dina AEM miljöer.
Det finns flera sätt att automatisera detta, men det enklaste sättet att snabbt installera ett innehållspaket på en instans är att använda pakethanteraren. Se Installera paket. När du dessutom kör en publiceringsinstans måste du replikera paketet till utgivaren. Se Replikera paket.
Skapa proxykomponenter create-proxy-components
Av orsaker som förklaras i avsnittet Proxykomponentmönster får inte kärnkomponenter refereras direkt från innehållet. För att undvika det tillhör de alla en dold komponentgrupp ( .core-wcm eller .core-wcm-form), vilket förhindrar att de visas direkt i redigeraren.
Istället måste webbplatsspecifika komponenter skapas, som definierar det komponentnamn och den grupp som ska visas för sidförfattare, och referera var och en till en Core Component som supertyp. Dessa platsspecifika komponenter kallas ibland för"proxykomponenter" eftersom de inte behöver innehålla något och i huvudsak används för att definiera vilken version av en komponent som ska användas för webbplatsen. När du anpassar kärnkomponenterna spelar de här proxykomponenterna dock en viktig roll för markering och logikanpassning.
För varje Core Component som ska användas för en plats måste du:
-
Skapa en motsvarande proxykomponent i platsens komponentmapp.
Exempel
Under/apps/my-site/componentsskapar du en titelnod av typencq:Component -
Peka på motsvarande Core Component-version med supertypen.
Exempel
Lägg till följande egenskap:sling:resourceSuperType="core/wcm/components/title/v1/title" -
Definiera komponentens grupp, titel och eventuellt beskrivning. Dessa värden är projektspecifika och styr hur komponenten exponeras för författare.
Exempel
Lägg till följande egenskaper:code language-shell componentGroup="My Site" jcr:title="Title" jcr:description="Section Heading"
Titta till exempel på titelkomponenten för WKND-webbplatsen, som är ett bra exempel på en proxykomponent som är byggd på det sättet.
Läs in kärnformat load-the-core-styles
-
Om det inte är klart än skapar du ett klientbibliotek som innehåller alla CSS- och JS-filer som behövs för platsen.
-
Lägg till beroenden till de kärnkomponenter som kan behövas i webbplatsens klientbibliotek. Detta görs genom att en
embed-egenskap läggs till.Om du till exempel vill inkludera klientbiblioteken för alla v1 Core-komponenter blir den egenskap som ska läggas till:
code language-shell embed="[ core.wcm.components.image.v1, core.wcm.components.list.v1, core.wcm.components.breadcrumb.v1, core.wcm.components.form.container.v1, core.wcm.components.form.text.v1 ]"
Kontrollera att dina proxykomponenter och klientbibliotek har distribuerats till din AEM innan du går vidare till nästa avsnitt.
Tillåt komponenterna allow-the-components
Följande steg utförs i mallredigeraren.
- Markera layoutbehållaren i mallredigeraren och öppna dess profil.
- I listan över tillåtna komponenter väljer du de proxykomponenter som skapats tidigare, som ska visas under komponentgruppen som de tilldelats. När du är klar tillämpar du ändringarna.
- Om du vill kan du förkonfigurera komponenter som har en designdialogruta.
Så ja! På de sidor som skapas från den redigerade mallen bör du nu kunna använda de nya komponenterna.
Läs nästa:
- Anpassa kärnkomponenter - för att lära dig hur du formaterar och anpassar kärnkomponenterna.
- Riktlinjer för komponenter - om du vill lära dig implementeringsmönstren för kärnkomponenterna.