Utveckla AEM developing-aem-components

AEM används för att lagra, formatera och återge innehåll som är tillgängligt på dina webbsidor.

Kodexempel code-samples

Den här sidan innehåller referensdokumentation (eller länkar till referensdokumentation) som krävs för att utveckla nya komponenter för AEM. Se Utveckla AEM - Kodexempel för några praktiska exempel.

Struktur structure

En komponents grundläggande struktur beskrivs på sidan AEM Komponenter - Grunderna. Dokumentet omfattar både pekaktiverade och klassiska användargränssnitt. Även om du inte behöver använda de klassiska inställningarna i den nya komponenten kan det vara bra att känna till dem när du ärver från befintliga komponenter.

Utöka befintliga komponenter och dialogrutor extending-existing-components-and-dialogs

Beroende på vilken komponent du vill implementera kan det vara möjligt att utöka eller anpassa en befintlig instans i stället för att definiera och utveckla hela strukturen från början.

När du utökar eller anpassar en befintlig komponent eller dialogruta kan du kopiera eller replikera antingen hela strukturen eller den struktur som krävs för dialogrutan innan du gör ändringarna.

Utöka en befintlig komponent extending-an-existing-component

Du kan utöka en befintlig komponent med Resurstypshierarki och de relaterade arvsmekanismerna.

Anpassa en befintlig komponentdialogruta customizing-a-existing-component-dialog

Det går också att åsidosätta en komponentdialogruta med Dela resurssammanfogning och definiera egenskapen sling:resourceSuperType.

Det innebär att du bara behöver definiera om de nödvändiga skillnaderna, i stället för att definiera om hela dialogrutan (med sling:resourceSuperType). Den här metoden rekommenderas nu för att utöka en komponentdialogruta

Mer information finns i Samla resurser.

Definiera markeringen defining-the-markup

Komponenten återges med HTML. Komponenten måste definiera den HTML som behövs för att ta det önskade innehållet och sedan återge det som det behövs, både i författarmiljön och i publiceringsmiljön.

Använda mallspråket HTML using-the-html-template-language

HTML-mallspråket (HTL), som introducerades med AEM 6.0, ersätter JSP (JavaServer Pages) som det rekommenderade serversidesmallsystemet för HTML. För webbutvecklare som behöver bygga robusta företagswebbplatser kan HTML bidra till ökad säkerhet och effektivare utveckling.

Utveckla innehållslogiken developing-the-content-logic

Denna valfria logik markerar och/eller beräknar innehållet som ska återges. Den anropas från HTML-uttryck med rätt Use-API-mönster.

Mekanismen för att skilja logik från utseende gör det lättare att klargöra vad som krävs för en viss vy. Det möjliggör också olika logik för olika vyer av samma resurs.

Använda Java using-java

Använd-API:t för HTL Java möjliggör för en HTML-fil att komma åt hjälpmetoder i en anpassad Java-klass. Detta gör att du kan använda Java-kod för att implementera logiken för att välja och konfigurera komponentinnehållet.

Använda JavaScript using-javascript

Använd-API:t för HTML JavaScript gör att en HTML-fil kan komma åt hjälpkod som skrivits i JavaScript. På så sätt kan du använda JavaScript-kod för att implementera logiken för att välja och konfigurera komponentinnehållet.

Använda HTML-bibliotek på klientsidan using-client-side-html-libraries

Moderna webbplatser är starkt beroende av bearbetning på klientsidan som styrs av komplex JavaScript- och CSS-kod. Det kan vara komplicerat att organisera och optimera serveringen av den här koden.

AEM tillhandahåller Biblioteksmappar på klientsidan som du kan använda för att lagra din klientkod i databasen, ordna den i kategorier och definiera när och hur varje kodkategori ska skickas till klienten. Klientsidans bibliotekssystem tar sedan hand om att skapa rätt länkar på den slutliga webbsidan för att läsa in rätt kod.

Läs Använda bibliotek på klientsidan om du vill ha mer information.

Konfigurera redigeringsbeteendet configuring-the-edit-behavior

