WDS Documentation Navigator
Prerequisite: @wix/design-system must be installed (npm i @wix/design-system or yarn add @wix/design-system ).
Helper Script
This skill bundles scripts/wds.js — a Node.js helper that auto-discovers @wix/design-system in node_modules (handles monorepos and workspaces) and provides focused lookups. Run it from the user's project directory using the absolute path to the bundled script:
WDS is the absolute path to this skill's scripts/wds.js
WDS="<this-skill-dir>/scripts/wds.js"
node $WDS search <keyword> # Find components by keyword node $WDS component <Name> # Get props + example list node $WDS example <Name> "<ExampleName>" # Get a specific example node $WDS icons <query> # Search for icons
Workflow
Step 1: Find the right component
node $WDS search table node $WDS search form input validation node $WDS search modal dialog popup
Multiple keywords are OR-matched. Returns component names, descriptions, and usage guidance.
Step 2: Get props and available examples
node $WDS component Button
Returns the full props list (types and descriptions) plus a list of all available examples. For large prop files (>200 lines), returns a summary with prop names and types.
Step 3: Get a specific example
node $WDS example Button "Loading state"
Returns the example description and JSX code. Matching is case-insensitive and supports substrings (e.g., "loading" matches "Loading state").
Step 4: Find icons
node $WDS icons Add Edit Delete
Icons are from @wix/wix-ui-icons-common . Each icon has a Small variant (e.g., Add
- AddSmall ).
Fallback: Direct File Access
If the script is unavailable, docs are at node_modules/@wix/design-system/dist/docs/ :
-
components.md — component catalog (~978 lines, grep only)
-
components/{Name}Props.md — props per component
-
components/{Name}Examples.md — examples per component (grep ^### for section list)
-
icons.md — icon catalog (~818 lines, grep only)
Don't read these files fully. Grep for keywords, then read specific sections with offset/limit. See references/file-structure.md for the exact docs file layout and section shapes.
Quick Component Mapping (Design to WDS)
Design Element WDS Component Notes
Rectangle/container <Box>
Layout wrapper
Text button <TextButton>
Secondary actions
Input with label <FormField>
- <Input>
Wrap inputs
Toggle <ToggleSwitch>
On/off settings
Modal <Modal>
- <CustomModalLayout>
Use together
Grid <Layout>
- <Cell>
Responsive
Spacing (px to SP conversion)
When designer specifies pixels, convert to the nearest SP token:
Token Classic Studio
SP1
6px 4px
SP2
12px 8px
SP3
18px 12px
SP4
24px 16px
SP5
30px 20px
SP6
36px 24px
<Box gap="SP2" padding="SP3">
Only use SP tokens for gap , padding , margin — not for width/height.
Imports
import { Button, Card, Image } from "@wix/design-system"; import { Add, Edit, Delete } from "@wix/wix-ui-icons-common";