Stilsystem

Letzte Aktualisierung: 2024-02-26

Das Stilsystem ermöglicht es einem Vorlagenautor, in der Inhaltsrichtlinie für Komponenten Stilklassen festzulegen, die ein Inhaltsautor später bei der Bearbeitung der Komponente auf einer Seite auswählen kann. Diese Stile können alternative visuelle Varianten einer Komponente sein, um die Komponente flexibler zu gestalten.

Dadurch entfällt die Notwendigkeit, eine benutzerdefinierte Komponente für jeden Stil zu entwickeln oder das Komponentendialogfeld anzupassen, um eine solche Stilfunktion zu aktivieren. Das Resultat sind mehr wiederverwendbare Komponenten, die schnell und einfach an die Bedürfnisse von Inhaltsautoren angepasst werden können, ohne dass eine AEM-Backend-Entwicklung erforderlich ist.

Nutzungsszenario

Vorlagenautorinnen und -autoren benötigen nicht nur die Möglichkeit, die Funktionsweise von Komponenten für Inhaltsautorinnen und -autoren zu konfigurieren, sondern müssen auch in der Lage sein, eine Reihe alternativer visueller Varianten einer Komponente zu konfigurieren.

Ebenso müssen Inhaltsautorinnen und -autoren nicht nur die Möglichkeit haben, ihren Inhalt zu strukturieren und anzuordnen, sondern sie müssen auch auswählen können, wie er visuell dargestellt wird.

Das Stilsystem bietet eine einheitliche Lösung für die Anforderungen des Vorlagenautors und des Inhaltsautors:

  • Vorlagenautorinnen und -autoren können in der Inhaltsrichtlinie von Komponenten Stilklassen definieren.
  • Inhaltsautorinnen und -autoren können diese Klassen dann aus einer Dropdown-Liste auswählen, wenn sie die Komponente auf einer Seite bearbeiten, um die entsprechenden Stile anzuwenden.

Die Stilklasse wird dann in das dekorative Wrapper-Element der Komponente eingefügt, sodass die Entwicklerin bzw. der Entwickler der Komponente sich nicht um die Handhabung der Stile kümmern muss, sondern lediglich die CSS-Regeln festzulegen braucht.

Übersicht

Die allgemeine Verwendung des Stilsystems sieht wie folgt aus.

  1. Der Webdesigner erstellt unterschiedliche visuelle Varianten einer Komponente.

  2. Dem HTML-Entwickler werden die HTML-Ausgabe der Komponenten sowie die zu implementierenden visuellen Varianten zur Verfügung übermittelt.

  3. Der HTML-Entwickler definiert die CSS-Klassen, die der jeweiligen visuellen Variante entsprechen und die in das Wrapper-Element der Komponenten eingefügt werden sollen.

  4. Der HTML-Entwickler implementiert den entsprechenden CSS-Code (und optional JS-Code) für die einzelnen visuellen Varianten, damit diese wie definiert angezeigt werden.

  5. Der AEM-Entwickler legt den bereitgestellten CSS-Code (und optional JS-Code) in einer Client-Bibliothek ab und stellt ihn bereit.

  6. Der AEM-Entwickler oder der Vorlagenautor konfiguriert die Seitenvorlagen und bearbeitet die Richtlinien für die formatierten Komponenten mit den definierten CSS-Klassen. Dabei legt er benutzerfreundliche Namen für die einzelnen Stile fest und definiert, welche Stile kombiniert werden können.

  7. Der AEM-Seitenautor kann die entworfenen Stile daraufhin über das Stilmenü in der Symbolleiste einer Komponente im Seiteneditor auswählen.

Nur die letzten drei Schritte werden in AEM ausgeführt. Dies bedeutet, dass die gesamte Entwicklung des erforderlichen CSS und JavaScript ohne AEM durchgeführt werden kann.

Für die eigentliche Bereitstellung der Stile ist nur die Bereitstellung in AEM sowie die Auswahl innerhalb der Komponenten der gewünschten Vorlagen erforderlich.

Das folgende Diagramm veranschaulicht die Architektur des Stilsystems.

