Decoration-Tag

Wenn eine Komponente einer Web-Seite gerendert wird, kann ein HTML-Element generiert werden, das die gerenderte Komponente in sich einschließt. Dies hat zwei Hauptgründe:

  • Eine Komponente kann nur bearbeitet werden, wenn sie mit einem HTML-Element umschlossen ist.
  • Das einschließende Element wird verwendet, um HTML-Klassen anzuwenden, die Folgendes bieten:
    • Layout-Informationen
    • Styling-Informationen

Für Entwickler bietet AEM eine klare und einfache Logik für die Steuerung von Decoration-Tags, die enthaltene Komponenten einschließen. Ob und wie das Decoration-Tag gerendert wird, hängt von der Kombination zweier Faktoren ab, auf die diese Seite eingeht:

  • Die Komponente selbst kann ihr Decoration-Tag mit einer Reihe von Eigenschaften konfigurieren.
  • Die Skripte, die Komponenten enthalten, können die Eigenschaften des Decoration-Tags mit include-Parametern definieren.

Empfehlungen

Im Folgenden finden Sie einige allgemeine Empfehlungen dazu, wann das Wrapper-Element eingeschlossen werden sollte, um unerwartete Probleme zu vermeiden:

  • Das Wrapper-Element sollte nicht zwischen WCMModes (Bearbeitungs- oder Vorschaumodus), Instanzen (Autor oder Veröffentlichung) oder Umgebung (Staging oder Produktion) unterscheiden, sodass CSS und JavaScript der Seite in allen Fällen identisch funktionieren.
  • Das einschließende Element sollte allen bearbeitbaren Komponenten hinzugefügt werden, sodass der Seiteneditor sie korrekt initialisieren und aktualisieren kann.
  • Bei nicht bearbeitbaren Komponenten kann das Wrapper-Element vermieden werden, wenn es keine bestimmte Funktion erfüllt, sodass das resultierende Markup nicht unnötig aufgebläht wird.

Komponentensteuerungen

Die folgenden Eigenschaften und Knoten können auf Komponenten angewendet werden, um das Verhalten ihrer Decoration-Tags zu steuern:

  • cq:noDecoration {boolean}: Diese Eigenschaft kann einer Komponente hinzugefügt werden. Wenn der Wert „true“ lautet, darf AEM keine einschließenden Elemente für die Komponente generieren.
  • cq:htmlTagnode : Dieser Knoten kann unter einer Komponente hinzugefügt werden und die folgenden Eigenschaften aufweisen:
    • cq:tagName {String}: Damit können Sie ein eigenes HTML-Tag angeben, das die Komponenten anstatt des standardmäßigen DIV-Elements einschließen soll.
    • class {String}: Damit können Sie css-Klassennamen angeben, die dem einschließenden Element hinzugefügt werden sollen.
    • Andere Eigenschaftsnamen werden als HTML-Attribute mit demselben String-Wert wie angegeben hinzugefügt.

Skript-Steuerung

Im Allgemeinen lässt sich das Wrapper-Verhalten in HTL wie folgt beschreiben:

  • Standardmäßig wird kein Wrapper-DIV gerendert (wenn nur data-sly-resource="foo" ausgeführt wird).
  • Alle wcm-Modi (deaktiviert, Vorschau, Bearbeitung auf Autor- und Veröffentlichungsinstanz) werden identisch dargestellt.

Das Verhalten des Wrappers kann ebenfalls vollständig gesteuert werden.

  • Das HTL-Skript hat vollständige Kontrolle über das resultierende Verhalten des Wrapper-Tags.
  • Komponenteneigenschaften (wie cq:noDecoration und cq:tagName) können ebenfalls das Wrapper-Tag definieren.

Sie können das Verhalten der Wrapper-Tags von HTL-Skripten und der zugehörigen Logik vollständig kontrollieren.

Weitere Informationen zur Entwicklung in HTL finden Sie unter HTL-Dokumentation.

Entscheidungsbaum

Dieser Entscheidungsbaum fasst die Logik zusammen, die das Verhalten der Wrapper-Tags bestimmt.

Entscheidungsbaum

Anwendungsfälle

Die folgenden drei Anwendungsbeispiele veranschaulichen, wie die Wrapper-Tags verarbeitet werden, und veranschaulichen, wie einfach es ist, das gewünschte Verhalten der Wrapper-Tags zu steuern.

Bei allen nachfolgenden Beispielen wird von der folgenden Inhaltsstruktur und den folgenden Komponenten ausgegangen:

/content/test/
  @resourceType = "test/components/one"
  child/
    @resourceType = "test/components/two"
/apps/test/components/
  one/
    one.html
  two/
    two.html
    cq:htmlTag/
      @cq:tagName = "article"
      @class = "component-two"

Anwendungsfall 1: Einfügen einer Komponente zur Wiederverwendung von Code

Der häufigste Anwendungsfall besteht darin, dass eine Komponente eine andere Komponente enthält, damit Code erneut verwendet werden kann. In diesem Fall soll die enthaltene Komponente nicht mit ihrer eigenen Symbolleiste und ihrem eigenen Dialogfeld bearbeitbar sein, sodass kein Wrapper erforderlich ist und die Komponente cq:htmlTag wird ignoriert. Dies gilt als das Standardverhalten.

one.html: <sly data-sly-resource="child"></sly>

two.html: Hello World!

Dies ergibt die Ausgabe auf /content/test.html:

Hello World!

Ein Beispiel wäre etwa eine Komponente, die eine grundlegende Bildkomponente enthält, um ein Bild anzuzeigen. Dazu verwendet sie normalerweise eine künstliche Ressource, für die eine virtuelle untergeordnete Komponente eingefügt wird, indem ein Map-Objekt an data-sly-resource weitergegeben wird, das alle Eigenschaften enthält, die die Komponente aufweisen würde.

Anwendungsfall 2: Einfügen einer bearbeitbaren Komponente

Bei einem weiteren häufigen Anwendungsfall enthalten Container-Komponenten bearbeitbare untergeordnete Komponenten z. B. einen Layout-Container. In diesem Fall benötigt jedes enthaltene untergeordnete Element einen Wrapper, damit der Editor funktioniert (es sei denn, dies ist explizit mit der Eigenschaft cq:noDecoration deaktiviert).

Da die eingefügte Komponente in diesem Fall eine unabhängige Komponente ist, benötigt sie ein Wrapper-Element, damit der Editor funktioniert und um Layout und Stil anzuwenden. Die Option decoration=true löst dieses Verhalten aus.

one.html: <sly data-sly-resource="${'child' @ decoration=true}"></sly>

two.html: Hello World!

Dies ergibt die Ausgabe auf /content/test.html:

<article class="component-two">Hello World!</article>

Anwendungsfall 3: Benutzerdefiniertes Verhalten

Es sind unendlich viele komplexe Anwendungsfälle möglich, die einfach umgesetzt werden können, indem HTL Folgendes explizit angibt:

  • decorationTagName='ELEMENT_NAME' Definiert den Elementnamen des Wrappers.
  • cssClassName='CLASS_NAME' Definiert die CSS-Klassennamen, die darauf festgelegt werden sollen.

one.html: <sly data-sly-resource="${'child' @ decorationTagName='aside', cssClassName='child'}"></sly>

two.html: Hello World!

Dies ergibt die Ausgabe auf /content/test.html:

<aside class="child">Hello World!</aside>

Auf dieser Seite