Binden an eine Designsystem-Bibliothek
Produktbildschirme müssen das Designsystem des Projekts verwenden, nicht nur lokale Layer.
Ein Preset auswählen
Jedes Designsystem hat ein Preset im Verzeichnis presets/. Frage den Benutzer, welches Preset das Projekt verwendet, oder prüfe die Abhängigkeiten des Projekts (z. B. wenn das Projekt von einem Designtoken-Paket abhängt, verwende das passende Preset). Das Format ist in presets/README.md beschrieben. Wenn kein Preset existiert, suche einmalig wie unter „Wie automatisches Binden funktioniert“ unten beschrieben, und speichere das Ergebnis als neues Preset. Wenn das Projekt keine Bibliothek hat, schreibe „Keine“ und erwähne dies im Bericht.
Bevor du beginnst, verwende get_libraries, um zu bestätigen, dass sich jede Bibliothek in libraries_added_to_file befindet. Falls welche fehlen, bitte den Benutzer, sie in Figma unter Assets › Bibliotheken hinzuzufügen; fahre erst fort, wenn sie hinzugefügt sind.
Bindungsregeln
Es ist besser, etwas ungebunden zu lassen, als den Bildschirm zu verändern. Das Werkzeug führt nur die unten aufgeführten Aktionen aus; alles andere bleibt lokal und wird gemeldet.
| Typ | Regel | Nicht tun |
|---|---|---|
| Farbe | Nur bei exakter Übereinstimmung binden, einschließlich Deckkraft. Halbtransparente Farben benötigen einen Token mit dieser Transparenz, da Figma beim Binden die Deckkraft auf 1 zurücksetzt | Nicht an die nächstgelegene Farbe annähern |
| Radius, Strich, Abstand, Schriftgröße | Nur binden, wenn der Wert exakt gleich ist | 3px nicht auf 2px oder 4px ändern |
| Alias-Token | Ein Token, der auf einen anderen Token verweist (semantischer Token über einem primitiven), zählt mit dem Wert am Ende der Kette. Wenn ein Wert beide hat, gewinnt der Token mit eigenem Wert; der Alias wird nur für Werte verwendet, die sonst kein Token hat | Nicht zwischen zwei semantischen Token mit demselben Wert raten; melden |
| Textstil | Nur binden, wenn Schriftart, Größe und Zeilenhöhe alle gleich sind | Wenn die Schriftart abweicht, nur die Größe binden |
| Icon | Nur ersetzen, wenn die Bibliothek eine Komponente mit demselben Namen hat; alte Namen nur für Zuordnungen akzeptieren, die denselben Zweck bestätigen | Kein Icon mit ähnlicher Bedeutung aber anderem Aussehen verwenden |
| Komponente | Nur ersetzen, wenn die Bibliothekskomponente gleich aussieht wie die Produktkomponente; die Größe des Produkts beibehalten | Wenn sie anders aussieht, lokale Komponente behalten und Produktbildschirm nicht ändern |
Warum nicht auf den nächstgelegenen Wert annähern: Ein passender Wert bedeutet nicht unbedingt eine passende Bedeutung, und es führt dazu, dass das Zustandsboard nicht mit dem Code übereinstimmt. Ein Wert ohne passenden Token ist eine Lücke im Designsystem; liste ihn zur Designer-Entscheidung auf, anstatt das Werkzeug wählen zu lassen.
Wie automatisches Binden funktioniert
Mit einem Preset setze preset in der al-capture.cjs-Konfiguration und übergib den Preset-Namen als viertes Argument an al-pack.py; Bildschirme werden automatisch gebunden, wenn sie erstellt werden. Nur ohne Preset befolge den untenstehenden Prozess und speichere das Ergebnis als presets/<name>.json: libs ist die Bindungskonfiguration, und extract ist das Sprite-Mapping, das während der Extraktion verwendet wird.
- Liste nach dem Extrahieren des Layoutbaums jedes
lib(Icon-Name) im JSON auf - Suche für jeden Namen im Icon-System mit
search_design_system:system:crosswird zuicon / system / cross. Akzeptiere nur exakte Namensübereinstimmungen - Verwende
search_design_system, um das Komponenten-Set zu finden, platziere einige Instanzen, mache Screenshots davon, vergleiche ihr Aussehen mit dem Produkt und legebuttons.rulesfest - Setze
opts.libszusammen. Erstelle zunächst 3–4 Karten und überprüfelog.driftund die Screenshots; führe Batch-Verarbeitung nur durch, wenn sie richtig aussehen
const libs = {
tokens: ['My DS - Foundation'], // Variablen aus diesen Bibliotheken lesen
icons: { 'system:cross': '<componentKey>' },
buttons: {
set: '<componentSetKey>',
rules: { FFE13A: { Type: 'primary', Size: 'medium', Compact: 'false', Status: 'default' } }, // Schlüssel ist die Hintergrundfarbe des Buttons
},
words: { value: 'Price' }, // Texteigenschaften umbenennen, um den Begriffen des Teams zu entsprechen
};
Die Ausgabe von al-capture.cjs enthält unmappedIcons, die Icons dieser Verwendung auflistet, die das Preset noch nicht zugeordnet hat. Suche sie mit search_design_system und füge exakte Namensübereinstimmungen zum Preset hinzu; beim nächsten Mal werden sie automatisch gebunden, sodass das Preset mit der Zeit vollständiger wird.
Das von __alBuild zurückgegebene stat enthält die Bindungsergebnisse: boundColors, boundLayout, libIcons, dsButtons, unboundColors, localIcons.
Binden vorhandener Bildschirme
al-bind.js kann eigenständig verwendet werden. Es bindet nur Tokens und tauscht keine Icons oder Komponenten aus. Füge das gesamte Skript in use_figma ein (oder lade es mit eval), und rufe dann Folgendes auf:
return await __alBind(['<frame id>'], { tokens: ['<library name>'] });
Es gibt boundColors, boundLayout und unboundColors (Farben ohne Token) zurück. skippedText zählt Text, dessen Schriftart nicht geladen werden konnte, sodass seine Größe ungebunden blieb.
Wenn Bildschirme mit __alBuild erstellt werden, wird die Tokentabelle in _registry zwischengespeichert, sodass spätere Bildschirme nicht jede Variable erneut importieren müssen. Sie wird neu aufgebaut, wenn das Preset andere Token-Bibliotheken auflistet. Nachdem die Bibliothek neue oder geänderte Token veröffentlicht hat, übergib refreshTokens: true an den nächsten __alBuild-Aufruf.
Komponenten
- Mit Auto Layout zentrieren: nicht mit Abstand oder Textfeldbreite, damit eine Textänderung ihn nicht verschiebt
- Container sind keine Komponenten: eine wiederholte Struktur, die bereits Komponenten enthält, ist nur ein Container
- Zustände sind Varianten: Ausgewählt und deaktiviert müssen über Eigenschaften umschaltbar sein, nicht durch Überschreiben von Instanzfarben
- Kleine Komponenten in Eigenschaften aufteilen: zwei Varianteneigenschaften,
TypeundState; mache den Text zu einer Komponenteneigenschaft - Hauptkomponenten müssen vollständig sein: mache keine Elemente, die durch den Viewport abgeschnitten sind, zu Komponenten
Bericht
Liste immer auf:
- Bindungsrate: Farben, Layout-Werte
- Anzahl der Icons und Komponenten, die gegen Bibliotheksversionen ausgetauscht wurden
- Farben ohne Token (die obersten), zur Entscheidung für das Design
- Icons und Komponenten, die lokal behalten wurden, und warum