pantoken-root / design/swatches/src / toSwatches

Fonction: toSwatches() ​

toSwatches(tokens, mode?): Swatch[]

Expérimental

Réduire un IR de tokens en une liste plate d'échantillons de couleurs : résoudre les références, choisir un mode, ne conserver que des tokens dont la valeur est une couleur hexadécimale (les icônes et les tokens non liés aux couleurs sont supprimés).

Paramètres ​

tokens ​

lecture seule Token[]

L'IR (p. ex. provenant de @pantoken/tokens).

mode? ​

Mode = "light"

Quel mode de couleur résoudre (par défaut "light").

Renvoie ​

Swatch[]

La liste d'échantillons, nommée par token (sans le préfixe --instui-).

Exemples ​

Réduire l'IR de tokens en échantillons pour le mode clair

ts
import { toSwatches } from "@pantoken/swatches";
import { tokens } from "@pantoken/tokens";

const swatches = toSwatches(tokens); // [{ name: "color-background-brand", hex: "#…" }, …]

Mode sombre

ts
import { toSwatches } from "@pantoken/swatches";
import { byTheme } from "@pantoken/tokens";

const swatches = toSwatches(byTheme("canvas"), "dark");