...
| Codeblock |
|---|
| language | js |
|---|
| theme | RDark |
|---|
| title | Struktur der custom-styleguide.config.json |
|---|
| collapse | true |
|---|
|
{
"label": "custom",
"order": 123,
"priority": 456,
"depends": ["framework-styleguide", "other-styleguide"],
"preview": "@preview-framework-styleguide"
}
|
| Eigenschaft | Beschreibung |
|---|
label | Der Name des Styleguides welcher innerhalb der Fractal-Oberfläche dargestellt wird. |
order | Die Position des Styleguides innerhalb der Fractal-Oberfläche. Diese Eigenschaft bestimmt nur die Position innerhalb der Liste aller Styleguides und hat keinerlei Einfluss auf die Priorität des Styleguides. |
priority | Die Priorität des Styleguides bestimmt die Ladereihenfolge der HBS-Dateien (Partials) und Überschreibungsreihenfolge der SCSS-Dateien. Es wird mindestens 500 als Priorität empfohlen, zudem muss diese einzigartig sein. |
depends | Legt die Reihenfolge und Styleguides fest, welche vor diesem Styleguide verarbeitet werden müssen. Styleguides welche für eine Benutzeroberfläche erstellt werden, müssen mindestens den framework-styleguide als Abhängigkeit ausweisen. |
preview | Die innherlab von der Fractal-Oberfläche genutzte Rahmenvorlage für die Darstellung einer Komponente. |
Optionale Ordner
Nicht alle in der Sturktur gelisteten Order sind notwendig um einen Styleguide einsatzfähig zu machen. Nachfolgend finden Sie eine Liste der optionalen Order und ihrer Funktionen.
| Order | Beschreibung |
|---|
asset | Hier können Bilddateien innerhalb des Unterordners images und Schriftdateien für Browser innerhalb des Unterordners fonts abgelegt werden. Diese Dateien werden durch einen Node-Task aus allen Styleguides eingesammelt und an eine öffentlich zugängliche Stelle der brandbox-Installation kopiert. |
javascript | Hier können Javascripte, welche keiner Komponente zuzuordnen sind, abgelegt werden. Diese werden zusätzlich zu den Javascripten der Komponenten eingesammelt und eine öffentlich zugängliche Stelle kopiert. |
scss | Zusätzlich zu den SCSS-Dateien der einzelnen Komponenten können globale SCSS-Dateien in diesem Order abgelegt werden. Weitere Informationen hierzu sind den nachfolgenden Punkten zu entnehmen. |
templates | Manche Subsysteme von brandbox gestatten die Auswahl einer Rahmenvorlage. Dabei werden unter anderem die HBS-Dateien aus diesen optionalen Ordnern der Styleguides angeboten. |
Sonderrolle scss