Attribut och typer

Läs mer om de dataattribut och datatyper som krävs för den universella redigeraren.

Introduktion

För att ett program ska kunna redigeras av den universella redigeraren måste det vara ordentligt instrumenterat. Detta inkluderar rätt metadata så att redigeraren kan redigera innehållet i programmet. Det här dokumentet innehåller information om attributen och typerna för dessa metadata.

OBSERVERA

Innehållsvalidering utförs på serversidan. Den universella redigeraren fungerar helt enkelt med dataattributen. Verifiering av att de passar modellen/strukturen måste åtgärdas på API-nivå.

Dataegenskaper

Dataegenskap Beskrivning
itemid URN to the resource, see the section Instrument the Page of the document Getting Started with the Universal Editor in AEM
itemprop Resursens attribut, se avsnittet Instrument the Page of the document Getting Started with the Universal Editor in AEM
itemtype Typ av redigerbart objekt (till exempel text, bild och referens)
data-editor-itemfilter Definierar vilka referenser som kan användas
data-editor-itemlabel Definierar en anpassad etikett för ett markeringsbart objekt som visas i redigeraren
Om itemmodel är inställd hämtas etiketten med hjälp av modellen
data-editor-itemmodel Definierar en modell som används för formulärbaserad redigering i egenskapsfältet
data-editor-behavior Definierar beteendet för en instrumentering, t.ex. fristående text eller bild kan också efterlikna en komponent så att den kan flyttas eller tas bort

Objekttyper

itemtype Beskrivning itemid itemprop data-editor-itemfilter data-editor-itemlabel data-editor-itemmodel data-editor-behvior
text Texten kan redigeras i HTML-taggarna, men bara i ett enkelt textformat, ingen formatering, det här används ofta för rubrikkomponenter, till exempel Valfritt Obligatoriskt n/a Valfritt n/a Valfritt
richtext Texten kan redigeras med omfattande textfunktioner. RTE visas på den högra panelen Valfritt Obligatoriskt n/a Valfritt n/a Valfritt
media Det redigerbara är en resurs, t.ex. bild eller video Valfritt Obligatoriskt Valfritt
lista med bild- eller videofiltervillkor som skickas till resursväljaren		 Valfritt n/a Valfritt
container De redigerbara funktionerna fungerar som behållare för komponenter som kallas Styckesystem. Beroende
se nedan		 Beroende
se nedan		 Valfritt
en lista över tillåtna komponenter		 Valfritt n/a n/a
component Det redigerbara är en komponent. Det lägger inte till ytterligare funktioner. Det är obligatoriskt att ange flyttbara/borttagbara delar av DOM och att öppna egenskapsspåret och dess fält Obligatoriskt n/a n/a Valfritt Valfritt n/a
reference Det redigerbara är en referens, t.ex. Content Fragment, Experience Fragment eller Product Beroende
se nedan		 Beroende
se nedan		 Valfritt
lista med villkor för innehållsfragment, produkt eller Experience Fragment-filter som skickas vidare till referensväljaren		 Valfritt Valfritt n/a

Beroende på användningsfallet itemprop eller itemid kan vara nödvändigt eller inte. Till exempel:

  • itemid är obligatoriskt om du skickar frågor till innehållsfragment via GraphQL och vill göra listan redigerbar i sitt sammanhang.
  • itemprop krävs om du har en komponent som återger innehållet i ett refererat innehållsfragment och du vill uppdatera referensen i komponenten.

Beteenden

data-editor-behavior Beskrivning
component Används för att tillåta fristående text, fullödig text och mediemimiska komponenter så att de också kan flyttas och tas bort på sidan
container Används för att tillåta att behållare behandlas som sina egna komponenter så att de kan flyttas och tas bort på sidan

Ytterligare resurser

Mer information om Universal Editor finns i de här dokumenten.

På denna sida