Implementering av lokala komponenter

Komponentinstansen skapas av komponentfabriksobjektet.

Objektposten för komponentfabriken i komponentregistreringsfilen är initData.componentFactory. Det här är en referens till en JavaScript-fil som RequireJS använder för att ladda komponentfabriken. Den måste returnera ett JavaScript-objekt som implementerar gränssnittet componentFactory

Komponentfabriksobjektet måste implementera API-gränssnittet customComponentFactory.createComponent(args), som skapar varje instans av komponenten.

args innehåller följande inställningar:

  • SitesSDK: Oracle Content Management SDK för webbplatser.

  • id: Det unika id:t (GUID) för komponenten som läggs till på sidan.

  • viewMode: Det aktuella läge som sidan återger. När en sida redigeras är det "Redigera". När en sida förhandsgranskas är det "Navigera". Vid exekveringen, dvs. när webbplatsen publiceras, är värdet odefinierat. Du kan ange olika implementeringar, beroende på vilken funktion som ska göras tillgänglig för varje läge. Till exempel ska länkar inte vara aktiva när sidan körs i redigeringsläge.

Obs!:

Det är inget krav att använda JQuery eller Knockout för komponenten, men om du vill dra nytta av funktioner från Oracle Content Management, t.ex. kapslade komponenter, måste du använda den version av Knockout som tillhandahålls av Oracle Content Management. Den här versionen av Knockout har utökad komponentregistrering och utökade hanterare, vilket du inte skulle ha tillgång till annars.

För komponenten i sig överförs SDK:t in när komponenten instansieras, så att komponenten kan kommunicera med sidlivscykeln. Funktionerna för sidlivscykel måste implementeras av komponenten och anropas av Oracle Content Management för återgivning av komponenten på sidan.

Obligatoriska och valfria API-gränssnitt tillhandahålls för implementering av en komponent.

Obligatoriska API-gränssnitt

customComponent.render(container): Ber komponenten att infoga sig i det angivna DOM-containerelementet.

  • container: DOM-containerelement för den anpassade komponentens HTML.

Valfria API-gränssnitt

customComponent.dispose(): Anropas när komponenten tas bort från sidan. Ger komponenten möjlighet att ta bort resurser som inte längre krävs.