Liaison à une bibliothèque de système de design
Les écrans produits doivent utiliser le système de design du projet, pas seulement des calques locaux.
Choisir un preset
Chaque système de design a un preset, dans presets/. Demandez à l'utilisateur lequel le projet utilise, ou vérifiez les dépendances du projet (par exemple, si le projet dépend d'un package de jetons de design, utilisez le preset correspondant). Voir presets/README.md pour le format. S'il n'y a pas de preset, recherchez-le une fois en suivant « Comment fonctionne la liaison automatique » ci-dessous, puis enregistrez le résultat comme nouveau preset. Si le projet n'a pas de bibliothèque, écrivez « Aucun » et mentionnez-le dans le rapport.
Avant de commencer, utilisez get_libraries pour confirmer que chaque bibliothèque est dans libraries_added_to_file. Pour celles qui manquent, demandez à l'utilisateur de les ajouter dans Figma sous Ressources › Bibliothèques ; ne continuez pas tant qu'elles ne sont pas ajoutées.
Règles de liaison
Mieux vaut laisser quelque chose non lié que de modifier l'écran. L'outil ne fait que ce qui est indiqué ci-dessous ; tout le reste reste local et est signalé.
| Type | Règle | Ne pas faire |
|---|---|---|
| Couleur | Lier uniquement en cas de correspondance exacte, y compris l'opacité. Les couleurs semi-transparentes nécessitent un token avec cette transparence, car Figma réinitialise l'opacité à 1 lors de la liaison | Ne pas arrondir à la couleur la plus proche |
| Rayon, trait, espacement, taille de police | Lier uniquement lorsque la valeur est exactement égale | Ne pas transformer 3px en 2px ou 4px |
| Jetons d'alias | Un jeton qui pointe vers un autre jeton (jeton sémantique sur un primitif) compte avec la valeur au bout de la chaîne. Lorsqu'une valeur a les deux, le jeton avec sa propre valeur l'emporte ; l'alias n'est utilisé que pour les valeurs que rien d'autre n'a | Ne pas choisir entre deux jetons sémantiques de même valeur en devinant ; signalez-le |
| Style de texte | Lier uniquement lorsque la police, la taille et la hauteur de ligne sont toutes égales | Si la police diffère, ne lier que la taille |
| Icône | Échanger uniquement lorsque la bibliothèque a un composant avec le même nom ; accepter les anciens noms uniquement pour les mappings confirmés comme ayant le même objectif | Ne pas utiliser une icône avec une signification similaire mais un aspect différent |
| Composant | Échanger uniquement lorsque le composant de la bibliothèque ressemble au produit ; conserver la taille du produit | S'il a un aspect différent, garder le composant local et ne pas modifier l'écran produit |
Pourquoi ne pas arrondir à la valeur la plus proche : une valeur correspondante ne signifie pas une signification correspondante, et cela fait que le tableau d'état diffère du code. Une valeur sans jeton correspondant est un écart dans le système de design ; listez-la pour que le design décide, plutôt que de laisser l'outil choisir.
Comment fonctionne la liaison automatique
Avec un preset, définissez preset dans la configuration al-capture.cjs et passez le nom du preset comme quatrième argument à al-pack.py ; les écrans sont liés automatiquement lorsqu'ils sont construits. Uniquement sans preset, suivez le processus ci-dessous, puis enregistrez le résultat comme presets/<nom>.json : libs est la configuration de liaison, et extract est le mapping de sprites utilisé lors de l'extraction.
- Après avoir extrait l'arbre de mise en page, listez chaque
lib(nom d'icône) dans le JSON - Pour chaque nom, recherchez le système d'icônes avec
search_design_system:system:crosscorrespond àicon / system / cross. N'acceptez que les correspondances exactes de nom - Utilisez
search_design_systempour trouver le jeu de composants, placez quelques instances, prenez des captures d'écran, comparez leur aspect avec le produit, et décidezbuttons.rules - Assemblez
opts.libs. Construisez d'abord 3–4 cartes et vérifiezlog.driftet les captures d'écran ; ne traitez par lots que si elles semblent correctes
const libs = {
tokens: ['My DS - Foundation'], // lire les variables de ces bibliothèques
icons: { 'system:cross': '<componentKey>' },
buttons: {
set: '<componentSetKey>',
rules: { FFE13A: { Type: 'primary', Size: 'medium', Compact: 'false', Status: 'default' } }, // la clé est la couleur d'arrière-plan du bouton
},
words: { value: 'Price' }, // renommer les propriétés de texte pour correspondre aux termes de l'équipe
};
La sortie de al-capture.cjs inclut unmappedIcons, listant les icônes utilisées cette fois que le preset ne mappe pas encore. Recherchez-les avec search_design_system et ajoutez les correspondances exactes de nom au preset ; la prochaine fois, elles seront liées automatiquement, donc le preset devient plus complet à l'usage.
Le stat renvoyé par __alBuild contient les résultats de liaison : boundColors, boundLayout, libIcons, dsButtons, unboundColors, localIcons.
Lier des écrans existants
al-bind.js peut être utilisé seul. Il lie uniquement les jetons et n'échange pas les icônes ou composants. Collez l'intégralité du script dans use_figma (ou chargez-le avec eval), puis appelez :
return await __alBind(['<id du cadre>'], { tokens: ['<nom de la bibliothèque>'] });
Il renvoie boundColors, boundLayout, et unboundColors (couleurs sans jeton). skippedText compte le texte dont la police n'a pas pu être chargée, donc sa taille est restée non liée.
Lorsque les écrans sont construits avec __alBuild, la table des jetons est mise en cache dans _registry afin que les écrans suivants n'importent pas à nouveau chaque variable. Elle est reconstruite lorsque le preset liste différentes bibliothèques de jetons. Après que la bibliothèque publie de nouveaux jetons ou des jetons modifiés, passez refreshTokens: true au prochain appel __alBuild.
Composants
- Centrer avec Auto Layout : pas avec le rembourrage ou la largeur de la zone de texte, pour que changer le texte ne le déplace pas
- Les conteneurs ne sont pas des composants : une structure répétée qui contient déjà des composants n'est qu'un conteneur
- Les états sont des variantes : sélectionné et désactivé doivent pouvoir être commutés via des propriétés, pas en remplaçant les couleurs de l'instance
- Diviser les petits composants en propriétés : deux propriétés de variante,
TypeetState; faire du texte une propriété de composant - Les composants principaux doivent être complets : ne pas faire d'éléments coupés par la zone d'affichage des composants
Rapport
Listez toujours :
- Ratio de liaison : couleurs, valeurs de mise en page
- Nombre d'icônes et de composants échangés contre les versions de la bibliothèque
- Couleurs sans jeton (les premières), pour que le design décide
- Icônes et composants conservés localement, et pourquoi