aem-style-system

Verwenden Sie

Zur Veranschaulichung der Funktion werden wir die WKND-Implementierung der Komponente Titel der Kernkomponente als Beispiel verwenden.

In den folgenden Abschnitten Als Inhaltsautor und Als Vorlagenautor wird beschrieben, wie Sie die Funktionalität des Stilsystems mit dem WKND-Stilsystem testen können.

Wenn Sie das Stilsystem für Ihre eigenen Komponenten verwenden möchten, gehen Sie wie folgt vor:

  1. Installieren Sie das CSS als Client-Bibliotheken, wie im Abschnitt Überblick erklärt.
  2. Konfigurieren Sie die CSS-Klassen, die Sie Ihren Inhaltsautorinnen und Inhaltsautoren zur Verfügung stellen möchten, wie im Abschnitt Als Vorlagenautorin bzw. -autor beschrieben.
  3. Inhaltsautorinnen bzw. -autoren können die Stile daraufhin wie im Abschnitt Als Inhaltsautorin bzw. -autor beschrieben verwenden.

Als Inhaltsautor

  1. Gehen Sie nach der Installation des WKND-Projekts zur englischsprachigen Primär-Homepage von WKND unter http://<host>:<port>/sites.html/content/wknd/language-masters/en und bearbeiten Sie die Seite.

  2. Wählen Sie weiter unten auf der Seite eine Komponente Titel aus

    Stilsystem für den Autor

  3. Wählen Sie die Schaltfläche Stile in der Symbolleiste der Komponente Liste aus, um das Stilmenü zu öffnen und das Erscheinungsbild der Komponente zu ändern.

    Auswählen von Stilen

    HINWEIS

    In diesem Beispiel schließen sich die Farbstile (Schwarz, Weiß und Grau) gegenseitig aus, während die Stiloptionen (Unterstrichen, Rechtsbündig ausrichten und Mini-Abstand) kombiniert werden können. Dies kann vom Vorlagenautor in der Vorlage konfiguriert werden.

Als Vorlagenautor

  1. Bei der Bearbeitung der englischsprachigen Primär-Homepage von WKND unter http://<host>:<port>/sites.html/content/wknd/language-masters/en können Sie die Vorlage der Seite über Seiteninformationen > Vorlage bearbeiten anpassen.

    Vorlage bearbeiten

  2. Bearbeiten Sie die Richtlinien für die Komponente Titel, indem Sie auf die Schaltfläche Richtlinie der Komponente klicken.

    Richtlinie bearbeiten

  3. Auf der Registerkarte „Stile“ in den Eigenschaften können Sie sehen, wie die Stile konfiguriert wurden.

    Eigenschaften bearbeiten

    • Gruppenname: Stile können im Stilmenü gruppiert werden, das den Inhaltsautorinnen und Inhaltsautoren angezeigt wird, während sie den Stil einer Komponente konfigurieren.
    • Stile können kombiniert werden: Ermöglicht die gleichzeitige Auswahl mehrerer Stile innerhalb dieser Gruppe.
    • Stilname: Die Beschreibung des Stils, der den Inhaltsautorinnen bzw. -autoren beim Konfigurieren des Komponentenstils angezeigt wird.
    • CSS-Klassen: Der tatsächliche Name der CSS-Klasse, die dem Stil zugeordnet ist.

    Ordnen Sie die Gruppen und die Stile innerhalb der Gruppen mithilfe der Ziehpunkte. Nutzen Sie die Symbole „Hinzufügen“ oder „Löschen“, um Gruppen bzw. Stile innerhalb der Gruppen hinzuzufügen oder zu entfernen.

VORSICHT

Die als Stil-Eigenschaften einer Komponentenrichtlinie konfigurierten CSS-Klassen (sowie das erforderliche JavaScript) müssen als Client-Bibliotheken bereitgestellt werden, damit sie funktionieren.

Einrichtung

Die Kernkomponenten ab Version 2 können die Vorteile des Stilsystems voll nutzen und erfordern keine zusätzliche Konfiguration.

