Einbindung
Eine CSS-Datei, ein optionales Skript, zwei Schriften. Kein Paketmanager.
Schnellstart
Im <head> der Seite:
<link rel="stylesheet" href="/assets/trfx-klick.min.css">
Vor dem Ende von <body>, falls das optionale Skript gebraucht wird:
<script src="/assets/klick.js" defer></script>
Hell und dunkel folgen prefers-color-scheme. Mit data-theme="light" oder data-theme="dark" am <html>-Element lässt sich die Darstellung festlegen.
Schriften
Brom und Krypton liegen nicht im Design System. Das CSS lädt sie von den festen Links der Schriften, https://brom.trfx.de/latest/ und https://krypton.trfx.de/latest/. Dort liegt immer die neueste Version, eine Schriftänderung braucht keine Änderung an der App.
Rückfall: Jede App liefert zusätzlich eine eigene Kopie aus, die sie beim Bauen oder Ausrollen von denselben Links lädt, nie von Hand gepflegt. Der Browser nimmt sie nur, wenn der Link nicht lädt. Der Zielordner fonts/ liegt neben der CSS-Datei (assets/trfx-klick.min.css und assets/fonts/):
mkdir -p assets/fonts
curl -fsSL -o assets/fonts/Brom-VF.woff2 https://brom.trfx.de/latest/Brom-VF.woff2
curl -fsSL -o assets/fonts/Brom-Italic-VF.woff2 https://brom.trfx.de/latest/Brom-Italic-VF.woff2
curl -fsSL -o assets/fonts/Krypton-VF.woff2 https://krypton.trfx.de/latest/Krypton-VF.woff2
-f bricht bei einem Fehler ab, damit nie unbemerkt ohne Rückfall ausgeliefert wird. Für Node-Builds liegt im Ordner fonts/ des Design Systems das Skript fetch-fonts.mjs (node fonts/fetch-fonts.mjs assets/fonts), es prüft zusätzlich, dass die Dateien gültiges WOFF2 sind. Die Lizenzangaben fonts/LICENSES.txt gehören zu jeder ausgelieferten Kopie.
Schriftkette. 1. Brom und Krypton vom festen Link, 2. die Rückfall-Kopie der App (gleicher Familienname), 3. als Rückfall fürs Rückfall Inter (nur Überschriften), IBM Plex Sans und IBM Plex Mono, zuletzt sans-serif bzw. monospace. Diese drei werden nicht ausgeliefert, sie greifen nur, wenn sie auf dem Gerät installiert sind. Nie eine Serifenschrift, auch nicht als allgemeine Schriftfamilie.
--kl-font-sans: "Brom", "IBM Plex Sans", sans-serif;
--kl-font-head: "Brom", "Inter", "IBM Plex Sans", sans-serif;
--kl-font-mono: "Krypton", "IBM Plex Mono", monospace;
Content-Security-Policy. Das Design System nutzt keine Inline-Skripte und keine Inline-Stile. script-src 'self' und style-src 'self' genügen. Nur für die Schriften muss font-src 'self' https://brom.trfx.de https://krypton.trfx.de gesetzt sein ('self' für die Rückfall-Kopie).
Namensschema
- Alle Klassen beginnen mit
kl-, Variablen mit--kl-. kl-bausteinist die Komponente,kl-baustein__teilein Teil davon,kl-baustein--varianteeine Abwandlung.- Komponenten lesen nur Variablen. Feste Farben stehen ausschließlich in
00-tokens.css. - Erweiterungen aus einzelnen Anwendungen tragen das Präfix
klx-.
Dateien
| Datei | Zweck | Größe |
|---|---|---|
trfx-klick.css | Lesbare Fassung mit Kommentaren | 7 KB |
trfx-klick.min.css | Minimierte Fassung für den Einsatz | 5 KB |
klick.js | Optionales Skript | 2 KB |
fonts/LICENSES.txt | Lizenzen der Schriften (gehört zu jeder Kopie) | – |
Änderungen vorschlagen
Anwendungen ändern das Design System nicht selbst. Neue Icons, klx--Bausteine und Änderungen am Design System reichen sie als Vorschlag in der Knowledge Base ein. Der Betreuer des Design Systems prüft sie, übernimmt sie, baut und testet und setzt den Status. Bis dahin nutzt die Anwendung ihre lokale Lösung.
Änderungsprotokoll
0.2.0
- Betrieb wie beim Legacy Design: Docker-Container mit nginx und strenger CSP, Healthcheck, Schutzprüfung für die öffentliche Seite, Live-Prüfung von außen.
- Schriften Brom und Krypton nur noch über die festen Links, Rückfall-Kopie wird beim Bauen geladen.
- Testseite mit Seiten aus
src/pages(Front Matter), Standard-Footer mit vierzehn Links, Logo und Icon lokal. - Vorschlags-Prozess über die Knowledge Base (Präfix
klx-für Erweiterungen).
0.2.2
- Warn-Badge im hellen Modus: leuchtendes Gelb mit dunkler Schrift statt braunem Ocker. Neue Tokens
--kl-warning-solid,--kl-warning-ink.
0.2.1
- Badge neu: eckige, vollflächige Marke ohne Rahmen (vorher Pille mit blassem Hintergrund und Rand). Neue Tokens
--kl-on-status,--kl-radius-sm. - Schriftkette mit Rückfall fürs Rückfall (Inter nur für Überschriften, IBM Plex Sans, IBM Plex Mono), nie Serifen. Neues Token
--kl-font-head.
0.1.0
- Gerüst: Tokens (hell und dunkel), Basis, Button, Eingabe, Badge.