Du kan konfigurera redigeringsbeteendet för en komponent, inklusive attribut som åtgärder som är tillgängliga för komponenten, egenskaper för redigeraren och avlyssnare som är relaterade till händelser för komponenten. Konfigurationen är gemensam för det beröringsaktiverade och klassiska användargränssnittet, men med vissa specifika skillnader.

redigeringsbeteendet för en komponent konfigureras genom att lägga till en cq:editConfig-nod av typen cq:EditConfig under komponentnoden (av typen cq:Component) och genom att lägga till specifika egenskaper och underordnade noder.

Konfigurera förhandsvisningsbeteendet configuring-the-preview-behavior

Cookien WCM-läge anges när du växlar till läget Förhandsgranska även när sidan inte uppdateras.

Komponenter med en återgivning som är känslig för WCM-läget måste definieras så att de uppdateras specifikt och sedan förlitar sig på värdet för cookien.

Skapa och konfigurera en dialogruta creating-and-configuring-a-dialog

I dialogrutor kan författaren interagera med komponenten. Med hjälp av en dialogruta kan författare och/eller administratörer redigera innehåll, konfigurera komponenten eller definiera designparametrar (med hjälp av en designdialogruta)

Gränssnittet för korall och GRENITE coral-ui-and-granite-ui

Korallgränssnitt och Beviljite-gränssnitt definierar det moderna utseendet och AEM.

Ett visst användargränssnitt innehåller ett stort antal grundläggande komponenter (widgetar) som behövs för att skapa en dialogruta i redigeringsmiljön. Vid behov kan du utöka den här markeringen och skapa en egen widget.

Mer information finns i:

Skapa en ny dialogruta creating-a-new-dialog

Dialogrutor för användargränssnittet med pekskärm:

En exempelnodstruktur kan vara:

newComponent (cq:Component)
  cq:dialog (nt:unstructured)
    content
      layout
      items
        column
          items
            file
            description

Att anpassa en dialogruta liknar att utveckla en komponent eftersom dialogrutan i sig är en komponent (d.v.s. markering som återges av ett komponentskript tillsammans med beteende/stil som tillhandahålls av ett klientbibliotek).

Se till exempel:

Anpassa dialogrutefält customizing-dialog-fields

Skapa ett nytt fält creating-a-new-field

Widgetar för det beröringsaktiverade användargränssnittet implementeras som GRE-komponenter.

Om du vill skapa en widget som ska användas i en komponentdialogruta för det beröringsaktiverade användargränssnittet måste du skapa en GRA-fältkomponent.

Om du ser dialogrutan som en enkel behållare för ett formulärelement kan du även se det primära innehållet i dialogrutan som formulärfält. När du skapar ett formulärfält måste du skapa en resurstyp. Det motsvarar att skapa en komponent. För att du ska få hjälp med den uppgiften erbjuder GRA UI en generisk fältkomponent att ärva från (med sling:resourceSuperType):

/libs/granite/ui/components/coral/foundation/form/field

Mer specifikt Granite-gränssnittet innehåller ett antal fältkomponenter som är lämpliga att använda i dialogrutor (eller, mer allmänt, i formulär).

När du har skapat resurstypen kan du instansiera fältet genom att lägga till en ny nod i dialogrutan, där egenskapen sling:resourceType refererar till den resurstyp som du just har introducerat.

Skapa ett klientbibliotek för stil och beteende creating-a-client-library-for-style-and-behavior

Om du vill definiera format och beteende för komponenten kan du skapa ett dedikerat klientbibliotek som definierar din anpassade CSS/LESS och JS.

Om du vill att klientbiblioteket endast ska läsas in för komponentdialogrutan (det vill säga inte läsas in för en annan komponent) måste du ange egenskapen extraClientlibs i dialogrutan till kategorinamnet för det klientbibliotek som du har skapat. Detta rekommenderas om klientbiblioteket är mycket stort och/eller om fältet är specifikt för den dialogrutan och inte behövs i andra dialogrutor.

