Skip to content

API ​

pantoken هو مستودع أحادي (monorepo) يضم حزمًا صغيرة ذات غرض واحد مجمعة في دلاء. ثبّت الحزمة التي تتناسب مع مهمتك، أو ثبّت الحزمة الموحدة pantoken واستورد من المسارات الفرعية الخاصة بها (على سبيل المثال pantoken/css, pantoken/react, pantoken/tailwind).

Core ​

أهداف أصلية ومولِّدة مواقع، يتم إصدارها عبر CLI أو واجهة برمجة التطبيقات الخاصة بها.

PackageWhat it does
@pantoken/modelZero-dependency TypeScript types: the Token shape and the plugin contract.
@pantoken/coreResolves the upstream tokens and icons into the canonical IR, and renders CSS.
@pantoken/tokensThe resolved IR vendored as static JSON, per theme, plus the raw Tokens Studio source.
@pantoken/utilsThe token resolver, reference regexes, case and color helpers, drift checks, and the token→utility-class emitters.
@pantoken/plugin-kitBuild and compose pantoken plugins with definePlugin.
@pantoken/clipantoken generate <target> — emit native and platform source.

Formats ​

تحويلات اختيارية توسّع مخرجات الرموز أو CSS. انظر Plugins.

PackageOutput
@pantoken/css@property-typed CSS with light-dark() and data-URI icons.
@pantoken/scssSCSS variables, resolved to a single mode.
@pantoken/lessLess variables.
@pantoken/stylusStylus variables.
@pantoken/dtcgA W3C Design Tokens (DTCG) document.
@pantoken/tokensThe IR as JavaScript and JSON (also listed under Core).
@pantoken/iconsAn ergonomic view over the icon tokens.
@pantoken/icon-fontAn icon web font (TTF, WOFF2) plus its CSS.
@pantoken/componentsAn InstUI-look CSS component library (button, alert, table, and more) plus a base reset with focus ring, prose styling, cross-cutting utilities, and the brand fonts. See Components.
@pantoken/inline-stylesGeneric CSS-to-HTML inlining for platform integrations.

Renderers ​

بنية البناء، التوثيق، والبنية التحتية للعروض التوضيحية للمستودع نفسه. معظمها داخلي، لكن القطع معزولة بذاتها، لذا نوثّقها هنا وبعضها يُنشر إلى npm بمفرده.

PackageFor
@pantoken/reactReact hooks, <Icon>, and a token provider.
@pantoken/vue, @pantoken/svelte, @pantoken/angularThe web component, wired into each framework.
@pantoken/react-nativeStyleSheet-friendly token objects (no CSS variables).
@pantoken/web-components<instui-icon> and styled primitives, framework-agnostic.
@pantoken/astroToken setup for Astro sites.
@pantoken/react-markdown, @pantoken/rehypeIcon tokens and swatches in Markdown.
@pantoken/markdown-itA markdown-it plugin for icon codes and color swatches.
@pantoken/css-in-jsA type-safe theme for styled-components and Emotion.
@pantoken/muiA Material UI theme.
@pantoken/bootstrap, @pantoken/shadcnCSS-variable bridges for Bootstrap and shadcn/ui.
@pantoken/foundationA Sass settings override and CSS overlay for Foundation.
@pantoken/docusaurus, @pantoken/vitepressThemes for Docusaurus and VitePress.
@pantoken/mintlifyA Mintlify docs.json theme (colors + background).
@pantoken/storybookA Storybook theme.
@pantoken/pendoInstructure-styled global CSS for Pendo guides.

Bundlers ​

BuildIconFontOptions

PackageFor
@pantoken/viteA Vite plugin with virtual modules and CSS injection.
@pantoken/nextwithPantoken for Next.js transpilePackages.
@pantoken/webpackA webpack plugin.
@pantoken/postcssThe @pantoken; at-rule.
@pantoken/tailwindA Tailwind preset.
@pantoken/pandaA Panda CSS preset.

Platforms ​

أصول إعدادات الذكاء الاصطناعي الموجهة للمستهلك. هذه للمشروعات التي تستخدم pantoken، وليست لتطوير pantoken نفسه.

PackageOutput
@pantoken/swiftSwift source plus a SwiftPM manifest stub.
@pantoken/androidAndroid XML resources.
@pantoken/composeJetpack Compose Kotlin.
@pantoken/flutterFlutter Dart.
@pantoken/rustRust consts for egui or iced.
@pantoken/wordpressA WordPress block-theme theme.json.
@pantoken/vanillaA Vanilla Forums variables.json.
@pantoken/drupalDrupal theme assets.
@pantoken/hugo, @pantoken/jekyllHugo and Jekyll site data.
@pantoken/emailInline-friendly values for HTML email.

Design ​

  • @pantoken/ai يثبت AGENTS.md, llms.txt, و قواعد المساعد/المحرر (Cursor, Copilot, Windsurf, Claude Code) في مستودع المستهلك.
PackageOutput
@pantoken/figmaA Figma Variables payload.
@pantoken/swatchesColor swatches (ASE, GPL, Sketch) plus a viewable SVG specimen sheet.

Plugins ​

تحويلات اختيارية توسع ناتج الرموز أو CSS. انظر الإضافات.

PackageWhat it adds
@pantoken/plugin-stackingNamed z-index depths as --instui-stacking-* tokens.
@pantoken/plugin-visual-debugThe -with-visual-debug layout-debugging outline.
@pantoken/plugin-simple-iconsBrand icons from simple-icons.
@pantoken/plugin-logosInstructure product logos as SVGs, data URIs, and image tokens.
@pantoken/plugin-prune-custom-propsA PostCSS plugin that drops unused custom properties.

Tools ​

بنية البناء والوثائق والعروض التوضيحية للمونوربو نفسه. معظمها داخلي، لكن الأجزاء مستقلة، لذا نوثقها هنا وبعضها يُنشر على npm بمفردها.

PackageWhat it does
@pantoken/aggregateGenerates the unified pantoken package barrel and exports from its dependencies.
@pantoken/validate-generatedThe drift gate: checks every generated stylesheet resolves against the token IR.
@pantoken/demoThe self-hosted live-demo runner: resolves a @demo spec to an iframe and renders bare HTML/CSS/JS same-origin, token-themed.
@cssdoc/core (external)A generic CSS documentation extractor (TSDoc, for CSS): parses doc-comments + the CSS AST into a model the docs emit as the CSS API reference. Lives in its own repo; consumed via a link dependency.

@pantoken/validate-generated هو سكربت يُشغَّل مرة واحدة (يتم استدعاؤه بواسطة pnpm run ready)، لذا ليس لديه صفحة API ؛ أما الباقي فلديهم.)

AI ​

@pantoken/ai — أصول الوكلاء الموجهة للمستهلك للمشاريع التي تستخدم pantoken (ليس لتطوير pantoken نفسه).

  • @pantoken/ai يقوم بتثبيت AGENTS.md, llms.txt، و assistant/editor rules (Cursor, Copilot, Windsurf, Claude Code)) في مستودع المستهلك.

Dev plugins ​

الإضافات التي نؤلفها للأدوات التي نبني بها، مجمعة حسب المضيف. هي مستقلة وقابلة للنشر.

PackagePlugs into
@pantoken/typedoc-plugin-demoTypeDoc: turns a @demo <provider>:<ref> block tag into an embeddable demo fence.
@pantoken/vite-workspace-orchestratorVite: rebuilds upstream workspace packages (and dependents) when their source changes.