Első lépések
A pantoken átveszi az Instructure UI designtokenjeit és ikonjait, egyszer feloldja őket, és ezt az egyetlen modellt számos platformhoz készült csomagokká formálja: egyszerű stíluslapok, SCSS és Less, React, Vue és Svelte, Tailwind és Panda, natív Swift és Kotlin, WordPress és Drupal, Figma és még sok más.
A feladatodhoz legjobban illeszkedő, legkisebb csomagot telepíted. Az egységesített pantoken csomag mindent újraexportál, így kezdhetsz ott is, és később leszűkítheted.
Kezdőprojekt létrehozása
A leggyorsabb módja a pantoken kipróbálásának: egy olyan kezdőprojekt generálása, amelybe már telepítve és bekötve érkezik.
npx create-pantoken-app reactPlatformok: components (egyszerű HTML/CSS), react, vue, svelte, web-components, angular. Lásd: @pantoken/scaffold a(z) --dir <path> és programozott használathoz. AI kódoló ágenst használsz? A(z) npx @pantoken/ai init ágens-szabályokat és egy olyan /scaffold-pantoken skillt telepít, amely ugyanezt teszi közvetlenül a szerkesztődből.
A tokenmodell
A tokenek --instui-<group>-<name> nevű egyéni CSS-tulajdonságok, például --instui-color-background-brand vagy --instui-spacing-space-md. Három téma érhető el: rebrand (az alapértelmezett, light-dark() értékekkel, ahol a világos és a sötét eltér), canvas és canvasHighContrast. Az ikonok <image> tokenek (--instui-icon-<name>), amelyek a Lucide-ból és az Instructure egyedi glifáiból származnak.
Webalkalmazás stílusozása
Telepítsd a stíluslapot, és importáld egyszer. Ez definiál minden egyes --instui-* tulajdonságot, így közvetlenül hivatkozhatsz rájuk a saját CSS-edből.
npm i @pantoken/cssimport "@pantoken/css/inject";.button {
background: var(--instui-color-background-brand);
padding: var(--instui-spacing-space-md);
}Ikonok használata bárhol
A webkomponens bármely keretrendszerben működik, portolás nélkül.
npm i @pantoken/web-componentsimport "@pantoken/web-components";<instui-icon name="check-mark"></instui-icon>CSS-tokenek
Az ikonok egyéni CSS-tulajdonságok (--instui-icon-<name>). Töltsd be a stíluslapot egyszer, és hivatkozz bármelyik ikonra mint mask-image vagy background-image — nincs szükség ikononkénti importálásra.
.my-icon {
mask-image: var(--instui-icon-check-mark);
}JavaScript — egyetlen ikon vs. teljes készlet
A(z) @pantoken/icons két nevesített exportot biztosít. Használd a(z) iconsByName exportot egyetlen ikon lekéréséhez a teljes tömb bejárása nélkül:
import { iconsByName } from "@pantoken/icons";
const icon = iconsByName.get("check-mark"); // only one lookup
icon?.svg; // inline SVG markupHasználd a(z) icons exportot, amikor a teljes készletre szükséged van (pl. egy választó építéséhez):
import { icons } from "@pantoken/icons";
icons.length; // ~1,800
icons.filter((i) => i.source === "lucide");Mindkét export betölti a teljes IR-t a modul inicializálásakor — ezen a szinten nincs ikononkénti tree-shaking. A karcsú, csak CSS-alapú betöltéshez használd a CDN-választót, hogy létrehozz egy combine URL-t kizárólag a szükséges ikonokhoz.
Generálás natív platformra
A CLI beírja a token forráskódját a célrepóba. A futtatón kívül nincs szükség más telepítésre:
npx pantoken generate swift --out ./ios/Tokens --icons arrow-left,check-markLásd a pantoken CLI-t az összes célplatformhoz.
VS Code szerkesztési tippek
A(z) @pantoken/pantoken mostantól tartalmazza a VS Code custom-data fájljait, így a felhasználó projektek osztály- és token-kiegészítést kaphatnak HTML/CSS-ben anélkül, hogy külön pantoken-specifikus kiterjesztést kellene telepíteniük.
- Telepítsd az egységesített csomagot:
npm i @pantoken/pantoken- Irányítsd a VS Code-ot a mellékelt custom-data JSON-ra a munkaterületedről:
{
"html.customData": ["./node_modules/@pantoken/pantoken/dist/html-custom-data.json"],
"css.customData": ["./node_modules/@pantoken/pantoken/dist/css-custom-data.json"]
}- Töltsd újra a VS Code-ot (vagy futtasd a "Developer: Reload Window" parancsot) az új adatok alkalmazásához.
Ez engedélyezi a javaslatokat a(z) instui-* osztálytokenekhez (és a(z) -modifier osztálytokenekhez), valamint a(z) --instui-* egyéni tulajdonságokhoz.
Merre tovább
- A csomagtérkép — melyik csomagot válaszd, feladat szerint.
- @pantoken/ai — ágenseszközök és szabályok telepítése a fogadó repóban.
- Architektúra — hogyan illeszkedik össze a tokenmodell, a mag (core) és a kimenetek.
- API-referencia — minden exportált szimbólum, a forrásból generálva.