mirror of
https://github.com/ZSeven-W/openpencil.git
synced 2026-06-01 03:14:29 +07:00
The world's first open-source AI-native vector design tool and the first to feature concurrent Agent Teams. Design-as-Code. Turn prompts into UI directly on the live canvas. A modern alternative to Pencil.
agentagent-teamaiclaudeclaude-codecodexfimgaflutterhtmlmcpopencodeopenpencilpencilreactreact-nativesvelteuivibecodingvibedesignvue
- Update z-index of the VariablesPanel header from 10 to 20 to enhance visibility and interaction with overlapping elements. |
||
|---|---|---|
| .vscode | ||
| public | ||
| server/api/ai | ||
| src | ||
| .cta.json | ||
| .gitignore | ||
| bun.lock | ||
| CLAUDE.md | ||
| components.json | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| vite.config.ts | ||
OpenPencil
Open-source vector design tool with a Design-as-Code philosophy. An alternative to Pencil.dev.
Features
Canvas
- Infinite canvas with pan (Space+drag / middle mouse / Hand tool) and zoom (scroll wheel)
- Smart alignment guides with edge, center, and distance snapping
- Dimension labels during object manipulation
- Frame labels and boundary visualization
Drawing Tools
- Shapes: Rectangle, Ellipse, Line, Polygon
- Frame: Container with auto-layout support (vertical/horizontal)
- Text: Click-to-place text with full typography controls
- Pen tool: Bezier curve drawing with anchor points, control handles, and path closure
- Icon picker: Search and import icons via Iconify API
- Image import: PNG, JPEG, SVG, WebP, GIF (SVG parsed into editable nodes)
Property Editing
- Position, size, rotation
- Fill: solid color and gradients (linear, radial)
- Stroke: color, width, dash patterns
- Corner radius (unified or per-corner)
- Opacity, visibility, lock, flip (horizontal/vertical)
- Effects: shadow and blur
- Auto-layout: direction, gap, padding, justify-content, align-items
- Variable binding: bind any property to a design variable via variable picker
Design Variables & Tokens
- Variables panel: Floating resizable panel with theme management (Cmd+Shift+V)
- Variable types: Color (picker + hex + opacity), Number, String
- Multi-theme support: Create multiple theme axes (e.g. Theme-1, Theme-2), each with variants (e.g. Default, Dark, High Contrast)
$variablereferences: Bind node properties (fill, stroke, opacity, gap, padding) to variables- CSS sync: Auto-generate CSS custom properties (
:root { --color-1: #fff; }) with per-theme variant blocks - Code generation: React/Tailwind and HTML/CSS output uses
var(--name)for variable-bound properties - Live resolution: Variables resolved on-the-fly for canvas rendering, preserved as
$refsin document
Layer Panel
- Hierarchical tree view with expand/collapse
- Drag-and-drop reordering with drop-into-children support (above/below/inside zones)
- Visibility and lock toggles per layer
- Rename via double-click
- Context menu: delete, duplicate, group, lock, hide
- Selection synced with canvas
Parent-Child System
- Frame/Group containers with nested children
- Parent transforms (move, scale, rotate) propagate to children proportionally
- Circular reference prevention when reparenting
History
- Undo/Redo with batched drag operations (Cmd+Z / Cmd+Shift+Z)
- Up to 300 history states
Clipboard & Grouping
- Copy, cut, paste, duplicate (Cmd+C/X/V/D)
- Group / ungroup selected elements (Cmd+G / Cmd+Shift+G)
File Operations
- Save/open
.penfiles (JSON-based, Git-friendly) - Auto-save with File System Access API
- Export: PNG and SVG with scale options (Cmd+Shift+E)
Code Generation
- React + Tailwind CSS code from designs
- HTML + CSS code from designs
- CSS Variables from design tokens
- View in code panel (Cmd+Shift+C)
AI Assistant
- Built-in AI chat panel (Cmd+J)
- AI-powered design generation from text prompts
- Design block preview with "Apply Design" action
- Streaming responses with thinking state
- Dual provider: Anthropic API or local Claude Code (OAuth)
- Multi-provider settings: Claude Code, Codex CLI
Editor UI
- Dark / light theme toggle (persisted to localStorage)
- Fullscreen mode
- Draggable, snap-to-corner AI chat panel
Keyboard Shortcuts
| Shortcut | Action |
|---|---|
| V | Select tool |
| R | Rectangle |
| O | Ellipse |
| L | Line |
| T | Text |
| F | Frame |
| P | Path (pen tool) |
| H | Hand (pan) |
| Cmd+A | Select all |
| Cmd+Z | Undo |
| Cmd+Shift+Z | Redo |
| Cmd+C/X/V/D | Copy/Cut/Paste/Duplicate |
| Cmd+G | Group |
| Cmd+Shift+G | Ungroup |
| Cmd+S | Save |
| Cmd+Shift+E | Export |
| Cmd+Shift+C | Code panel |
| Cmd+Shift+V | Variables panel |
| Cmd+J | AI chat |
| Cmd+, | Agent settings |
| Delete/Backspace | Delete selected |
| Arrow keys | Nudge (1px, +Shift = 10px) |
| [ / ] | Reorder layers |
| Escape | Deselect / Cancel |
Tech Stack
- Framework: TanStack Start (React 19, SSR, file-based routing)
- Canvas: Fabric.js v7
- State: Zustand v5
- UI: shadcn/ui (Radix + Tailwind primitives)
- Styling: Tailwind CSS v4
- Icons: Lucide React
- Server: Nitro (API routes)
- AI: Anthropic SDK + Claude Agent SDK
- Runtime: Bun
- Build: Vite 7
Getting Started
bun install
bun --bun run dev
Open http://localhost:3000 and click "New Design" to enter the editor.
AI Configuration
The AI assistant works in two modes:
- Anthropic API: Set
ANTHROPIC_API_KEYin.env - Local Claude Code: No config needed — uses Claude Agent SDK with OAuth login as fallback
Scripts
| Command | Description |
|---|---|
bun --bun run dev |
Start dev server on port 3000 |
bun --bun run build |
Production build |
bun --bun run preview |
Preview production build |
bun --bun run test |
Run tests (Vitest) |
npx tsc --noEmit |
Type check |
Project Structure
src/
canvas/ # Fabric.js canvas engine (16 files)
fabric-canvas.tsx Canvas component initialization
canvas-object-factory Creates Fabric objects from PenNodes
canvas-object-sync Syncs object properties Fabric ↔ store
canvas-sync-lock Prevents circular sync loops
canvas-controls Custom rotation controls and cursors
canvas-constants Default colors, zoom limits
use-canvas-events Drawing events, tool management
use-canvas-sync Bidirectional PenDocument ↔ Fabric sync + variable resolution
use-canvas-viewport Zoom, pan, tool cursor switching
use-canvas-selection Selection sync Fabric ↔ store
use-canvas-guides Smart alignment guides
guide-utils Guide calculation and rendering
pen-tool Bezier pen tool with anchors/handles
parent-child-transform Parent transform propagation to children
use-dimension-label Size/position labels during manipulation
use-frame-labels Frame name/boundary rendering
variables/ # Design variables/tokens system
resolve-variables Core $variable resolution for canvas rendering
replace-refs Replace/resolve $refs on rename/delete
components/
editor/ # Editor layout, toolbar, tool buttons, status bar
panels/ # Layer panel, property panel (17 files), AI chat, code panel,
# variables panel, variable row
shared/ # ColorPicker, NumberInput, VariablePicker, ExportDialog, etc.
icons/ # Provider logos (Claude, OpenAI)
ui/ # shadcn/ui primitives (Button, Select, Slider, Switch, etc.)
hooks/ # Keyboard shortcuts
lib/ # Utility functions (cn class merging)
services/
ai/ # AI chat service, prompts, design generation
codegen/ # React+Tailwind, HTML+CSS, and CSS variables generators
stores/ # Zustand stores (canvas, document, history, AI, agent-settings)
types/ # PenDocument/PenNode types, style types, variables, agent settings
utils/ # File operations, export, node clone, SVG parser, syntax highlight
routes/ # TanStack Router pages (/, /editor)
server/
api/ai/ # Nitro API: streaming chat, generation, agent connection, models
Roadmap
- Component system (reusable components with instances & overrides)
- Design variables/tokens with CSS sync
- Boolean operations (union, subtract, intersect)
- Multi-page support
- Collaborative editing