Om du vill att klientbiblioteket ska läsas in för alla dialogrutor anger du kategoriegenskapen för klientbiblioteket till cq.authoring.dialog. Det här är kategorinamnet för klientbiblioteket som inkluderas som standard när alla dialogrutor återges. Du vill göra det om klientbiblioteket är litet och/eller fältet är generiskt och kan återanvändas i andra dialogrutor.

Se följande exempel:

Utöka (ärva från) ett fält extending-inheriting-from-a-field

Beroende på dina behov kan du antingen:

Åtkomst till dialogrutefält access-to-dialog-fields

Du kan också använda återgivningsvillkor ( rendercondition) för att styra vem som har åtkomst till specifika flikar/fält i dialogrutan, till exempel:

+ mybutton
  - sling:resourceType = granite/ui/components/coral/foundation/button
  + rendercondition
    - sling:resourceType = myapp/components/renderconditions/group
    - groups = ["administrators"]

Hantera fälthändelser handling-field-events

Metoden för att hantera händelser i dialogfält har nu utförts med avlyssnare i ett anpassat klientbibliotek. Detta är en ändring från den äldre metoden att ha avlyssnare i innehållsstrukturen.

Lyssnare i ett anpassat klientbibliotek listeners-in-a-custom-client-library

Om du vill mata in logik i fältet bör du:

För att uppnå detta måste du känna till det underliggande widgetbiblioteket som du vill interagera med. Se dokumentationen för det skadade användargränssnittet för att identifiera vilken händelse du vill reagera på. Detta liknar den process du tidigare har utfört med ExtJS: hitta dokumentationssidan för en viss widget och kontrollera informationen om dess händelse-API.

Se följande exempel:

Lyssnare i innehållsstrukturen listeners-in-the-content-structure

I det klassiska användargränssnittet med ExtJS var det vanligt att ha avlyssnare för en viss widget i innehållsstrukturen. Att uppnå samma sak i det beröringskänsliga användargränssnittet skiljer sig från JS-avlyssnarkoden (eller vilken kod som helst) som inte längre är definierad i innehållet.

Innehållsstrukturen beskriver den semantiska strukturen. Den ska (måste) inte innebära den underliggande widgetens typ. Genom att inte ha JS-kod i innehållsstrukturen kan du ändra implementeringsinformationen utan att behöva ändra innehållsstrukturen. Du kan med andra ord ändra widgetbiblioteket utan att behöva ändra innehållsstrukturen.

Dialogrutans tillgänglighet identifieras dialog-ready

Om du har en anpassad JavaScript som endast behöver köras när dialogrutan är tillgänglig och klar bör du lyssna efter händelsen dialog-ready.

Den här händelsen utlöses när dialogrutan läses in (eller läses in igen) och är klar att användas, vilket innebär när det finns en ändring (skapa/uppdatera) i DOM för dialogrutan.

dialog-ready kan användas för att koppla i anpassad JavaScript-kod som utför anpassningar av fälten i en dialogruta eller liknande åtgärder.

Fältvalidering field-validation

Obligatoriskt fält mandatory-field

Om du vill markera ett givet fält som obligatoriskt anger du följande egenskap på innehållsnoden i fältet:

Se följande exempel:

/libs/foundation/components/page/cq:dialog/content/items/tabs/items/basic/items/column/items/title/items/title

Fältvalidering (GRÄNSSNITT) field-validation-granite-ui

Fältvalidering i GRA-gränssnittet och GRA-gränssnittskomponenter (som motsvarar widgetar) görs med API:t foundation-validation. Mer information finns i dokumentationen för foundation-valdiation Granite.

Se till exempel:

Skapa och konfigurera en designdialogruta creating-and-configuring-a-design-dialog

Dialogrutan Design visas när en komponent har designdetaljer som kan redigeras i designläge.

Definitionen liknar den för en dialogruta som används för att redigera innehåll, men skillnaden är att den är definierad som en nod:

Skapa och konfigurera en Inplace-redigerare creating-and-configuring-an-inplace-editor

Med en infogningsredigerare kan användaren redigera innehåll direkt i styckeflödet utan att behöva öppna en dialogruta. Standardkomponenterna Text och Title har till exempel båda en infogad redigerare.

