Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

Der Styleguide bringt eine Reihe von Basisjavaskripten mit, welche die Verteilung der Inhalte auf die einzelnen Seiten übernehmen. Hierbei gibt es ein übergeordnetes Steuerungsskript aber auch Einzelskripte welche verschiedene Aufgaben für den Aufbau der Seiten ausführen. Diese Basisskripte können nur durch eine Überschreibung über einen eigenen Styleguide ausgetauscht werden. Zudem gibt es die Elementskripte welche die Aufteilung und Platzierung von Styleguidekomponenten übernehmen. Diese Skripte leiten alle von der Basisklasse PrintElement ab und sind für jeweils eine Styleguidekomponente verantwortlich. Ein solches Elementskript kann pro Styleguidekomponente über das Attribut data-print-module definiert werden.

Drawio
bordertrue
diagramNameJavascript (print-styleguide)
simpleViewerfalse
width
linksauto
tbstyletop
lboxtrue
diagramWidth841
revision2

PrintLoader

Diese Basisklasse lädt per HTML-Attribut definierte Javascriptdateien nach und versucht diese auszuführen. Hierbei wird keine Seitenaufteilung vorgenommen sondern nur das definierte Javascript ausgeführt um bspw. Diagramme zu erzeugen. Das zu nutzende HTML-Attribut ist data-styleguide-module. Hier muss wie bei anderen HTML-Attributen (bspw. data-js, data-module, etc.) der Pfad zur Javascriptdatei angegeben werden.

...

Hier findet die Aufteilung auf einzelne Seitenelemente statt. Es werden nacheindander alle Basisseiten (data-print-element="source") verarbeitet. Jedes zu verarbeitende Element kann über das HTML-Attribut data-print-module eine eigene Javascriptklasse definieren. Diese Klassen müssen alle von der Basisklasse PrintElement ableiten.

Basisimplementation für Elementskript
Codeblock
collapse
languagejs
themeRDark
titleBasisimplementation für Elementskript
true
'use strict'

import PrintElement from '/plugin/remote/brandbox-styleguide/print-styleguide/javascript/print-element.js'
import PrintResult from '/plugin/remote/brandbox-styleguide/print-styleguide/javascript/print-result.js'

export default class CustomElement extends PrintElement {

	/**
	 * Diese Methode wird immer wieder aufgerufen, solange PrintResult::completed nicht "true" ist
	 * Bei jedem Ergebnis, was nicht PrintResult::completed === true entspricht, wird zudem eine neue Seite erzeugt
	 *
	 * @param {PrintContext} context Der Kontext in welchem dieses Element platziert werden soll
	 *
	 * @returns {Promise<PrintResult>}
	 */
	async place(context) {

		// Allgemeine Prüfmethode für Standardoptionen (bspw. vacant-before oder break-before)
        // Zudem wird versucht, das Quellelement direkt zu platzieren
		const result = await this._preflight(context)

		if (result instanceof PrintResult) {
			return result
		}

		// Das Originalelement steht über this.source zur Verfügung
		const element = this.source.cloneNode(false)

		// Das Ersatzelement im Elternelement platzieren
		await context.append(element)

		// Es können Optionen des Quellelements abgefragt werden
		if(await this.is('custom-option')) {
			// Auf diese Option reagieren
		}

		// Es können auch Optionen des Kontextes abgefragt werden
		if(await context.is('custom-context-option')) {
			// Auf diese Option reagieren
		}

	  	// Wurde der Seiteninhalt zu groß? 
		if(await context.overflowing()) {

			// Das Element wieder entfernen
			element.remove()
			
			// Die Methode this._exhausted() überprüft ob das Elements bereits zu oft nicht platziert werden konnte
			// und gibt bei Bedarf eine Fehlermeldung in der Konsole aus. Zudem wird damit ein erneutes Platzieren
			// nach zu vielen Versuchen verhindert.
			return new PrintResult(this, await this._exhausted(), null)
		}

		return new PrintResult(this, true, element)
	}
}

Die nachfolgenden Methoden können zusätzlich implementiert werden, wenn diese benötigt werden.

Methodendefinition

Beschreibung

PrintElement::height(element)

Diese Methode wird abgerufen um die Höhe des in element übergebenen Elements zu ermitteln.

PrintElement::update(element)

Diese Methode wird vor einer Höhenermittlung ausgeführt und kann genutzt werden um bspw. Inhalte des element-Elements ein-/auszublenden.

PrintCounter

Hier werden die Zählerdefinitionen verarbeitet und die Ergebnisse ausgegeben.

...

Hier werden die Platzhalterdefinitionen verarbeitet.

Puppeteer per Kommandozeile

Mit brandbox-saas/puppeteer steht eine Implementation von Puppeteer zur Verfügung welche mit dem Javascript des Styleguides zusammenarbeitet. Dieses Javascript verfügt über Parameter welche nachfolgend erklärt werden:

Codeblock
languagetextthemeRDark
node puppeteer.js --source="[Quelle]" --target="[Zielverzeichnis]"


Parametername

Beschreibung

source

Definiert die Quelle für Puppeteer und damit dem Browser innerhalb von Puppeteer. Es kann hier eine normale URL, wie auch in einem Browser, definiert werden.

target

Definiert das Zielverzeichnis für die erstellten HTML-Dateien. Wenn das Verzeichnis nicht exisitiert, wird das Javascript versuchen dieses zu erstellen.

timeout

Legt die maximale Zeit in Millisekunden fest die das Puppeteer-Javascript Inaktivität durch das Styleguide-Javascript dudelt, bevor das Puppeteer-Javascript den Prozess mit einem Fehler beendet.

abort

Wenn dieser Parameter gesetzt wurde, bricht das Puppeteer-Javascript beim ersten Fehler ab, ansonsten werden Fehler zwar geloggt aber das Puppeteer-Javascript läuft bis zum Ende.