4B Pen design authoring
This reference describes scene creation, not React DOM output. Use the render tool for JSX strings, or import Frame, Text, and other authoring exports from @open-pencil/design-jsx and render them with renderTree from @open-pencil/core/design-jsx in library code. Library exports are not automatically globals in agent eval; use only the bindings exposed by that execution environment.
Composition and layout
flex="row"/flex="col"enables auto-layout. Use it for content; reserve explicitx/yorposition="absolute"for intentional overlays and artwork. Without layout, children share the origin unless positioned.w/haccept pixels,"hug"(content-sized), or"fill"(available space in a supported layout parent). Use Hug for notes, cards, and long pages instead of guessing heights. Fixed viewport sizes and artwork geometry are intentional exceptions.gapcontrols spacing.p,px,py, andpt/pr/pb/plcontrol padding; longhands override shorthands. There is no margin shorthand.justify="start"|"end"|"center"|"between"controls the primary axis;items="start"|"end"|"center"|"stretch"|"baseline"controls the cross axis. Distribution needs available space:betweencannot create extra room in a Hug container.growdistributes available space. Avoid circular Hug/Fill dependencies and redundant fixed widths on growing children. Keep Fill sizing through intermediate containers that should stretch.- For wrapping text in a column, prefer
w="fill"; fixed-width text can usetextAutoResize="height".maxLines/truncateare intentional truncation, not fixes for accidental overflow. wrapandrowGapenable wrapped flex rows.grid,columns, androwsenable grid (for examplecolumns="1fr 200px 1fr"orcolumns="repeat(7, 1fr)"); tracks arefr, pixel lengths,auto,repeat(), andminmax(), which grows like its maximum. Grid children usecolStart,rowStart,colSpan, androwSpan. The current gridgapshorthand takes precedence overcolumnGapandrowGap.flow="auto"|"ltr"|"rtl"controls container flow; textdircontrols writing direction. Preserve these separately.- Outside auto-layout, and for
position="absolute"children,constraints=sets how a layer follows its parent's resizing, with Figma's values in lowercase:"min","center","max","stretch", or"scale".minW,maxW,minH, andmaxHbound a layer's size.visible={false}hides a layer andlockedlocks it. - Use measured node bounds and the existing
arrangetool for independent artboards. Prefer layout constraints to calculating child coordinates; ordinary JavaScript arithmetic is appropriate when real geometry calculations are needed.
Paint, text, and artwork
bg/fill,stroke, and textcoloraccept colors and supported variable references. Set colors explicitly for predictable contrast.fillsaccepts structured paints; gradient helpers includelinearGradient,radialGradient,angularGradient, anddiamondGradient, each taking an array of stops and optional{ opacity, transform }:fills={[linearGradient([['#3b82f6', 0], ['#8b5cf6', 1]])]}. Without atransforma linear gradient runs left to right and the others are centred;transformis Figma'sgradientTransform, mapping the layer's unit square onto gradient space.shader(effects, { opacity, visible, blendMode })fills a layer with a shader from theshaderslibrary: an array of effects such asbg={shader([{ type: 'Aurora', props: { speed: 2 } }])}, or a preset as shaders.com exports it,{ components: [...] }. The canvas shows the shader's first frame, preview plays it, and files and other formats keep that frame as an image.strokedescribes one stroke, refined bystrokeWidth,strokeAlign("inside","center","outside"),strokeDash,strokeCap, andstrokeJoin.strokestakes several, as objects withcolor,weight,align,dash,cap,join, andvisible;strokeWeights=sets per-side widths.dashPatternsets the node's own dash pattern, separate from the per-strokestrokeDash.roundedandroundedTL/roundedTR/roundedBL/roundedBRcontrol corners.strokeWidth,opacity,rotate, andblendModecontrol appearance.overflow="hidden"clips content; do not hide accidental text overflow to make a broken layout appear correct.effectsaccepts structured effects such asdropShadow,innerShadow, andlayerBlur.shadowtakes a CSSbox-shadowlist, such asshadow="0 4 8 #0002, inset 0 1 0 #fff", andblura layer blur radius; both are convenient shorthands. Effect helpers takeradius, as Figma's effects do; when a JSX string is rendered, an option a paint or effect helper does not support is reported as a warning.- Text content belongs inside
Text. Usesize,font,weight,italic,lineHeight,letterSpacing,textAlign,textAlignVertical,textDecoration, andtextCase. Decorations take CSS's names and values:textDecorationStyle(solid,dotted,wavy),textDecorationColor(currentColorfollows the text),textDecorationThicknessandtextUnderlineOffset(pixels orauto), andtextDecorationSkipInk.lineHeight="auto"follows the font, andfills={[]}paints no text. Verify fonts actually load before judging dimensions; do not assume every font is available. Spanstyles some characters of aTextwithText's own prop names:size,font,weight,italic,color,fills,lineHeight,letterSpacing,textDecoration, the decoration details, andtextCase.hreflinks its characters to a URL without changing how they look. Spans nest; the inner one wins.Paragraphwrites one paragraph:list="ordered"orlist="unordered"makes it a list item nested atlevel1–5, andspacing,listSpacing, andindentoverride theText'sparagraphSpacing,listSpacing, andparagraphIndentfor it;hangingListon theTexthangs list markers outside the text box. ATextholds onlyParagraphs or none; without them, a line break in its text still starts a paragraph.Iconuses an Iconify name, size, and color. Prefer icons to emoji when reliable vector output is needed. Image fills belong on appropriate leaf shapes, not containers whose children must remain visible.- Design JSX props are the portable authoring interface. Some CSS-style aliases are supported, but this is not a browser CSS engine; do not assume arbitrary HTML, classes, or styles work.
Variables and components
- Create document variables before referencing them with
designVar('id-or-name').defineVarsgroups references; it does not create variable collections. - COLOR references work in paint props. FLOAT references work in
w,h,gap, padding, corner radii,strokeWidth,opacity, textsize/fontSize,lineHeight, andletterSpacing. GridcolumnGap/rowGapand wrapped flexrowGapalso support FLOAT references; gridgapoverrides both axis-specific gaps. Use numbers or FLOAT references for these scalar props, not CSS unit strings. - References preserve real graph bindings, not just copied values. Set the intended collection mode on the parent before creating scalar-bound content: initial scalar layout resolves that inherited mode. This does not guarantee automatic scalar layout recomputation after a later mode switch. Verify resulting geometry as well as paint when changing modes. Missing or incorrectly typed scalar variables are errors.
bindmaps supported scene-field paths to variable IDs or references when no shorthand exists. Use semantic tokens consistently rather than declaring unused collections.- A JSX string is one expression. Build repeated or computed content with JavaScript inside
{}rather than writing each item out:{days.map((day) => <Text>{day}</Text>)},{Array.from({ length: 35 }, (_, i) => <Frame>…</Frame>)}, and conditionals. For longer logic, call an arrow function in place:{(() => { const weeks = …; return weeks.map(…) })()}; statements outside an expression do not run. - A reusable JavaScript function shares source code, not component identity. Use
Component,ComponentSet, andInstancefor editable main components and linked instances. Instanceresolves an existing component throughof,component, orcomponentId. Component-set children namedvariant=Primary, for example, define variants that can be selected when instantiating the set.ComponentandComponentSetacceptproperties, an array of native property definitions (id,name,type,defaultValue). AnInstancesets text, boolean, and swap properties by name, the way it picks a variant:<Instance of="Note" State="Done" Message="Updated review" Pinned={false} />.propertiestakes the same values keyed by property ID or name, for names that are not JSX identifiers or that design JSX already uses, such asname. Names survive a.figsave, which replaces authored IDs such asmessagewith Figma IDs. Ordinary nodes do not acceptproperties.- Child
propertyRefsconnect fields to stable property IDs, for example[{ propertyId: 'message', field: 'TEXT' }]. Supported fields areTEXT,VISIBLE, andINSTANCE_SWAP; text and swap references require text and instance nodes respectively. References do not depend on layer names. - Instance assignments use the native string values (
'true'/'false'for BOOLEAN properties and component IDs for swaps), and a property set as a prop also takestrue/false, as inPinned={false}. Assignments persist through component synchronization; unknown IDs and invalid values fail rather than silently creating inert overrides. Select variants through component-set variant props, not through instance property assignments. - Reuse existing local or library components before recreating them. Keep meaningful text, visibility, and swap properties exposed rather than hand-editing cloned child nodes.
- Explicit instance
w/hreplace the inherited sizing mode on that axis; omitted dimensions retain the main component's sizing. Authored overrides survive component synchronization. Distinguish those placement constraints from the main component's default size, and verify actual bounds in narrower parents. Do not compensate for a sizing mismatch with guessed heights, clipping, or manually positioned siblings.
Controls
- A main component can behave as a Reka UI control in preview and code. Write it with Reka's names:
Switch.Rootis the component (a component set when its children areComponentvariants), and each Reka part is the slot that draws it, such asSwitch.Thumb,Slider.Track,Slider.Range,Slider.Thumb,Progress.Track,Progress.Indicator,Tabs.List,Collapsible.Trigger, orNumberField.Increment. Parts in different variants share one slot. - The root names the properties that hold its values:
modelValue(openonCollapsible.Root),disabled, and, for text fields,filled, as a variant or boolean property name, or{ property, on, off }when the variant values are not named like On and Off.statesnames the variant property that draws default, hover, pressed, focus, and disabled; a slider, progress bar, or number field takesmin,max,step, anddefaultValue. TextField.Input,Textarea.Input, andNumberField.Inputare the text layers whose text becomes the field's text property.Tabs.Triggergoes inTabs.List;Tabs.Contentpanels may sit directly underTabs.Root, the first showing. A part with children and noflex,display,w, orhof its own stacks them in a column that hugs them.- A group's item component is written on its own (
RadioGroup.Item,ToggleGroup.Item,Accordion.Itemwith itsAccordion.TriggerandAccordion.Content); the group's root then lists items as<RadioGroup.Item of={radioId} />.
<Switch.Root name="Switch" modelValue="State" states="Interaction">
<Component name="State=Off, Interaction=Default" w={44} h={24} rounded={12} bg="#D0D4DA">
<Switch.Thumb x={2} y={2} w={20} h={20} rounded={10} bg="#FFFFFF" />
</Component>
<Component name="State=On, Interaction=Default" w={44} h={24} rounded={12} bg="#3B6CF6">
<Switch.Thumb x={22} y={2} w={20} h={20} rounded={10} bg="#FFFFFF" />
</Component>
</Switch.Root>Verification
Inspect structure and actual rendered output. Node counts and describe diagnostics do not establish visual fidelity. Check wrapping with longer content, narrower containers, component edits, and relevant modes. Resolve overflow and contrast problems at their source. Reuse IDs returned by creation tools rather than repeatedly searching for the same nodes.
The examples below are executed by the authoring-reference tests. Create the named variables before running a variable-bound example.
Content-sized review note
<Frame name="Review note" w={280} h="hug" flex="col" gap={8} p={16} bg="#FFFFFF">
<Text name="Author" size={12} weight="medium" color="#252A31">June Lee</Text>
<Text name="Message" w="fill" size={12} color="#6B7079">Give the date a little more room at the bottom.</Text>
</Frame>Variable-bound spacing and typography
<Frame name="Bound note" w={280} h="hug" flex="col" gap={designVar('Space/small')} p={designVar('Space/medium')} bg="#FFFFFF">
<Text name="Message" w="fill" size={designVar('Type/body')} lineHeight={designVar('Type/body-leading')} letterSpacing={designVar('Type/body-tracking')} color="#252A31">A note that grows with its content.</Text>
</Frame>Rich text with spans and lists
<Frame name="Release notes" w={280} h="hug" flex="col" gap={8} p={16} bg="#FFFFFF">
<Text name="Notes" w="fill" size={12} color="#252A31" paragraphSpacing={4}>
<Paragraph spacing={8}>Version 2 is <Span weight="bold" color="#3B6CF6" textDecoration="underline" textDecorationStyle="wavy" textUnderlineOffset={2}>out now</Span>.</Paragraph>
<Paragraph list="unordered">Faster export</Paragraph>
<Paragraph list="unordered" level={2}>PDF and SVG</Paragraph>
<Paragraph list="ordered">Fewer clicks</Paragraph>
</Text>
</Frame>Supported syntax inventory
Generated from the renderer metadata. This inventory lists accepted names, not arbitrary browser CSS support.
Elements: Frame, Text, Span, Paragraph, Rectangle, Ellipse, Line, Star, Polygon, Vector, Group, Section, Component, ComponentSet, Instance, View, Rect, Icon, Button.Root, Toggle.Root, Switch.Root, Switch.Thumb, Checkbox.Root, Checkbox.Indicator, RadioGroup.Root, RadioGroup.Item, RadioGroup.Indicator, ToggleGroup.Root, ToggleGroup.Item, Slider.Root, Slider.Track, Slider.Range, Slider.Thumb, Progress.Root, Progress.Track, Progress.Indicator, Tabs.Root, Tabs.List, Tabs.Trigger, Tabs.Content, Collapsible.Root, Collapsible.Trigger, Collapsible.Content, Accordion.Root, Accordion.Item, Accordion.Header, Accordion.Trigger, Accordion.Content, NumberField.Root, NumberField.Input, NumberField.Increment, NumberField.Decrement, TextField.Root, TextField.Input, Textarea.Root, Textarea.Input.
Helpers: solid, gradient, linearGradient, radialGradient, angularGradient, diamondGradient, shader, dropShadow, innerShadow, layerBlur, backgroundBlur, foregroundBlur, designVar, defineVars.
Properties: name, key, flex, flow, dir, gap, wrap, rowGap, columnGap, justify, justifyContent, items, align, alignItems, grow, w, h, width, height, minW, maxW, minH, maxH, x, y, top, left, position, constraints, p, padding, px, py, pt, pr, pb, pl, bg, fill, fills, background, backgroundColor, stroke, border, borderColor, strokeWidth, borderWidth, strokeAlign, strokeDash, strokeCap, strokeJoin, dashPattern, strokes, strokeWeights, rounded, borderRadius, roundedTL, roundedTR, roundedBL, roundedBR, cornerRadius, cornerSmoothing, opacity, blendMode, rotate, rotation, overflow, mask, visible, locked, shadow, blur, effects, size, fontSize, font, fontFamily, weight, fontWeight, italic, color, text, characters, content, value, title, textAlign, textAlignHorizontal, textHorizontalAlignment, textAlignVertical, textVerticalAlignment, textAutoResize, lineHeight, letterSpacing, textDecoration, textDecorationStyle, textDecorationColor, textDecorationThickness, textUnderlineOffset, textDecorationSkipInk, textCase, paragraphSpacing, paragraphIndent, hangingList, list, level, spacing, listSpacing, indent, maxLines, truncate, grid, columns, rows, colStart, rowStart, col, row, colSpan, rowSpan, points, pointCount, innerRadius, label, style, bind, component, componentId, properties, propertyRefs, of, modelValue, open, disabled, filled, states, min, max, step, defaultValue.