Skip to content

Document migration from @policyengine/design-system to @policyengine/ui-kit/legacy #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
policyengine wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document migration from @policyengine/design-system to @policyengine/ui-kit/legacy #142

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions skills/documentation/policyengine-design-skill/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,29 @@ The theme CSS has three layers:
2. **`@theme inline`** — Bridges `:root` vars to Tailwind utilities (`bg-primary`, `text-foreground`)
3. **`@theme`** — Brand palette (`bg-teal-500`, `text-gray-600`), font sizes, spacing, breakpoints

## Migrating from @policyengine/design-system

**The `@policyengine/design-system` package is deprecated.** All projects should migrate to `@policyengine/ui-kit`.

For projects using the old design-system's component API (not just CSS tokens), use the `/legacy` subpath as a drop-in replacement:

```bash
# Replace
import { Button, Input } from "@policyengine/design-system";

# With
import { Button, Input } from "@policyengine/ui-kit/legacy";
```

The `/legacy` export in ui-kit 0.8.0+ mirrors design-system's API exactly. This is a pure import-path rename — no code changes required beyond the import statements.

**Migration steps:**
1. Update `package.json`: Replace `@policyengine/design-system` with `@policyengine/ui-kit`
2. Find-and-replace all imports: `@policyengine/design-system` → `@policyengine/ui-kit/legacy`
3. No other code changes needed

**Note:** The `/legacy` subpath is transitional. New code should use ui-kit's modern components directly (see `policyengine-ui-kit-consumer-skill`). The legacy path exists to enable gradual migration without breaking existing projects.

## Colors

### Primary — teal
Expand Down