Documentation
Everything the Inkbridge plugin can do — from scanning your components to generating a pixel-perfect design system in Figma.
Get started in 3 steps
Full setup guide →From zero to a live design system in Figma — one install command, no manual exports.
- 1
Install the npm package
In your project root run
pnpm add -D inkbridgethenpnpm exec inkbridge setup. Setup creates the scanner API endpoint and adds thefigma:devscript to yourpackage.json. - 2
Load the plugin in Figma Desktop
Go to Plugins → Development → Import plugin from manifest and select
node_modules/inkbridge/manifest.jsonfrom your project. Figma remembers it — you only do this once. - 3
Generate your design system
Run
pnpm figma:devto start your dev server, then click Generate Design System Page in the plugin — colour tokens, typography, and every component variant are built on demand.
Getting Started
Install the plugin and connect it to your codebase in minutes.
Getting Started
FreeInstall the npm package, load the plugin in Figma Desktop, and generate your first Design System page in minutes.
Dev Server Connection
FreeConnect the Figma plugin to your local dev server in one click — no manual config required.
Component Scanner
FreeThe plugin triggers an on-demand scan of your components the moment you click 'Generate Design System Page' — no manual step required.
Configuration (inkbridge.config.json)
FreeControl which component paths the scanner searches, which files to exclude, and whether to require Storybook stories.
Component Scanning
Automatically detect and analyse your React components and stories.
React Component Scanning
FreeThe plugin scans your Storybook stories and renders each one as a Figma frame — automatically, without any manual work.
shadcn/ui Support
Freeshadcn/ui components render correctly in Figma — borders, backgrounds, and rounded corners included — with no extra configuration.
Storybook Story Parsing
FreeStories are parsed and used as the source of truth for what the plugin renders in Figma.
CVA Variant Detection
FreeClass Variance Authority components are detected and all variant combinations rendered as a state matrix.
Icon Registry
FreeSVG icons used in your components are scanned, catalogued, and rendered correctly in Figma.
Arbitrary Value Support
FreeAny Tailwind arbitrary value — `w-[320px]`, `top-[calc(50%+2rem)]`, `text-[#ff6b00]` — is parsed and applied exactly in Figma.
Design System
Extract tokens, themes, and styles directly from your Tailwind config.
Color Tokens
FreeAll color tokens from your Tailwind config are extracted and bound as Figma Variables — on every plan.
Typography Tokens
FreeFont sizes, weights, and line heights from your Tailwind config are captured as design tokens.
Spacing Scale
FreeThe full Tailwind spacing scale is embedded so padding, margin, and gap values are pixel-perfect.
Theme Variants (Light / Dark)
FreeBoth colour themes are rendered in Figma — free users get side-by-side columns, Figma paid plan users get native Variable mode switching.
Font Families
FreePer-theme font families — body and heading — are defined as design tokens, bound as Figma Variables, and applied to every text node automatically.
Figma Variables Binding
FreeEvery colour token in your Tailwind config is bound to a native Figma Variable — enabling live theme switching directly inside Figma.
Token Export (DTCG & CSS)
FreeDesign tokens are synced in CSS-first mode by default, with DTCG still available for legacy or interoperability workflows.
Figma Output
Control how components, previews, and states are rendered in Figma.
Figma Layer Naming
FreeEvery Figma frame and layer is named after its story — so designers can navigate the layer panel without guessing what anything is.
Design System Page
FreeAll components and tokens are rendered on a dedicated Figma page — your single source of visual truth.
Component Symbols & Instances
FreeReusable components are generated as native Figma symbols and rendered as instances when story props are compatible.
Responsive Previews
FreeComponents with responsive classes are rendered at sm, md, lg, and xl breakpoints automatically.
State Previews
FreeHover, focus, disabled, and custom states are rendered as a matrix alongside the default.
Absolute Positioning
FreeElements with `absolute` are pulled out of the auto-layout flow and placed as floating layers — just like CSS position: absolute.
Image Rendering
Freenext/image and <img> elements are fetched from your dev server and rendered as native image fills in Figma — no placeholders.
Gradient Rendering
FreeLinear, radial, and 3-stop gradients — including clip-path blob shapes — are converted to native Figma gradient fills with correct direction, stops, opacity, and masking.
Shadows, Blur & Rings
FreeTailwind shadow, blur, and ring utilities are converted to Figma drop shadows, layer blurs, and stroke/shadow effects — pixel-perfect.
Pro Features
Close the loop between design and code — changes flow in both directions.
GitHub PR Integration
ProPush design token changes from Figma directly to your codebase as a GitHub pull request.
Two-Way Component Sync
ProChanges in code are flagged in Figma. Changes in Figma flow back to code as a PR.
Priority Support
ProDirect access to the development team via a private support channel.