Die folgenden Schritte sind nur erforderlich, um das Stilsystem für Ihre eigenen benutzerdefinierten Komponenten zu aktivieren oder um die optionale Registerkarte „Stile“ im Dialogfeld „Bearbeiten“ zu aktivieren.

Aktivieren der Registerkarte „Stil“ im Dialogfeld „Design“

Damit eine Komponente mit dem Stilsystem von AEM zusammenarbeitet und die Registerkarte „Stil“ in ihrem Design-Dialogfeld angezeigt wird, muss beim Entwickeln der Komponente die Registerkarte „Stil“ mit den folgenden Einstellungen in die Komponente aufgenommen werden:

  • path = "/mnt/overlay/cq/gui/components/authoring/dialog/style/tab_design/styletab"
  • sling:resourceType = "granite/ui/components/coral/foundation/include"
HINWEIS

Dabei werden Überlagerungen über den Sling Resource Merger verwendet.

Ist die Komponente entsprechend konfiguriert, fügt AEM die von den Seitenautorinnen bzw. -autoren festgelegten Stile automatisch in das Dekorationselement ein, das AEM automatisch für jede bearbeitbare Komponente als Wrapper verwendet. Dafür ist keine weitere Aktion der Komponente erforderlich.

Aktivieren der Registerkarte „Stile“ im Dialogfeld „Bearbeiten“

Im Dialogfeld „Bearbeiten“ steht auch eine optionale Registerkarte „Stile“ zur Verfügung. Im Gegensatz zur Registerkarte im Dialogfeld „Design“ ist die Registerkarte im Dialogfeld „Bearbeiten“ für die Funktion des Stilsystems nicht unbedingt erforderlich. Sie stellt jedoch eine optionale alternative Oberfläche dar, über die ein Inhaltsautor Stile festlegen kann.

Die Registerkarte für das Dialogfeld „Bearbeiten“ kann auf ähnliche Weise wie die Registerkarte für das Dialogfeld „Design“ eingebunden werden:

  • path = "/mnt/overlay/cq/gui/components/authoring/dialog/style/tab_edit/styletab"
  • sling:resourceType = "granite/ui/components/coral/foundation/include"
HINWEIS

Dabei werden Überlagerungen über den Sling Resource Merger verwendet.

HINWEIS

Die Registerkarte „Stile“ im Dialogfeld „Bearbeiten“ ist standardmäßig nicht aktiviert.

Stile mit Elementnamen

Mit der String-Array-Eigenschaft cq:styleElements können Entwickler auch eine Liste der zulässigen Elementnamen für Stile in der Komponente konfigurieren. In der Registerkarte „Stile“ für die Richtlinie im Dialogfeld „Design“ können Vorlagenautorinnen und -autoren außerdem Elementnamen auswählen, die für die einzelnen Stile festgelegt werden sollen. Dadurch wird der Elementname des Wrapper-Elements definiert.

Diese Eigenschaft wird auf dem Knoten cq:Component festgelegt. Beispiel:

  • /apps/<yoursite>/components/content/list@cq:styleElements=[div,section,span]
VORSICHT

Definieren Sie keine Elementnamen für Stile, die kombiniert werden können. Wenn mehrere Elementnamen definiert werden, gilt die folgende Prioritätsreihenfolge:

  1. HTL hat stets den Vorrang: data-sly-resource="${'path/to/resource' @ decorationTagName='span'}
  2. Danach wird unter mehreren aktiven Stilen der erste Stil in der Liste der in der Komponentenrichtlinie konfigurierten Stile ausgewählt.
  3. Die Werte cq:htmlTag/cq:tagName der Komponente werden schließlich als Ausweichwert verwendet.

Die Fähigkeit, Stilnamen zu definieren, ist bei generischen Komponenten wie dem Layout-Container oder der Inhaltsfragmentkomponente hilfreich, um diesen eine zusätzliche Bedeutung zu verleihen.

Zum Beispiel können einem Layout-Container dadurch semantische Elemente wie <main>, <aside>, <nav> usw. zugewiesen werden.

Auf dieser Seite