Der Styleguide bringt eine Reihe von Basisjavascripten mit, welche die Verteilung der Inhalte auf die einzelnen Seiten übernehmen.
print-document.js
Dient als Haupteinstiegspunkt für das Javascript und übernimmt das Erstellen der Seiten und das Platzieren von Countern. Dieses Javascript kann nicht ausgetauscht werden.
print-element.js
Repräsentiert ein platzierbares Element und wird als Standardskript genutzt, falls ein Element kein eigenes Skript nutzt. Ein Element kann ein solches Skript mithilfe des HTML-Attributes data-print-module
definieren. Diese Skripte müssen von der Hauptklasse PrintElement
ableiten.
'use strict' // noinspection JSFileReferences import PrintElement from "./print-element.js"; export default class PrintCustom extends PrintElement { async process(page, previous) { // Prüfmethode für "break-before" und "vacant-before" if (false === await this._preflight(page, previous)) { return false } // Platziermethode welche immer wieder aufgerufen wird. Sie muss entweder true oder false zurückgeben // - false bedeutet "nicht fertig", das Element wurde gar nicht oder nicht abschließend platziert // - true bedeutet "fertig", das Element wurde platziert und es kann mit dem nächsten forgefahren werden return true } }
Puppeteer per Kommandozeile
Mit component-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:
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. |