Skip to content

pantoken / design/swatches/src / toSwatches

Funció: toSwatches()

toSwatches(tokens, mode?): Swatch[]

Experimental

Reduir un token IR a una llista plana de mostres de color: resoldre referències, triar un mode, mantenir només els tokens amb valor de color hexadecimal (les icones i els tokens no-color es descarten).

Paràmetres

tokens

només de lectura Token[]

La IR (p. ex. de @pantoken/tokens).

mode?

Mode = "light"

Quin mode de color resoldre (per defecte "light").

Retorna

Swatch[]

La llista de mostres, anomenada per token (sense el prefix --instui-).

Exemples

Reduir el token IR a mostres de mode clar

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

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

Mode fosc

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

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