En infogningsredigerare är inte nödvändig/meningsfull för varje komponenttyp.

Mer information finns i Utöka sidredigering - Lägg till ny infogningsredigerare.

Anpassa komponentverktygsfältet customizing-the-component-toolbar

Verktygsfältet Komponent ger användaren tillgång till en rad åtgärder för komponenten, som att redigera, konfigurera, kopiera och ta bort.

Mer information finns i Utöka sidredigering - Lägg till ny åtgärd i ett komponentverktygsfält.

Konfigurera en komponent för referenslinjen (lånad/lånad) configuring-a-component-for-the-references-rail-borrowed-lent

Om den nya komponenten refererar till innehåll från andra sidor kan du överväga om du vill att den ska påverka avsnitten Lånat innehåll och Lånat innehåll i Referenser -svällningen.

AEM markerar bara komponenten Reference. Om du vill lägga till din komponent måste du konfigurera OSGi-paketet WCM Authoring Content Reference.

Skapa en post i definitionen och ange komponenten tillsammans med den egenskap som ska kontrolleras. Till exempel:

/apps/<*your-Project*>/components/reference@parentPath

Aktivera och lägga till komponenten i styckesystemet enabling-and-adding-your-component-to-the-paragraph-system

När komponenten har utvecklats måste den aktiveras för användning i ett lämpligt styckesystem, så att den kan användas på de sidor som krävs.

Detta kan göras antingen genom att:

Konfigurera ett styckesystem så att en komponentinstans skapas när en resurs dras configuring-a-paragraph-system-so-that-dragging-an-asset-creates-a-component-instance

AEM erbjuder möjlighet att konfigurera ett styckesystem på sidan så att en instans av den nya komponenten skapas automatiskt när en användare drar en (lämplig) resurs till en instans av sidan (i stället för att alltid behöva dra en tom komponent till sidan).

Detta beteende och den nödvändiga relationen mellan resurser och komponenter kan konfigureras:

Se exempel:

KOD PÅ GITHUB

Koden för den här sidan finns på GitHub

Använda AEM Brackets Extension using-the-aem-brackets-extension

Tillägget AEM Brackets ger ett smidigt arbetsflöde för att redigera AEM komponenter och klientbibliotek. Den baseras på kodredigeraren Brackets.

Tillägg:

Migrera från en klassisk komponent migrating-from-a-classic-component

När du migrerar en komponent som har utformats för användning med det klassiska användargränssnittet till en komponent som kan användas med det beröringsaktiverade användargränssnittet (antingen enbart eller tillsammans) bör du tänka på följande:

Migrera cq:avlyssnarkod migrating-cq-listener-code

Om du migrerar ett projekt som är utformat för det klassiska användargränssnittet kan cq:listener-koden (och komponentrelaterade klienter) använda funktioner som är specifika för det klassiska användargränssnittet (till exempel CQ.wcm.*). För migreringen måste du uppdatera sådan kod med motsvarande objekt/funktioner i det beröringsaktiverade användargränssnittet.

Om ditt projekt ska migreras helt till det beröringskänsliga användargränssnittet måste du ersätta den koden för att använda de objekt och funktioner som är relevanta för det beröringskänsliga användargränssnittet.

Om ditt projekt måste tillgodose både det klassiska användargränssnittet och det beröringsaktiverade användargränssnittet under migreringsperioden (det vanliga scenariot) måste du implementera en switch för att särskilja den separata koden som refererar till lämpliga objekt.

Den här switchmekanismen kan implementeras som:

if (Granite.author) {
    // touch UI
} else {
    // classic UI
}

Dokumentera komponenten documenting-your-component

Som utvecklare vill du ha enkel åtkomst till komponentdokumentation så att du snabbt kan förstå:

Därför är det enkelt att göra befintliga dokumentationsmarkeringar tillgängliga i själva komponenten.

Placera en README.md-fil i komponentstrukturen. Den här markeringen visas i komponentkonsolen.

Den kod som stöds är densamma som för innehållsfragment.