Skip to content

AI-native design editor. Open-source Figma alternative.

2.8 KB
Raw Blame

title: JSX Renderer description: Create editable designs using the same declarative authoring library as OpenPencil agents.

JSX Renderer

OpenPencil's design JSX creates scene nodes, not browser DOM. You can use readable component trees, JavaScript expressions, and reusable functions to construct editable designs.

Creating Designs

The render tool accepts JSX strings in AI chat and MCP. In application or headless library code, import Frame, Text, and other authoring exports from @open-pencil/design-jsx, then create nodes with renderTree or renderJSX from @open-pencil/core/design-jsx, which add icons, SVG conversion, and layout. To write the trees as TSX, set "jsxImportSource": "@open-pencil/design-jsx" with "jsx": "react-jsx" in tsconfig.json, or add a /** @jsxImportSource @open-pencil/design-jsx */ comment to the file. The scripting environment determines which APIs are exposed to eval; package exports are not automatically globals there.

The shared design-authoring reference contains executable examples, layout guidance, and the supported syntax inventory. It is generated from the same source used by chat, ACP, codegen prompts, and the installable agent skill.

Elements

Use frames and text for composition, shape nodes for artwork, and real components and instances for reusable editor content. A JavaScript function alone does not create component identity. See the element inventory.

Style Props

Use Hug/Fill and flex or grid for content-driven sizing. Bind semantic variables instead of copying values. See composition and layout, paint and text, and variables and components.

Exporting to JSX

openpencil export design.fig -f jsx                   # OpenPencil format
openpencil export design.fig -f jsx --style tailwind  # Tailwind classes

Exported OpenPencil JSX can be edited and rendered back into the document. The export writes hidden and locked layers, constraints, size limits, stacked, gradient, and image fills, strokes, effects, masks, and variable bindings, so rendering an export reproduces them and diff_jsx shows changes to any of them. Rich text with mixed styles, vector paths, layout grids, shared styles, and component property definitions are not written yet. Instances are written as frames with their content, so exported JSX stands on its own. See CLI exports.

Visual Diffing

JSX makes structural design changes reviewable as code. Use get_jsx and diff_jsx to inspect changes, then verify the actual rendered result; a clean structural diff does not prove visual equivalence.