# FigUI3
A lightweight, zero-dependency web components library for building Figma plugin and widget UIs with native look and feel.
[](https://www.npmjs.com/package/@rogieking/figui3)
[](LICENSE)
**[Live Playground & Demos](https://rog.ie/figui3/)**
## Features
- Figma UI3 design system
- Zero dependencies
- ~228 KB JS + ~102 KB CSS minified
- Built with Web Components
- Automatic light/dark theme support
- Accessible with ARIA attributes and keyboard navigation
- Framework agnostic (React, Vue, Svelte, or vanilla JS)
## Accessibility Coverage
FigUI3 components are built to preserve native semantics where possible and add ARIA only where custom elements need extra state or naming.
- Form primitives forward accessible names and state to their native controls, including combo inputs, dropdowns, text, number, slider, checkbox, radio, switch, color, and fill inputs.
- Selection components use standard keyboard patterns: tabs use roving focus and `aria-controls`, segmented controls expose a radio-group pattern with focus following arrow selection, choosers expose listbox/options, and menus support trigger state, item focus, Escape close, and disabled items.
- Dialog, popup, tooltip, and toast surfaces expose names, close affordances, live-region behavior, Escape dismissal, and focus return behavior appropriate to their role.
- Media components render their visual surface inside `fig-preview`; image/video semantics stay on the native media element, upload controls remain keyboard reachable, slotted image overlays stay in light DOM for framework ownership, and generated video controls render below the preview instead of as an overlay.
- Display and pointer components expose useful semantics when interactive or informative: handles, swatches, color tips, layers, spinners, shimmers, and skeletons sync names, busy states, disabled states, keyboard movement, inert states, or hidden states as appropriate.
- Focus styling uses shared `--figma-focus-outline`, `--figma-focus-outline-offset`, and `--figma-focus-outline-radius` tokens so visible focus treatment stays consistent across components.
- Component contracts include Playwright keyboard/focus coverage plus an axe smoke suite for representative form, media, overlay, selection, and loading fixtures.
## Quick Start
Install:
```bash
npm install @rogieking/figui3
```
Import:
```js
import "@rogieking/figui3/fig.css";
import "@rogieking/figui3/fig.js";
```
`fig.js` registers `<fig-layer>` with the other core elements. Add its standalone
stylesheet when you need the layer-list presentation:
```js
import "@rogieking/figui3/fig-layer.css";
```
Opt into editor components like `<fig-select>` and the full Figma-style fill picker when you need them:
```js
import "@rogieking/figui3/fig-editor.css";
import "@rogieking/figui3/fig-editor.js";
```
Opt into experimental Lab components after the core imports:
```js
import "@rogieking/figui3/fig-lab.css";
import "@rogieking/figui3/fig-lab.js";
```
For server-rendered apps, use the SSR-safe registration entry point. Call it
after hydration from a React effect instead of statically importing the
side-effect JavaScript bundles:
```jsx
import { useEffect } from "react";
import { register } from "@rogieking/figui3/register.js";
function RegisterFigUI() {
useEffect(() => {
void register({ editor: true, lab: true });
}, []);
return null;
}
```
Render `<RegisterFigUI />` inside the hydrated root. The direct `fig.js`,
`fig-editor.js`, and `fig-lab.js` imports remain convenient for client-only
apps, but register immediately when evaluated in a browser.
Or use a CDN:
```html
<link rel="stylesheet" href="https://unpkg.com/@rogieking/figui3@latest/dist/fig.css" />
<script type="module" src="https://unpkg.com/@rogieking/figui3@latest/dist/fig.js"></script>
```
Agent skills ship in `.cursor/skills/` (included in the npm package):
- `figui3` — core `fig.js` components
- `fig-editor` — `fig-select` and `fig-fill-picker`
- `fig-lab` — experimental audio, wheel, reorder, canvas, and AI components
- `propkit` — property-row composition; examples are included in `/figui3`
See the generated [bundle registration inventory](BUNDLES.md) for the exact
tags registered by Core, Editor, and Lab.
Minimal example:
```html
<fig-field direction="horizontal">
<label>Color</label>
<fig-input-color value="#FF5733" text="true"></fig-input-color>
</fig-field>
<fig-button variant="primary">Save</fig-button>
```
---
## Components
| Component | Tag | Description |
|---|---|---|
| [Button](#button) | `<fig-button>` | Buttons with variants, toggle, select, upload |
| [Dropdown](#dropdown) | `<fig-dropdown>` | Native select wrapper with Figma styling |
| [Select](#select) | `<fig-select>` | Custom listbox select (requires `fig-editor.js`) |
| [Split Input](#split-input) | `<fig-split-input>` | Text or number input with dropdown suggestions |
| [Checkbox](#checkbox) | `<fig-checkbox>` | Checkbox with indeterminate state |
| [Radio](#radio) | `<fig-radio>` | Radio button |
| [Switch](#switch) | `<fig-switch>` | Toggle switch |
| [Slider](#slider) | `<fig-slider>` | Range, hue, opacity, delta, stepper |
| [Audio](#audio) | `<fig-audio>` | Waveform audio player with shared media controls |
| [Audio Waveform](#audio-waveform) | `<fig-audio-waveform>` | Responsive waveform generated from an audio URL |
| [Input Slider](#input-slider) | `<fig-input-slider>` | Experimental standalone slider primitives |
| [Input Wheel](#input-wheel) | `<fig-input-wheel>` | Standalone SVG tick-and-handle numeric scrubber |
| [Text Input](#text-input) | `<fig-input-text>` | Styled text/textarea input |
| [Number Input](#number-input) | `<fig-input-number>` | Numeric input with units |
| [Input Rotate](#input-rotate) | `<fig-input-rotate>` | Compact X/Y/Z rotation trigger |
| [Input Point](#input-point) | `<fig-input-point>` | Paired X/Y numeric input |
| [File Input](#file-input) | `<fig-input-file>` | File upload with image previews and audio playback waveforms |
| [Angle](#angle) | `<fig-angle>` | Instrument-style angle/rotation dial |
| [Swatch](#swatch) | `<fig-swatch>` | Color/gradient/image swatch |
| [Color Tip](#color-tip) | `<fig-color-tip>` | Compact color tip with picker |
| [Color Input](#color-input) | `<fig-input-color>` | Color picker with hex/alpha |
| [Input Palette](#input-palette) | `<fig-input-palette>` | Editable multi-color palette |
| [Property](#property) | `<fig-property>` | Composable editor property row |
| [Palette Editor](#palette-editor) | `<fig-palette-editor>` | Reusable reorderable palette editor |
| [Gradient Editor](#gradient-editor) | `<fig-gradient-editor>` | Full gradient editor with reorderable stops |
| [Gradient Popup](#gradient-popup) | `<dialog is="fig-popup-gradient">` | Reusable full gradient editor popup |
| [Palette Popup](#palette-popup) | `<dialog is="fig-popup-palette">` | Reusable palette editor popup |
| [Reorder](#reorder) | `<fig-reorder>` | Pointer- and keyboard-reorderable list |
| [Gradient Input](#gradient-input) | `<fig-input-gradient>` | Gradient editor with stops |
| [Fill Input](#fill-input) | `<fig-input-fill>` | Solid, gradient, image, video fill |
| [Fill Picker](#fill-picker) | `<fig-fill-picker>` | Full fill picker dialog |
| [Toolbelt](#toolbelt) | `<fig-toolbelt>` / `<fig-toolbelt-group>` / `<fig-toolbelt-item>` | Groupable selectable toolbar with directional overflow |
| [Tabs](#tabs) | `<fig-tabs>` / `<fig-tab>` | Tabbed navigation |
| [Segmented Control](#segmented-control) | `<fig-segmented-control>` / `<fig-segment>` | Segmented button group |
| [Chooser](#chooser) | `<fig-chooser>` / `<fig-choice>` | Selection list with drag scroll |
| [Field](#field) | `<fig-field>` | Form field wrapper with layout |
| [Group](#group) | `<fig-group>` | Named or collapsible section group |
| [Joystick](#joystick) | `<fig-joystick>` | 2D position input |
| [Origin Grid](#origin-grid) | `<fig-origin-grid>` | Transform-origin grid |
| [Easing Curve](#easing-curve) | `<fig-easing-curve>` | Bezier/spring curve editor |
| [Easing Popup](#easing-popup) | `<dialog is="fig-popup-easing">` | Reusable easing editor popup |
| [3D Rotate](#3d-rotate) | `<fig-3d-rotate>` | 3D cube rotation control |
| [Handle](#handle) | `<fig-handle>` | Draggable handle on a surface |
| [Canvas Control](#canvas-control) | `<fig-canvas-control>` | Point with optional radius, angle, or second point |
| [Dialog](#dialog) | `<fig-dialog>` | Modal/non-modal dialog |
| [Popup](#popup) | `<fig-popup>` | Anchored floating surface |
| [Toast](#toast) | `<fig-toast>` | Toast notification |
| [Tooltip](#tooltip) | `<fig-tooltip>` | Hover/click tooltip |
| [Separator](#separator) | `<fig-separator>` / `<fig-menu-separator>` | Visual divider with an optional label |
| [Menu](#menu) | `<fig-menu>` | Triggered menu with keyboard navigation |
| [Header](#header) | `<fig-header>` | Section header |
| [Layer](#layer) | `<fig-layer>` | Core-registered collapsible layer list item; styled by `fig-layer.css` |
| [Preview](#preview) | `<fig-preview>` | Thin visual preview layer |
| [Media](#media) | `<fig-media>` | Shared media host for image/video |
| [Image](#image) | `<fig-image>` | Image display/upload |
| [Card](#card) | `<fig-card>` | Media card with label, link, and selection chrome |
| [Video](#video) | `<fig-video>` | Video display/upload with playback controls |
| [Avatar](#avatar) | `<fig-avatar>` | Profile image or initials |
| [Icon](#icon) | `<fig-icon>` | Masked icon from design tokens |
| [Spinner](#spinner) | `<fig-spinner>` | Loading spinner |
| [Shimmer](#shimmer) | `<fig-shimmer>` | Shimmer loading placeholder |
| [Skeleton](#skeleton) | `<fig-skeleton>` | Skeleton loading placeholder |
---
### Form Controls
#### Button
`<fig-button>` — [demo](https://rog.ie/figui3/#button)
| Attribute | Type | Default | Description |
|---|---|---|---|
| `variant` | string | `"primary"` | `"primary"`, `"secondary"`, `"property"`, `"destructive"`, `"destructiveSecondary"`, `"destructiveGhost"`, `"destructiveLink"`, `"ghost"`, `"link"` |
| `type` | string | `"button"` | `"button"`, `"toggle"`, `"submit"`, `"select"`, `"upload"` |
| `size` | string | — | `"large"`, `"compact"` |
| `selected` | boolean | `false` | Selected state (toggle type) |
| `disabled` | boolean | `false` | Disabled state |
| `icon` | boolean | `false` | Icon-only styling |
| `align` | string | `"center"` | Content alignment: `"start"`, `"center"`, or `"end"` |
| `href` | string | — | URL for link buttons |
| `target` | string | — | Link target (e.g. `"_blank"`) |
```html
<fig-button>Primary</fig-button>
<fig-button variant="secondary">Secondary</fig-button>
<fig-button variant="destructive">Delete</fig-button>
<fig-button variant="destructiveSecondary">Destructive secondary</fig-button>
<fig-button variant="destructiveGhost">Destructive ghost</fig-button>
<fig-button variant="destructiveLink">Destructive link</fig-button>
<fig-button full align="start">Start aligned</fig-button>
<fig-button variant="property">
<fig-icon name="settings" slot="prepend"></fig-icon>
Effects
</fig-button>
<fig-button type="toggle" selected="true">Toggle</fig-button>
<fig-button variant="ghost" icon>
<svg><!-- icon --></svg>
</fig-button>
```
`type="select"` and `type="upload"` are visual wrappers for native select/file controls. They avoid nested native buttons, show the shared focus outline on the wrapper, and open the native picker from keyboard activation where supported.
`variant="property"` shares the secondary visual treatment and adds the full-width, start-aligned property-trigger layout. Author a leading icon with `slot="prepend"`. The consumer owns any corresponding popup or dialog and can use `selected`, `aria-haspopup`, `aria-expanded`, and `aria-controls` on the button.
---
#### Dropdown
`<fig-dropdown>` — [demo](https://rog.ie/figui3/#dropdown)
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | Selected value |
| `type` | string | `"select"` | `"select"` or `"dropdown"` |
| `label` | string | — | Accessible label for the generated native `<select>` |
| `variant` | string | — | `"ghost"` for a borderless control with secondary hover fill |
| `size` | string | — | `"large"` for a 32px-tall control |
| `disabled` | boolean | `false` | Disabled state |
```html
<fig-dropdown value="2" size="large">
<option value="1">Option 1</option>
<option value="2">Option 2</option>
</fig-dropdown>
```
Keyboard activation follows the native select pattern. Enter opens the closed picker.
---
#### Select
`<fig-select>` — [demo](https://rog.ie/figui3/#select)
Custom listbox select with overflow chevrons, grouped options, and sticky separators. Import `fig-editor.js` and `fig-editor.css`. Prefer this over `fig-dropdown` for Figma-style menus.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | Selected option value |
| `label` | string | — | Closed-state / accessible label |
| `options` | string | — | Comma, newline, or JSON options if no authored `fig-select-option` children |
| `menu-anchor` | CSS selector | — | Alternate element to align the open menu against |
| `variant` | string | — | `"primary"` for brand emphasis, `"ghost"` for a borderless control, or `"input"` for input-style fill and interaction states |
| `size` | string | — | `"large"` for a 32px-tall trigger |
| `icon` | boolean | `false` | Render a square chevron-only trigger; provide `aria-label` |
| `subtle` | boolean | `false` | Use the secondary hover/focus fill for every option |
| `full` | boolean | `false` | Stretch to available width |
| `position` | string | — | Omit to overlay the selected option on the trigger; set `bottom left`, `bottom right`, `top left`, `top right`, `bottom center`, or `top center` to place the menu like a popup |
| `disabled` | boolean | `false` | Disabled state |
Author options in `<fig-select-options>`, or pass `options`. Add `subtle` to one `<fig-select-option>` for the secondary hover/focus fill, or to `<fig-select>` to apply it to every option. Use `label` on `<fig-select-option>` when the option content is rich. `fig-separator` with `sticky` pins group labels while scrolling.
```html
<fig-select value="center" label="Align" size="large">
<fig-select-options>
<fig-select-option value="left">Left</fig-select-option>
<fig-select-option value="center">Center</fig-select-option>
<fig-select-option value="right">Right</fig-select-option>
</fig-select-options>
</fig-select>
```
Set `menu-anchor` to a selector, or assign an element to the `menuAnchor` property. The menu matches the anchor width and centers its selected row over the anchor. If the anchor is narrower than the menu’s usable minimum, the wider menu is centered over it in the default overlay mode. Removing the anchor restores trigger-text alignment. An explicit `position` keeps the anchor-derived width while applying normal popup placement and edge alignment relative to the menu anchor.
```js
document.querySelector("fig-select").menuAnchor =
document.querySelector("#menu-anchor");
```
**Events:** `input`, `change`, `optionhover` (`detail` is the hovered option value), `optionfocus` (`detail` is the keyboard-focused option value while the menu is open).
**Methods:** `focus(options)` focuses the trigger. `activate(options)` focuses the trigger and opens the menu; disabled selects remain closed.
---
<a id="combo-input"></a>
#### Split Input
`<fig-split-input>` — [demo](https://rog.ie/figui3/#split-input)
| Attribute | Type | Default | Description |
|---|---|---|---|
| `type` | `text` \| `number` | `text` | Main input control |
| `options` | string | — | Comma-separated suggestion list |
| `placeholder` | string | — | Placeholder text |
| `value` | string | — | Current value |
| `disabled` | boolean | `false` | Disabled state |
| `full` | boolean | `false` | Expand to the available width |
```html
<fig-split-input options="House, Apartment, Condo" placeholder="Residence type"></fig-split-input>
<fig-split-input type="number" options="8, 16, 24, 32" value="16"></fig-split-input>
```
`<fig-combo-input>` remains available as a legacy alias.
The suggestion trigger uses `fig-select` when `fig-editor.js` is registered and falls back to core `fig-dropdown`.
Typed values that exactly match an option select and check it; unmatched values clear the option selection.
---
#### Checkbox
`<fig-checkbox>` — [demo](https://rog.ie/figui3/#checkbox)
| Attribute | Type | Default | Description |
|---|---|---|---|
| `checked` | boolean | `false` | Whether checked |
| `indeterminate` | boolean | `false` | Indeterminate state |
| `disabled` | boolean | `false` | Disabled state |
| `name` | string | — | Form field name |
| `value` | string | — | Value when checked |
| `label` | string | — | Label text (alternative to slotted content) |
```html
<fig-checkbox>Accept terms</fig-checkbox>
<fig-checkbox checked>Selected</fig-checkbox>
<fig-checkbox indeterminate>Parent option</fig-checkbox>
```
---
#### Radio
`<fig-radio>` — [demo](https://rog.ie/figui3/#radio)
| Attribute | Type | Default | Description |
|---|---|---|---|
| `checked` | boolean | `false` | Whether selected |
| `disabled` | boolean | `false` | Disabled state |
| `name` | string | — | Radio group name |
| `value` | string | — | Value when selected |
```html
<fig-radio name="size" value="small">Small</fig-radio>
<fig-radio name="size" value="medium" checked>Medium</fig-radio>
<fig-radio name="size" value="large">Large</fig-radio>
```
---
#### Switch
`<fig-switch>` — [demo](https://rog.ie/figui3/#switch)
| Attribute | Type | Default | Description |
|---|---|---|---|
| `checked` | boolean | `false` | Whether on |
| `disabled` | boolean | `false` | Disabled state |
| `name` | string | — | Form field name |
| `value` | string | — | Value when on |
```html
<fig-switch>Enable notifications</fig-switch>
<fig-switch checked>Active feature</fig-switch>
```
Checkboxes, radios, and switches expose `focus(options)` and `activate()`.
`activate()` uses the native input behavior, including its disabled state and
normal `input` / `change` events.
---
### Inputs
#### Slider
`<fig-slider>` — [demo](https://rog.ie/figui3/#slider)
| Attribute | Type | Default | Description |
|---|---|---|---|
| `type` | string | `"range"` | `"range"`, `"hue"`, `"opacity"`, `"delta"`, `"stepper"` |
| `value` | number | midpoint for `type="range"` | Current value |
| `min` | number | `0` | Minimum |
| `max` | number | `100` | Maximum |
| `step` | number | `1` | Step increment |
| `default` | number | — | Explicit reference value; adds a tick and native snap target when valid |
| `text` | boolean | `true` | Show text input; set `text="false"` to hide |
| `placeholder` | string | `"##"` | Text input placeholder |
| `units` | string | — | Unit label (e.g. `"%"`, `"px"`) |
| `transform` | number | — | Display value multiplier |
| `color` | string | — | Track color (opacity type) |
| `variant` | string | — | Use `"classic"` to opt into the previous slider appearance |
| `precision` | number | — | Decimal places for output |
| `disabled` | boolean | `false` | Disabled state |
**Events:** `input` (continuous), `change` (on release), with detail `{ value, angle, units }`. Event values are rounded to `precision`; the component retains its higher-precision internal value.
```html
<fig-slider min="0" max="100" value="50" default="25" units="%"></fig-slider>
<fig-slider type="hue" value="180" text="false"></fig-slider>
<fig-slider type="opacity" value="75" color="#FF5733" units="%"></fig-slider>
```
For `type="range"`, omitting `value` follows native range behavior and starts at the midpoint of `min` and `max`. An explicitly authored, in-range, step-aligned `default` renders a tick and is passed to the native range input as a snap target; internally inferred defaults do not. Arrow keys move by `step`; hold Shift to move by a larger step.
---
#### Audio
`<fig-audio>`
An audio player that composes `fig-audio-waveform` with the shared `fig-media-controls`. The waveform progress and playback controls stay synchronized with an internal native audio element.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `src` | string | — | Audio URL used for playback and waveform generation |
| `variant` | `bars` \| `ribbon` | `bars` | Forwarded to the generated or authored waveform |
| `autoplay` | boolean | `false` | Start playback automatically when allowed by the browser |
| `controls` | boolean | `false` | Show generated playback controls |
| `muted` | boolean | `false` | Mute audio playback |
| `loop` | boolean | `false` | Restart playback automatically when it ends |
Authored direct `fig-audio-waveform` and `fig-media-controls` children are preserved and synchronized. The `audioEl` property exposes the native audio element; `play()`, `pause()`, and `toggle()` control playback.
```html
<fig-audio src="track.mp3" controls></fig-audio>
<fig-audio src="ambience.wav" variant="ribbon" autoplay muted loop></fig-audio>
```
---
#### Audio Waveform
`<fig-audio-waveform>`
A responsive waveform generated from an audio URL. Included in `fig.js` and `fig.css`.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `url` | string | — | CORS-enabled audio URL to fetch, decode, and render |
| `variant` | `bars` \| `ribbon` | `bars` | Render rounded bars or a smooth mirrored ribbon |
| `progress` | number | `0` | Completed fraction from `0` to `1`; values are clamped |
| `polarization` | number | `1.5` | Waveform contrast factor around half-height (`1` is neutral) |
| `full` | boolean | `false` | Fill the available width |
Set `--fig-audio-waveform-stroke-width` (default `1px`) to control waveform bar thickness and the ribbon's minimum thickness. The responsive waveform targets one sample per 3px. URL fetch or decode failures render a quiet flat waveform fallback.
```html
<fig-audio-waveform
url="https://example.com/audio.wav"
variant="ribbon"
progress="0.42"
></fig-audio-waveform>
```
---
#### Input Slider
`<fig-input-slider>` and variant elements
Experimental standalone slider primitives. Import `fig-input-slider.js` and `fig-input-slider.css` directly, or use the `fig-lab` bundle.
```html
<fig-input-slider value="50" default="50"></fig-input-slider>
<fig-input-slider value="50">
<fig-input-number value="50" units="%"></fig-input-number>
</fig-input-slider>
<fig-input-slider-hue
value="180"
color="#336699"
color-space="oklch">
</fig-input-slider-hue>
<fig-input-slider-opacity color="#0D99FF" value="75"></fig-input-slider-opacity>
<fig-input-slider-delta value="0" default="0"></fig-input-slider-delta>
<fig-input-slider-stepper value="50"></fig-input-slider-stepper>
<fig-input-slider-wheel value="0" step="1"></fig-input-slider-wheel>
```
All variants support `name`, `value`, `default`, `min`, `max`, `step`, `precision`, `ghost`, and `disabled`. Hue and opacity also support `color`. Hue supports `color-space="srgb|srgb-linear|display-p3|oklab|oklch|hsl"`; it defaults to `srgb`, and `oklch`/`hsl` use shorter-hue interpolation. The base slider supports multiple handles with JSON arrays such as `value="[20,80]"`.
An authored direct-child `<fig-input-number>` is preserved and synchronized with a single slider value in both directions. Its own attributes configure its display; slider attributes are not forwarded. The number input is hidden while the slider has multiple values.
Use `occlusion-targets` with a CSS selector list to fade handles beneath matching elements in the slider’s parent scope. Parent matches, siblings, and children are supported. Assign an array of elements to `occlusionTargets` for additional programmatic targets; the getter returns a defensive copy. Attribute, programmatic, and automatic targets are additive. A direct number child is automatic, as is the label of a containing `fig-property[activation="row"]`.
Set `--fig-input-slider-handle-occlusion-target-overlap-opacity` (default `0`) for the fully occluded opacity and `--fig-input-slider-handle-occlusion-target-overlap-fade-threshold` (default `var(--spacer-2)`) for the distance where fading begins.
**Events:** bubbling, composed `input` and `change` with `{ control, name?, value, handleIndex }`. Double-click resets to the default. The wheel variant also provides `spinTo()`, `beginScrub()`, `updateScrub()`, and `endScrub()`.
---
#### Input Wheel
`<fig-input-wheel>`
A standalone interactive SVG tick-and-handle control for scrubbing numeric values. It is experimental and requires `fig-lab.js` and `fig-lab.css`.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | number | `0` | Current numeric value |
| `step` | number | `1` | Scrub increment |
| `spin` | boolean/string | `true` | Keep ticks synchronized to `value`; set `"false"` to leave them stationary |
| `min` | number | — | Inclusive lower bound; omit for no minimum |
| `max` | number | — | Inclusive upper bound; omit for no maximum |
| `disabled` | boolean | `false` | Disable interaction |
The `value`, `min`, `max`, and `step` properties mirror their attributes. `aria-valuetext` is numeric. `spinTo(value)` animates to a new value when `spin` is enabled. `focus()`, `beginScrub()`, `updateScrub()`, and `endScrub()` expose the interaction lifecycle for imperative integrations.
**Events:** numeric `input` while scrubbing and `change` on commit. Both bubble across shadow boundaries.
```html
<fig-input-wheel></fig-input-wheel>
<fig-input-wheel value="50" min="0" max="100"></fig-input-wheel>
<fig-input-wheel value="1.5" step="0.25"></fig-input-wheel>
```
---
#### Input defaults and reset
Property-compatible controls expose the same reset contract: parsed `default` and `defaultValue` aliases, boolean `isDefault`, and `resetToDefault()`. Reset is a no-op while disabled or already at default; otherwise it emits the control’s normal `input` event followed by `change`.
Scalar controls author `default`. Checkbox and switch use `default-checked`. Point and rotate use `default-x`, `default-y`, and `default-z` where applicable. File inputs use `default-url` and `default-filename`; browser-selected local files are cleared but never restored. Without authored defaults, controls use their type fallback: numeric axes `0` (clamped), empty text/file/palette, unchecked boolean, first valid select option, `#D9D9D9` color, and built-in gradient/easing values.
#### Text Input
`<fig-input-text>` — [demo](https://rog.ie/figui3/#text-input)
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | Input value |
| `default` | string | `""` | Default/reset value |
| `placeholder` | string | — | Placeholder text |
| `type` | string | `"text"` | `"text"` or `"number"` |
| `size` | string | — | Set to `"large"` for a 32px-tall input |
| `disabled` | boolean | `false` | Disabled state |
| `multiline` | boolean | `false` | Use textarea |
| `min` | number | — | Min (number type) |
| `max` | number | — | Max (number type) |
| `step` | number | — | Step (number type) |
| `transform` | number | — | Display multiplier |
```html
<fig-input-text value="Hello" placeholder="Enter text..."></fig-input-text>
<fig-input-text size="large" placeholder="Large input"></fig-input-text>
<fig-input-text multiline placeholder="Enter description..."></fig-input-text>
```
---
#### Number Input
`<fig-input-number>` — [demo](https://rog.ie/figui3/#number-input)
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | Numeric value |
| `default` | number | `0` | Default/reset value, clamped to bounds |
| `placeholder` | string | — | Placeholder text |
| `size` | string | — | Set to `"large"` for a 32px-tall input |
| `variant` | string | — | Set to `"ghost"` for a borderless control |
| `min` | number | — | Minimum |
| `max` | number | — | Maximum |
| `step` | number | — | Step increment |
| `units` | string | — | Unit string (e.g. `"px"`, `"%"`) |
| `units-disallow` | string | `"px"` | Comma-separated unit disallow list (e.g. `"px,rem"`) |
| `unit-position` | string | `"suffix"` | `"suffix"` or `"prefix"` |
| `transform` | number | — | Display multiplier |
| `precision` | number | — | Fixed displayed decimal places; omitted values use up to two places |
| `steppers` | boolean | `false` | Show spin buttons |
| `tabular` | boolean | `false` | Tabular numerals (`font-variant-numeric: tabular-nums`) |
| `disabled` | boolean | `false` | Disabled state |
```html
<fig-input-number value="100" units="px"></fig-input-number>
<fig-input-number size="large" value="100" units="px"></fig-input-number>
<fig-input-number variant="ghost" value="100" units="px"></fig-input-number>
<fig-input-number tabular value="100" units="px"></fig-input-number>
<fig-input-number value="50" units="%" min="0" max="100"></fig-input-number>
```
---
#### Input Rotate
`<fig-input-rotate>` — [demo](https://rog.ie/figui3/#input-rotate)
An editor-bundle property button that summarizes X, Y, and Z rotation values with up to one decimal place, matching the popup fields. `variant="simple"` omits the prepend icon and X/Y/Z labels. Clicking it opens an anchored `fig-popup` containing `<fig-3d-rotate fields="rotateX,rotateY,rotateZ" aspect-ratio="4/3">`.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `x` | number | `0` | X-axis rotation |
| `y` | number | `0` | Y-axis rotation |
| `z` | number | `0` | Z-axis rotation |
| `default-x` | number | `0` | Default X-axis rotation |
| `default-y` | number | `0` | Default Y-axis rotation |
| `default-z` | number | `0` | Default Z-axis rotation |
| `units` | string | `"deg"` | Unit suffix; `"deg"` and `"°"` display as `°` |
| `variant` | `"default"` \| `"simple"` | `"default"` | `simple` omits the prepend icon and axis labels |
| `open` | boolean | `false` | Open the rotation popup |
| `full` | boolean | `false` | Fill the parent width |
```html
<fig-input-rotate x="10" y="20" z="30" default-x="0" default-y="0" default-z="0"></fig-input-rotate>
```
Popup edits update `x`, `y`, and `z` and emit `input` and `change` with `{ x, y, z }` in `detail`. `focus(options)` focuses the trigger; `activate(options)` focuses and clicks it to open the popup.
Requires `fig-editor.js` and `fig-editor.css`.
---
#### Input Point
`<fig-input-point>` — [demo](https://rog.ie/figui3/#input-point)
An editor-bundle property button that summarizes X and Y values with up to one decimal place. Clicking it opens an anchored popup containing `<fig-origin-grid fields aspect-ratio="4/3">`. Popup edits reflect to the `x` and `y` attributes and emit numeric `{ x, y }` in `detail`.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `x` | number | `0` | Horizontal coordinate |
| `y` | number | `0` | Vertical coordinate |
| `default-x` | number | `0` | Default horizontal coordinate |
| `default-y` | number | `0` | Default vertical coordinate |
| `units` | string | — | Unit suffix displayed in the trigger |
| `open` | boolean | `false` | Open the point editor popup |
| `disabled` | boolean | `false` | Disable the trigger and popup editing |
| `full` | boolean | `false` | Fill the parent width |
```html
<fig-input-point x="24" y="16" default-x="0" default-y="0" units="%"></fig-input-point>
```
`focus(options)` focuses the trigger; `activate(options)` focuses and clicks it to open the popup.
Requires `fig-editor.js` and `fig-editor.css`.
---
#### File Input
`<fig-input-file>` — [demo](https://rog.ie/figui3/#file-input)
| Attribute | Type | Default | Description |
|---|---|---|---|
| `accepts` | string | — | Native file chooser filter |
| `preview` | `"true"` \| `"false"` \| `"large"` | `false` | Show compact media previews, or use `large` for an upload-enabled `fig-image`/`fig-video` preview |
| `label` | string | generated | Empty-state button label; defaults to `Upload audio`, `Upload image`, or `Upload file` from the known file type |
| `multiple` | boolean | `false` | Allow multiple files |
| `remove` | boolean | `true` | Show the remove button when a file is selected; set to `"false"` to omit it |
| `disabled` | boolean | `false` | Disabled state |
| `variant` | string | `"property"` | Internal button variant |
| `default-url` | string | `""` | External URL restored by `resetToDefault()` |
| `default-filename` | string | `""` | Filename restored by `resetToDefault()` |
`focus(options)` focuses the upload control. `activate(options)` triggers its native file chooser, preview action, or playback button and does nothing when disabled.
Known image and audio files use media-specific icons; unmatched files retain the upload icon. A present or `"true"` `preview` uses the compact image swatch, audio playback preview, or video icon. Audio previews show the audio icon and filename at rest, reveal play and waveform controls on hover or focus, and keep the pause control and waveform visible while playing. `preview="large"` renders known images and videos as upload-enabled `fig-image` or `fig-video` previews; audio and other formats retain their compact preview behavior. `preview="false"` disables previews. Image preview supports `.png`, `.jpg`, `.jpeg`, `.gif`, `.webp`, `.svg`, and `.avif`; audio playback supports `.mp3`, `.wav`, `.aac`, `.m4a`, `.ogg`, and `.flac`; video detection supports common formats including `.mp4`, `.webm`, `.mov`, `.m4v`, `.avi`, `.mkv`, `.ogv`, `.mpeg`, `.mpg`, and `.3gp`.
```html
<fig-input-file accepts="image/*"></fig-input-file>
<fig-input-file accepts="image/*" preview></fig-input-file>
<fig-input-file accepts="video/*" preview="large"></fig-input-file>
<fig-input-file accepts="audio/*"></fig-input-file>
<fig-input-file accepts=".mp3,.opus" label="Choose audio"></fig-input-file>
```
---
#### Angle
`<fig-angle>` — [demo](https://rog.ie/figui3/#angle)
Instrument-style angle/rotation control with an interactive dial, text input, CSS angle units, 15-degree Shift snapping, and unbounded positive/negative winding by default. Degree units display as `°` in the number field. Accepts unit suffixes in text input (`90°`, `90deg`, `3.14rad`, `0.5turn`, `100grad`). Add `min` and/or `max` to clamp the value. Changing `units` preserves the physical angle and converts `value`, `default`, `min`, `max`, and `step` (for example, `90deg` becomes `0.250turn`). When the value differs from `default`, an inset reset button restores the default and emits `input` and `change`.
The rotation arrow starts at `default` (or zero when omitted) and sweeps along the outer dial boundary to the current angle. Positive deltas run clockwise, negative deltas run counterclockwise, and complete turns remain visible. With `rotations`, the number field displays the remainder modulo one turn while a signed `×N` suffix preserves complete rotations. The surface receives the shared focus outline when the dial or number input is focused or dragged. Dial Arrow keys move by `step`, with Shift+Arrow moving by 15°. The internal number input keeps its built-in Up/Down stepping, Shift×10 stepping, and Alt-drag scrubbing. `customElements.get("fig-angle").rotationIcon(angle, size)` returns a standalone zero-origin SVG version for reuse elsewhere; `size` defaults to `48`.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | number | `0` | Angle value |
| `default` | number | `0` | Default/reset value, clamped to bounds |
| `precision` | number | unit-dependent | Decimal places (`0` deg/grad, `2` rad, `3` turn) |
| `dial` | boolean | `true` | Show circular dial |
| `min` | number | — | Minimum (omit for unbounded) |
| `max` | number | — | Maximum (omit for unbounded) |
| `step` | number | unit-dependent | Keyboard and text-input step (`1` deg/°, `0.01` rad, `0.001` turn, `0.1` grad) |
| `units` | string | `"deg"` | `"deg"` / `"°"`, `"rad"`, `"turn"`, `"grad"` |
| `rotations` | boolean | `false` | Show a signed full-rotation counter and modulo the displayed angle |
The `defaultValue` property returns the resolved numeric default in the active unit.
**Events:** `input` (continuous), `change` (on release).
```html
<fig-angle value="90"></fig-angle>
<fig-angle value="180" default="90"></fig-angle>
<fig-angle units="rad" value="3.14159"></fig-angle>
<fig-angle units="turn" value="0.5" default="0.25"></fig-angle>
<fig-angle units="grad" value="100"></fig-angle>
<fig-angle rotations value="1080"></fig-angle>
```
---
### Color & Fill
#### Swatch
`<fig-swatch>` — [demo](https://rog.ie/figui3/#swatch)
A color/gradient/image swatch element with checkerboard background for alpha.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `background` | string | — | CSS background value |
| `size` | string | `"small"` | `"small"` or `"large"` |
| `selected` | boolean | `false` | Selection ring |
| `disabled` | boolean | `false` | Disabled state |
| `alpha` | number | — | Opacity (0-1) |
```html
<fig-swatch background="#FF5733"></fig-swatch>
<fig-swatch background="linear-gradient(90deg, #FF0000, #0000FF)" size="large"></fig-swatch>
```
---
#### Color Tip
`<fig-color-tip>` — [demo](https://rog.ie/figui3/#color-tip)
A compact solid-color swatch. Uses `<fig-fill-picker>` when the optional picker is registered, otherwise falls back to the native color input.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | Color string (hex/rgb/hsl/named) |
| `selected` | boolean | `false` | Selected state |
| `disabled` | boolean | `false` | Disabled state |
| `alpha` | boolean | `false` | Show alpha controls |
| `control` | string | — | `"add"` or `"remove"` for icon-only mode |
**Events:**
| Event | Detail |
|---|---|
| `input` | `{ color, alpha, opacity }` — while editing |
| `change` | `{ color, alpha, opacity }` — on commit |
| `add` | — (when `control="add"` is clicked) |
| `remove` | — (when `control="remove"` is clicked) |
```html
<fig-color-tip value="#FF5733"></fig-color-tip>
<fig-color-tip value="#00AAFF" alpha="true"></fig-color-tip>
```
---
#### Color Input
`<fig-input-color>` — [demo](https://rog.ie/figui3/#color-input)
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | Hex color (e.g. `"#FF5733"` or `"#FF573380"`) |
| `default` | string | `"#D9D9D9"` | Default/reset color |
| `text` | boolean | `false` | Show hex text input |
| `alpha` | boolean | `true` | Show alpha slider; set `alpha="false"` to hide opacity controls |
| `mode` | string | — | Color mode (`"hex"`, `"rgb"`, `"hsl"`) |
| `picker-*` | string | — | Forwarded to `<fig-fill-picker>` when the optional picker is registered |
| `disabled` | boolean | `false` | Disabled state |
**Events:**
| Event | Detail |
|---|---|
| `input` | `{ value, hex, rgba, color, alpha, opacity }` |
| `change` | `{ value, hex, rgba, color, alpha, opacity }` |
`value`, `hex`, and `rgba` retain their legacy values. The additive aliases use opaque `#RRGGBB` for `color`, `0–1` for `alpha`, and `0–100` for `opacity`.
```html
<fig-input-color value="#FF5733" text="true"></fig-input-color>
```
When `fig-editor.js` is imported, swatch activation opens `<fig-fill-picker>`. Without it, the native color input is used.
---
#### Input Palette
`<fig-input-palette>`
An editable palette of solid colors, each rendered as a `<fig-input-color>` swatch with add/remove support.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | JSON array of hex strings or `{color, alpha}` objects |
| `default` | string | `"[]"` | Default/reset palette |
| `disabled` | boolean | `false` | Disabled state |
| `min` | number | `2` | Minimum number of colors |
| `max` | number | `8` | Maximum (add button hidden at max) |
| `open` | boolean | `false` | Expanded rows with text inputs per color |
| `fixed` | boolean | `false` | Lock palette length — no add or remove (`fixed` or `fixed="true"`) |
| `edit` | `"true"` \| `"false"` \| `"picker"` | `"true"` | Inline editor, compact preview, or popup palette editor |
**Events:**
| Event | Detail |
|---|---|
| `input` | Full color array (during editing) |
| `change` | Full color array (on commit or add) |
```html
<fig-input-palette value='["#FF0000","#00FF00","#0000FF"]'></fig-input-palette>
<fig-input-palette edit="false" value='["#FF0000","#00FF00","#0000FF"]'></fig-input-palette>
<fig-input-palette edit="picker" value='[{"color":"#FF0000","alpha":0.5},{"color":"#00FF00","alpha":1}]'></fig-input-palette>
```
The editable palette is a single tab stop. Enter or Space expands inline mode or opens picker mode. `activate(options)` performs the same action after focusing the trigger. `edit="false"` renders only the compact preview. Picker mode requires `fig-editor.js`.
#### Property
`<fig-property>`
An editor-bundle property row. Supply one control in `slot="input"` and optionally author `slot="label"`, `slot="leading"`, or `slot="trailing"` content. Authored label markup takes precedence over the `label` attribute. Set `ratio="label:input"` to change the default `1:2` track split, such as `ratio="1:1"` or `ratio="2:3"`; positive decimals are accepted and invalid values fall back to `1:2`. The reflected `ratio` property supports React assignment. Override `--fig-property-label-ratio`, `--fig-property-input-ratio`, or `--fig-property-label-track` for lower-level CSS control. The `leading="drag|chevron"` and `trailing="remove|add|bind"` attributes generate common accessories; authored slot content takes precedence. Leading and trailing content appears on hover or focus by default. Set `show-leading="false"` or `show-trailing="false"` to hide it, or add an empty `show-leading` or `show-trailing` attribute to always show it. Add `selected` or `selected="true"` for the selected background; `selected="false"` leaves the row unselected. Generated trailing actions emit bubbling, composed events named `remove`, `add`, or `bind` with the slotted control in `detail.input`. Input events bubble directly from the supplied control. `focus(options)` delegates focus to the slotted control, while `activate(options)` delegates to its `activate()` method and falls back to focus when that method is unavailable. Right-clicking the row opens a context menu with “Reset to default”; the action delegates through `resetToDefault()` and is disabled when the slotted control does not implement that method, is disabled, or reports `isDefault === true`. Set `activation="row"` to activate from the label or unused row surface; direct input and accessory clicks keep their native behavior. Focus within the control moves the shared outline to the row and applies the selected background. Row activation ignores `ratio` and content-sizes slotted controls even when they have `full`; color, gradient, palette, and point controls use the standard compact input width.
```html
<fig-property label="Size" ratio="1:1" leading="drag" trailing="remove">
<fig-input-number slot="input" value="16" units="px" full></fig-input-number>
</fig-property>
```
Import `fig-property.js` and `fig-property.css` directly, or use the `fig-editor` bundle, which includes both.
#### Color Utilities
`fig-color.js` is a side-effect-free color math entry point shared by core and editor components.
```js
import {
figHexToOklch,
figOklchToHex,
figOklabDistance,
figMapOklchToGamut,
} from "@rogieking/figui3/fig-color.js";
```
RGB channels use `0–255`; HSL/HSV saturation, lightness, and value use `0–100`; OKLab/OKLCH lightness uses `0–1`, chroma is unbounded, and hue uses normalized degrees. Achromatic colors return hue `0`. `figHexToRGB()` returns alpha and `figRGBToHex()` accepts optional alpha; color-space conversion otherwise leaves alpha to the caller. Converters support `colorSpace: "srgb" | "display-p3"`, and `figMapOklchToGamut()` reduces chroma while preserving lightness and hue.
#### Palette Editor
`<fig-palette-editor>`
A reusable editor-bundle component for ordered color arrays. It uses `<fig-reorder>` for pointer and keyboard reordering and emits normalized color arrays from `input` and `change`. New colors are selected deterministically in OKLCH to remain perceptually distinct while matching the palette’s lightness and chroma. It supports `value`, `min`, `max`, `fixed`, `disabled`, `overflow="fade|visible"`, and `show-rows`; omit `max` for an unlimited number of colors. Overflow defaults to a bounded list showing 6.5 rows with vertical fades. Set `show-rows` to change that height or use `overflow="visible"` to show every row. `show-rows` maps to `--fig-palette-editor-overflow-show-rows`.
```html
<fig-palette-editor value='["#94BD00","#83AD00","#1A632A","#003905"]'></fig-palette-editor>
```
#### Gradient Editor
`<fig-gradient-editor>`
A reusable editor-bundle component for gradient type, direction, stop handles,
and reorderable stop rows. It supports `value`, `color-space`, `disabled`,
`overflow="fade|visible"`, and `show-rows`. Stops default to a bounded list
showing 6.5 rows with vertical fades; `show-rows` maps to
`--fig-gradient-editor-overflow-show-rows`, and `overflow="visible"` shows every
stop. Stop row and bar-handle selection stay synchronized and scroll the
selected row into view. The first stop is selected initially. Selecting another
row makes Add Stop insert midway between it and the following stop; the new stop
is selected and focused. Its `value` property is the normalized gradient config.
Bubbling `input` and `change` events include `{ type, gradient, css }`.
```html
<fig-gradient-editor
value='{"type":"linear","angle":90,"stops":[{"position":0,"color":"#0D99FF","opacity":100},{"position":100,"color":"#9747FF","opacity":100}]}'
></fig-gradient-editor>
```
`fig-fill-picker` uses this component for its Gradient tab.
#### Gradient Popup
`<dialog is="fig-popup-gradient">`
A reusable `fig-popup` subclass that owns a `<fig-gradient-editor>`. It
supports `value`, `color-space`, `disabled`, `overflow`, and `show-rows`, plus
inherited popup positioning. Its bubbling `input` and `change` events include
`{ type, gradient, css }`.
```html
<fig-button id="gradient-trigger">Edit gradient</fig-button>
<dialog
is="fig-popup-gradient"
anchor="#gradient-trigger"
value='{"type":"linear","angle":90,"stops":[{"position":0,"color":"#0D99FF","opacity":100},{"position":100,"color":"#9747FF","opacity":100}]}'
open
></dialog>
```
#### Palette Popup
`<dialog is="fig-popup-palette">`
A reusable `fig-popup` subclass that owns a `<fig-palette-editor>`. It supports
`value`, `min`, `max`, `fixed`, and `disabled`, plus the standard popup
positioning attributes. Its `value` property and bubbling `input` / `change`
events use normalized `{ color, alpha }[]` values.
```html
<fig-button id="palette-trigger">Edit palette</fig-button>
<dialog
is="fig-popup-palette"
anchor="#palette-trigger"
value='["#94BD00","#83AD00","#1A632A","#003905"]'
open
></dialog>
```
#### Reorder
`<fig-reorder>`
An editor-bundle wrapper for reordering direct children with pointer or keyboard controls. Use `handle` for rows containing interactive controls, and `items` to limit which direct children participate.
```html
<fig-reorder axis="vertical" handle=".drag-handle">
<div><button class="drag-handle" aria-label="Reorder">Move</button>First</div>
<div><button class="drag-handle" aria-label="Reorder">Move</button>Second</div>
</fig-reorder>
```
Attributes: `axis`, `handle`, `items`, `indicator`, and `disabled`. The bubbling `reorder` event includes `{ oldIndex, newIndex, item }`.
---
#### Gradient Input
`<fig-input-gradient>`
A gradient editor with draggable stops. With `edit="picker"` and the editor bundle registered, it opens the reusable `dialog[is="fig-popup-gradient"]`; otherwise it renders the gradient swatch without opening a picker. `activate(options)` opens picker mode like a click and focuses inline mode.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | JSON gradient fill data |
| `edit` | boolean/string | `true` | `true`, `false`, or `"picker"` |
| `mode` | string | `"handle"` | `"handle"` renders color stop handles without tips; `"tip"` renders persistent color tips |
| `disabled` | boolean | `false` | Disabled state |
| `picker-*` | string | — | Passthrough picker attributes |
Supported interpolation spaces: `srgb`, `srgb-linear`, `display-p3`, `oklab`, `oklch` (with `hueInterpolation`: `shorter`, `longer`, `increasing`, `decreasing`).
**Events:**
| Event | Detail |
|---|---|
| `input` | `{ type, gradient }` |
| `change` | `{ type, gradient }` |
```html
<fig-input-gradient
value='{"type":"gradient","gradient":{"type":"linear","angle":90,"interpolationSpace":"oklab","stops":[{"position":0,"color":"#FF0000","opacity":100},{"position":100,"color":"#0000FF","opacity":100}]}}'
></fig-input-gradient>
```
---
#### Fill Input
`<fig-input-fill>` — [demo](https://rog.ie/figui3/#fill-input)
A comprehensive fill input supporting solid, gradient, image, video, and webcam fills. Without the optional picker, it renders a passive preview.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | JSON fill data |
| `disabled` | boolean | `false` | Disabled state |
| `mode` | string | — | Lock to a fill mode |
| `alpha` | boolean | `true` | Show alpha controls |
| `webcam-mode` | string | `live` | Forwarded to the picker: `live` or `snapshot` |
| `default-video` | string | — | Forwarded sample clip URL when Video has no file |
| `picker-*` | string | — | Forwarded to `<fig-fill-picker>` when the optional picker is registered |
Add `aria-label` to name the generated picker, hex field, and opacity field as one fill control group.
Solid `alpha` is 0–1 (canonical). `opacity` 0–100 is also emitted for compatibility. Gradient values include `css`. Webcam JSON is `{ type, webcam }` — never a live `MediaStream`. Read `webcamStream` or listen for `webcamstream`. Video swatches use `video.poster`, not the mp4 URL.
**Events:**
| Event | Detail |
|---|---|
| `input` | `{ type, color?, gradient?, image?, video?, webcam?, css }` |
| `change` | `{ type, color?, gradient?, image?, video?, webcam?, css }` |
| `webcamstream` | `{ stream, deviceId }` |
```html
<fig-input-fill value='{"type":"solid","color":"#FF5733","opacity":100}'></fig-input-fill>
```
---
#### Fill Picker
`<fig-fill-picker>` — [demo](https://rog.ie/figui3/#fill-picker)
Optional full fill picker dialog supporting solid, gradient, image, video, and webcam. Import `fig-editor.js` and `fig-editor.css` to register and style it.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | JSON fill value |
| `disabled` | boolean | `false` | Disabled state |
| `alpha` | boolean | `true` | Show alpha controls |
| `mode` | string | — | Lock to mode: `"solid"`, `"gradient"`, `"image"`, `"video"`, `"webcam"` |
| `webcam-mode` | string | `live` | `live` keeps the camera after close; Capture always writes an image still |
| `default-video` | string | — | Sample clip URL when Video is selected with no file |
Webcam JSON is `{ type: "webcam", webcam: { live, snapshot, deviceId, scaleMode, scale, opacity } }`. The live `MediaStream` is `webcamStream` / `webcamstream`, not `value`. Closing the dialog does not stop a live camera; call `releaseWebcam()` or disconnect the element. Capture in `live` mode only updates `webcam.snapshot`. Video JSON includes `poster`; the swatch paints that, never `url(file.mp4)`.
**Events:**
| Event | Detail |
|---|---|
| `input` | `{ type, gradient?, color?, image?, video?, webcam?, css }` |
| `change` | `{ type, gradient?, color?, image?, video?, webcam?, css }` |
| `webcamstream` | `{ stream, deviceId }` |
```html
<fig-fill-picker value='{"type":"solid","color":"#FF5733"}'>
<fig-swatch></fig-swatch>
</fig-fill-picker>
```
---
### Selection
#### Toolbelt
`<fig-toolbelt>` / `<fig-toolbelt-group>` / `<fig-toolbelt-item>`
A selectable horizontal or vertical toolbar that keeps authored items in the light DOM. Its internal `part="viewport"` owns scrolling and overflow fades, while generated paging buttons remain outside the masked viewport.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | Selected item value |
| `disabled` | boolean | `false` | Disable all items |
| `layout` | `horizontal` \| `vertical` | `horizontal` | Item and keyboard-navigation direction |
| `overflow` | `buttons` \| `scrollbar` | `scrollbar` | Generated paging buttons or buttonless scrolling; scrollbars remain hidden |
Wrap related items in `fig-toolbelt-group`; adjacent groups receive a direction-aware separator. Add `aria-label` to groups when the grouping has a meaningful name. Items support `value`, `selected`, and `disabled`. `input` and `change` bubble from the toolbelt with the selected value. ArrowLeft/ArrowRight navigate horizontal toolbelts; ArrowUp/ArrowDown navigate vertical toolbelts. Home and End move to the edges; Enter or Space selects the focused item.
Place an item, group, or custom element in `slot="prepend"` or `slot="append"` to keep it fixed outside the scrolling and faded viewport. Slotted toolbelt items remain part of selection and keyboard navigation.
Use `--fig-toolbelt-gap`, `--fig-toolbelt-group-gap`, `--fig-toolbelt-group-separator-color`, `--fig-toolbelt-overflow-fade-size`, `--fig-toolbelt-padding-block`, `--fig-toolbelt-padding-inline`, `--fig-toolbelt-item-height`, and `--fig-toolbelt-item-padding` to customize layout. The toolbelt fade defaults to `calc(var(--spacer-6) + var(--spacer-2))`.
```html
<fig-toolbelt layout="horizontal" overflow="buttons" value="move" aria-label="Design tools">
<fig-toolbelt-item slot="prepend" value="move" selected>Move</fig-toolbelt-item>
<fig-toolbelt-group aria-label="Transform tools">
<fig-toolbelt-item value="frame">Frame</fig-toolbelt-item>
</fig-toolbelt-group>
<fig-toolbelt-group aria-label="Shape tools">
<fig-toolbelt-item value="shape">Shape</fig-toolbelt-item>
</fig-toolbelt-group>
<fig-toolbelt-item slot="append" value="settings">Settings</fig-toolbelt-item>
</fig-toolbelt>
```
---
#### Tabs
`<fig-tabs>` / `<fig-tab>` — [demo](https://rog.ie/figui3/#tabs)
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | Selected tab value |
| `name` | string | — | Tabs group identifier |
| `disabled` | boolean | `false` | Disable all tabs |
| `overflow` | string | `"buttons"` | `"buttons"` adds paging controls; `"fade"` uses horizontal edge fades without buttons |
**Events:** `input`, `change` with selected tab value.
Tabs use `role="tablist"` / `role="tab"` and roving focus. Use `content="#panel-id"` on each `<fig-tab>` to associate generated tab panels. Focus-visible tabs use the shared focus outline tokens.
Overflow buttons are enabled by default. Set `overflow="fade"` for buttonless scrolling with `fig-overflow-fade fig-overflow-fade-horizontal` applied to the tabs container.
```html
<fig-tabs value="tab1">
<fig-tab value="tab1">General</fig-tab>
<fig-tab value="tab2">Advanced</fig-tab>
</fig-tabs>
<fig-tabs value="tab1" overflow="fade">
<fig-tab value="tab1">General</fig-tab>
<fig-tab value="tab2">Advanced</fig-tab>
</fig-tabs>
```
---
#### Segmented Control
`<fig-segmented-control>` / `<fig-segment>` — [demo](https://rog.ie/figui3/#segmented-control)
| Attribute | Type | Default | Description |
|---|---|---|---|
| `name` | string | — | Group identifier |
| `value` | string | — | Selected segment value |
| `animated` | boolean | `false` | Animate indicator transitions |
| `sizing` | string | `"equal"` | `"equal"` or `"auto"` width mode |
| `size` | string | — | Set to `"large"` for a 32px-tall control |
**Events:** `input`, `change` — detail contains the selected value.
Segmented controls expose a radio-group pattern. Arrow keys, Home, and End move selection between enabled segments and move focus to the selected segment.
```html
<fig-segmented-control>
<fig-segment value="left" selected="true">Left</fig-segment>
<fig-segment value="center">Center</fig-segment>
<fig-segment value="right">Right</fig-segment>
</fig-segmented-control>
```
---
#### Chooser
`<fig-chooser>` / `<fig-choice>`
A selection list controller. `<fig-choice>` elements are selectable options within a `<fig-chooser>`.
When app code rebuilds a chooser by setting `fig-chooser.innerHTML`, the chooser restores its overflow buttons automatically. Choices remain direct light-DOM children (React-safe).
**fig-chooser attributes:**
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | Selected choice value. Omit to select the first choice; `value=""` means none. |
| `choice-element` | string | `"fig-choice"` | CSS selector for child choices |
| `layout` | string | `"vertical"` | `"vertical"`, `"horizontal"`, `"grid"` |
| `columns` | number | `2` | Grid column count when `layout="grid"` |
| `disabled` | boolean | `false` | Disabled state |
| `drag` | boolean | `false` | Enable drag-to-scroll |
| `overflow` | string | — | Overflow behavior |
| `loop` | boolean | `false` | Loop keyboard navigation |
| `auto-scroll` | boolean | `true` | Automatically center the selection after selection, layout, resize, or media changes. Set to `"false"` to disable. |
| `scroll-behavior` | string | `"smooth"` | Selection and overflow-button scrolling behavior: `"smooth"` or `"auto"`. The CSS `scroll-behavior` property can also override it. |
**fig-choice attributes:**
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | Choice identifier |
| `selected` | boolean | `false` | Selected state; reflected to direct element children |
| `disabled` | boolean | `false` | Disabled state |
**Events (on fig-chooser):** `input`, `change` — detail is the selected value string.
Selection follows the native `<select>` pattern: set `chooser.value` with a choice value, or set `chooser.selectedChoice` with a choice element. Neither programmatic selection nor scrolling emits events.
When `auto-scroll="false"`, reveal the current selection explicitly with `chooser.scrollSelectionIntoView(options?)`. It accepts native-style `ScrollIntoViewOptions` (`behavior`, `block`, and `inline`) and centers by default.
```html
<fig-chooser value="opt1">
<fig-choice value="opt1">Option 1</fig-choice>
<fig-choice value="opt2">Option 2</fig-choice>
<fig-choice value="opt3">Option 3</fig-choice>
</fig-chooser>
```
---
### Spatial Controls
#### Joystick
`<fig-joystick>`
A 2D position input control with optional X/Y fields.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | `"50% 50%"` | Position as percentages |
| `precision` | number | — | Decimal places |
| `transform` | number | — | Output scaling |
| `fields` | boolean | `false` | Show X/Y inputs |
| `coordinates` | string | `"screen"` | `"screen"` (0,0 top-left) or `"math"` (0,0 bottom-left) |
| `aspect-ratio` | string | `"1 / 1"` | Plane ratio |
| `axis-labels` | string | — | Comma- or space-delimited labels. 1 value: top. 2 values: x y. 4 values: left right top bottom |
**Events:**
| Event | Detail |
|---|---|
| `input` | `{ x, y, value }` — while dragging |
| `change` | `{ x, y, value }` — on release |
```html
<fig-joystick value="50% 50%" fields="true" precision="2"></fig-joystick>
```
Keyboard focus lands on the internal handle. Arrow keys move the handle and keep focus on it during interaction.
---
#### Origin Grid
`<fig-origin-grid>`
A transform-origin grid control with a draggable handle and optional X/Y percentage fields.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | `"50% 50%"` | CSS transform-origin pair |
| `precision` | number | `0` | Decimal places |
| `aspect-ratio` | string | — | Grid aspect ratio |
| `drag` | boolean | `true` | Enable handle dragging |
| `fields` | boolean | `false` | Show X/Y fields |
**Events:**
| Event | Detail |
|---|---|
| `input` | `{ value, x, y }` — while dragging |
| `change` | `{ value, x, y }` — on release |
```html
<fig-origin-grid value="50% 50%" drag="true" fields="true"></fig-origin-grid>
```
The internal handle uses the shared focus outline and supports Arrow, Shift+Arrow, Home, and End keyboard movement.
---
#### Easing Curve
`<fig-easing-curve>`
An interactive bezier or spring easing curve editor with a preset dropdown and manual value input. `activate(options)` opens the compact easing popup when `edit="false"` or activates the preset control in editable mode.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | Bezier/spring shorthand or a serialized easing object |
| `mode` | string | — | Optional `"bezier"` or `"spring"` constraint; filters presets and rejects the other value type |
| `precision` | number | `2` | Decimal places |
| `aspect-ratio` | string | — | Editor aspect ratio |
| `edit` | boolean | `true` | Show the inline editor; `"false"` uses the compact preset control and opens `fig-popup-easing` when `fig-editor.js` is loaded |
| `presets` | boolean | `true` | Show the preset selector; set to `"false"` to hide it |
| `text` | boolean | `true` | Show the bezier value or normalized spring bounce input; set to `"false"` to hide it |
The `value` property also accepts a structured object. Structured values require a `type` unless the `mode` attribute supplies it. If both are present, they must agree.
```js
curve.value = {
type: "spring",
mass: 1,
stiffness: 200,
damping: 12,
initialVelocity: 0,
};
curve.spring; // A cloned { mass, stiffness, damping, initialVelocity } object
curve.value; // "spring(200, 12, 1)"
```
The same data can be supplied declaratively. With `mode="spring"`, `type` is optional:
```html
<fig-easing-curve
mode="spring"
value='{"mass":1,"stiffness":200,"damping":12,"initialVelocity":0}'
></fig-easing-curve>
```
Bezier objects use `{ type: "bezier", x1, y1, x2, y2 }`. Spring shorthand accepts an optional fourth initial-velocity value: `spring(stiffness, damping, mass, initialVelocity)`.
In spring mode, the compact number input edits normalized bounce from `0` (critically damped) to `1` (undamped). Bounce is converted to the equivalent damping value in the structured spring configuration.
**Static:** `FigEasingCurve.PRESETS` — built-in preset array. `FigEasingCurve.curveIcon(value)` — SVG icon helper.
**Events:**
| Event | Detail |
|---|---|
| `input` | `{ mode, value, cssValue, preset, spring? }` — while dragging |
| `change` | `{ mode, value, cssValue, preset, spring? }` — on release |
```html
<fig-easing-curve value="0.42, 0, 0.58, 1"></fig-easing-curve>
<fig-easing-curve value="spring(200, 15, 1)" edit="false"></fig-easing-curve>
<fig-easing-curve value="0.42, 0, 0.58, 1" presets="false" text="false"></fig-easing-curve>
```
Editable bezier and spring handles are keyboard operable. Bezier handles keep tab order aligned with the visual handle order.
#### Easing Popup
`<dialog is="fig-popup-easing">`
A reusable `fig-popup` subclass containing a
`<fig-easing-curve aspect-ratio="4/3">`. Easing attributes and events are
forwarded through the popup.
```html
<fig-button id="easing-trigger">Edit easing</fig-button>
<dialog
is="fig-popup-easing"
anchor="#easing-trigger"
value="0.42, 0, 0.58, 1"
open
></dialog>
```
---
#### 3D Rotate
`<fig-3d-rotate>`
An interactive 3D cube for setting rotation values. Supports drag interaction and optional X/Y/Z number fields.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | CSS transform, e.g. `"rotateX(20deg) rotateY(-35deg) rotateZ(0deg)"` |
| `precision` | number | `1` | Decimal places |
| `aspect-ratio` | string | — | Cube container ratio |
| `fields` | boolean | `false` | Show X/Y/Z number inputs |
| `perspective` | string | — | CSS perspective value |
| `perspective-origin` | string | — | CSS perspective-origin |
| `transform-origin` | string | — | CSS transform-origin |
| `selected` | string | — | Highlighted face |
| `drag` | boolean | `true` | Enable drag rotation |
**Events:**
| Event | Detail |
|---|---|
| `input` | `{ value, rotateX, rotateY, rotateZ }` — while dragging |
| `change` | `{ value, rotateX, rotateY, rotateZ }` — on release |
```html
<fig-3d-rotate value="rotateX(20deg) rotateY(-35deg) rotateZ(0deg)" fields="true"></fig-3d-rotate>
```
---
#### Handle
`<fig-handle>`
A draggable handle element. Positioned on a `drag-surface` container with axis constraints and snapping. Used internally by gradient editors and spatial controls, but also available standalone.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `value` | string | — | Position as `"X% Y%"` |
| `color` | string | — | Handle color |
| `selected` | boolean | `false` | Selected state |
| `disabled` | boolean | `false` | Disabled state |
| `drag` | boolean | `false` | Enable dragging |
| `drag-surface` | string | — | CSS selector for drag container (defaults to parent) |
| `drag-axes` | string | `"xy"` | Constrain axes: `"x"`, `"y"`, `"xy"` |
| `drag-snapping` | string | — | Snapping behavior |
| `precision` | number | `2` | Decimal places for percentage values and pixel coordinates; use `0` for whole numbers |
| `type` | string | — | `"color"` for a color handle with direct picker activation |
| `tip` | string | — | `"color"`, `"add"`, or `"remove"` to show a persistent `fig-color-tip` |
| `hit-area` | string | — | Expanded interaction zone (unitless px). `"8"`, `"8 12"` (v h), or `"8 circle"` |
| `hit-area-mode` | string | `"handle"` | `"handle"` proxies to handle drag/select; `"delegate"` emits `hitareadown` event |
**Events:**
| Event | Detail |
|---|---|
| `input` | `{ x, y, px, py, shiftKey }` — while dragging |
| `change` | `{ x, y, px, py }` — on release |
| `input` | `{ color, alpha, opacity }` — while editing a `type="color"` handle |
| `change` | `{ color, alpha, opacity }` — when committing a `type="color"` handle |
| `add` | — (when `tip="add"`) |
| `remove` | — (when `tip="remove"`) |
| `hitareadown` | `{ originalEvent }` — when `hit-area-mode="delegate"` and the hit area is clicked |
```html
<div style="position: relative; width: 200px; height: 200px; background: #eee;">
<fig-handle drag="true" value="50% 50%"></fig-handle>
</div>
```
When `drag="true"`, focused handles support Arrow key movement, Home/End jumps, and a tokenized focus outline with a 1px offset.
---
#### Canvas Control
`<fig-canvas-control>` — [demo](https://rog.ie/figui3/#canvas-control)
A composite point control with optional radius circle, angle handle, or second point. Place inside a positioned container; the component uses `display: contents` and does not create its own box.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `type` | string | `"point"` | `"point"`, `"color"`, `"point-radius"`, `"point-radius-angle"`, `"point-point"` |
| `value` | JSON string | — | `{ "x": 50, "y": 50 }` — see type-specific shapes below |
| `name` | string | — | Tooltip label(s). Comma-separated for two handles: `"Start, End"` |
| `color` | string | — | Passthrough color for `type="color"` handle |
| `tooltips` | string | `"true"` | Show value tooltips on interaction |
| `disabled` | boolean | `false` | Disable all interaction |
| `drag-surface` | string | `"parent"` | Forwarded to inner `fig-handle`s |
| `snapping` | string | `"false"` | `"false"`, `"true"`, `"modifier"` — applies to all handles |
| `precision` | number | `2` | Decimal places for positions, radius, angle, and internal handle dragging |
**Value shapes by type:**
| Type | Value shape |
|---|---|
| `point`, `color` | `{ x, y }` |
| `point-radius` | `{ x, y, radius }` — radius: number (px) or `"25%"` |
| `point-radius-angle` | `{ x, y, radius, angle }` — angle in degrees |
| `point-point` | `{ x, y, x2, y2 }` — angle and length inferred |
**Events:**
| Event | Detail |
|---|---|
| `input` | Value object (shape depends on type) — while dragging |
| `change` | Value object (shape depends on type) — on release |
For `type="color"`, color edits add `{ color, alpha, opacity }` to the positional value object.
For `point-point`, both handles support direct drag (with a dynamic directional resize cursor) and rotation via their hit area (dragging from the hit area rotates around the opposite handle at fixed distance, with a rotate cursor).
```html
<div style="position: relative; width: 200px; height: 200px; background: #eee;">
<fig-canvas-control
type="point-point"
name="Start, End"
value='{"x":25,"y":25,"x2":75,"y2":75}'
snapping="modifier"
></fig-canvas-control>
</div>
```
---
### Layout & Feedback
#### Overflow Fade
`.fig-overflow-fade` — [demo](https://rog.ie/figui3/#overflow-fade)
A progressively enhanced scroll utility that fades its edges when more content
is available in that direction. Apply the class to a height-constrained
container for vertical scrolling. Add `.fig-overflow-fade-horizontal` for
horizontal scrolling. Add `.fig-overflow-fade-top` or
`.fig-overflow-fade-bottom` to limit a vertical fade to one edge. Use
`.fig-overflow-fade-left` or `.fig-overflow-fade-right` for a single horizontal
edge; these modifiers imply horizontal scrolling.
| Custom property | Default | Description |
|---|---|---|---|
| `--fig-overflow-fade-size` | `var(--spacer-5)` | Size of each fade edge |
| `--fig-overflow-fade-clear-top` | `0px` | Fully visible area reserved for a sticky header |
| `--fig-overflow-fade-clear-left` | `0px` | Fully visible area reserved at the start of a horizontal scroller |
The mask and animations are applied only when the browser supports self scroll
timelines. Unsupported browsers retain ordinary scrolling without a fade.
```html
<div class="fig-overflow-fade" style="max-height: 12rem;">
<fig-content>
<!-- Long content -->
</fig-content>
</div>
```
```html
<div class="fig-overflow-fade fig-overflow-fade-horizontal">
<div style="display: flex; width: max-content;">
<!-- Wide content -->
</div>
</div>
```
```html
<div class="fig-overflow-fade fig-overflow-fade-bottom">
<!-- Long content that fades only at the bottom -->
</div>
<div class="fig-overflow-fade fig-overflow-fade-right">
<!-- Wide content that fades only at the right -->
</div>
```
---
#### Stack
`<fig-stack>` — [demo](https://rog.ie/figui3/#stack)
A layout primitive for rows, columns, and grids. Replaces the deprecated `hstack` / `vstack` tags, which still render as aliases.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `direction` | string | `"horizontal"` | `"horizontal"`, `"vertical"`, `"grid"` |
| `gap` | string | `"2"` | Spacer token (`"0"`–`"6"`, `"2-5"`, `"half"`) or any CSS length |
| `align` | string | `"center"` (horizontal), `"start"` (vertical), `"stretch"` (grid) | `"start"`, `"center"`, `"end"`, `"stretch"`, `"baseline"` |
| `justify` | string | `"start"` | `"start"`, `"center"`, `"end"`, `"between"`, `"around"`, `"stretch"` |
| `wrap` | boolean | `false` | Wrap items onto multiple lines |
| `full` | boolean | `false` | Fill the parent's width |
| `columns` | string | auto-fill | Grid only: column count (`"3"`) or a `grid-template-columns` value |
| `min-width` | string | `"5rem"` | Grid only: minimum auto-fill column width |
Adjacent `fig-field` children in a horizontal stack share compact gutters.
```html
<fig-stack direction="vertical" gap="3">
<fig-stack justify="between" full>
<label>Layers</label>
<fig-button variant="ghost" icon><fig-icon name="add"></fig-icon></fig-button>
</fig-stack>
<fig-stack direction="grid" columns="3">
<fig-swatch value="#0D99FF"></fig-swatch>
<fig-swatch value="#FFC700"></fig-swatch>
<fig-swatch value="#14AE5C"></fig-swatch>
</fig-stack>
</fig-stack>
```
---
#### Field
`<fig-field>` — [demo](https://rog.ie/figui3/#field)
A form field wrapper with flexible layout. Automatically links `<label>` to the first `fig-*` child for accessibility.
Use `slot="leading"` for an accessory before the label, such as a disclosure or drag handle. Use `slot="trailing"` for an action at the end of the input area, such as reset or remove.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `direction` | string | `"column"` | `"column"`, `"row"`, `"horizontal"` |
| `columns` | string | — | Split preset: `"thirds"` or `"half"` |
| `label` | string | — | Programmatic label text |
```html
<fig-field direction="horizontal" columns="thirds">
<fig-icon slot="leading" name="drag-handle" size="small"></fig-icon>
<label>Opacity</label>
<fig-slider value="50" units="%"></fig-slider>
<fig-button slot="trailing" variant="ghost" icon aria-label="Reset">
<fig-icon name="reset"></fig-icon>
</fig-button>
</fig-field>
```
---
#### Group
`<fig-group>` — [demo](https://rog.ie/figui3/#group)
A section group with an optional generated or authored header. In collapsible groups, the `h3` is the keyboard-accessible toggle and the chevron is clickable; controls placed beside the `h3` in an authored `fig-header` remain independent. Start chevrons use the compact 16px icon; end chevrons use the larger 24px icon.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `name` | string | — | Generated header text |
| `collapsible` | boolean | `false` | Enables collapse behavior |
| `open` | boolean | `false` | Expanded state |
| `chevron` | string | `"start"` | Chevron placement: `"start"` or `"end"` |
| `compact` | boolean | `false` | Adds `compact` to the direct `fig-header` |
```html
<fig-group collapsible open chevron="end">
<fig-header borderless>
<h3>Export</h3>
<fig-button variant="ghost" icon aria-label="Add export">
<fig-icon name="add"></fig-icon>
</fig-button>
</fig-header>
<fig-field>...</fig-field>
</fig-group>
```
---
#### Dialog
`<fig-dialog>` — [demo](https://rog.ie/figui3/#dialog)
A modal/non-modal dialog. Uses `is="fig-dialog"` on a native `<dialog>` element.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `open` | boolean | `false` | Visible state |
| `modal` | boolean | `false` | Modal mode |
| `drag` | boolean | `false` | Draggable |
| `handle` | string | — | CSS selector for drag handle |
| `position` | string | — | `"center center"`, `"top left"`, etc. |
```html
<dialog is="fig-dialog" id="myDialog" modal drag handle="fig-header" position="center center">
<fig-header>Dialog Title</fig-header>
<fig-content padding><p>Content here.</p></fig-content>
</dialog>
```
Use `padding` on `fig-content` for prose-only content. Leave it off when
rendering `fig-field` or `fig-group` children, which provide their own gutters.
Dialog close paths restore focus to the element that opened the dialog.
---
#### Popup
`<fig-popup>` — [demo](https://rog.ie/figui3/#popup)
An anchored floating surface built on `<dialog>` with collision-aware positioning.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `anchor` | string | — | CSS selector for anchor element |
| `position` | string | `"top center"` | Placement |
| `offset` | string | `"0 0"` | X/Y offset |
| `viewport-margin` | string | `"8"` | Viewport safety margin |
| `variant` | string | — | `"popover"` for beak styling |
| `theme` | string | — | `"light"`, `"dark"`, `"menu"` |
| `closedby` | string | `"any"` | `"any"`, `"closerequest"`, `"none"` |
| `open` | boolean | `false` | Open state |
| `drag` | boolean | `false` | Draggable |
| `handle` | string | — | CSS selector for drag handle |
| `autoresize` | boolean | `true` | Observe content size changes; preserve position while in bounds and minimally shift when needed |
| `title` | string | — | Auto-generated header (same as `fig-dialog`) |
```html
<dialog is="fig-popup" anchor="#my-button" position="center right" variant="popover">
<fig-header><h3>Popup</h3></fig-header>
</dialog>
```
Popups restore focus on close. Escape dismissal is scoped so nested menu and
overlay behavior can keep its own keyboard handling. Anchored popups may be
rendered in the global overlay root; interacting with a child popup keeps every
owning ancestor popup open, including recursively nested chains.
---
#### Toast
`<fig-toast>` — [demo](https://rog.ie/figui3/#toast)
A toast notification. Uses `is="fig-toast"` on a native `<dialog>`.
Defaults to `role="status"`, `aria-live="polite"`, and `aria-atomic="true"`. Use `live="assertive"` or `theme="danger"` for assertive announcements.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `duration` | number | `5000` | Auto-dismiss ms (0 = no dismiss) |
| `offset` | number | `16` | Distance from bottom |
| `theme` | string | `"dark"` | `"dark"`, `"light"`, `"danger"`, `"brand"`, `"auto"` |
| `live` | string | — | `"assertive"` for urgent announcements |
| `icon` | string | — | Optional `fig-icon` name prepended when set; always rendered at full size |
| `dismiss` | boolean | `false` | Appends a ghost close button that hides the toast |
```html
<dialog is="fig-toast" id="myToast" theme="brand" icon="warning" dismiss="true" duration="3000">
Settings saved!
</dialog>
<fig-button onclick="document.getElementById('myToast').showToast()">Show</fig-button>
```
---
#### Tooltip
`<fig-tooltip>` — [demo](https://rog.ie/figui3/#tooltip)
Contextual tooltip on hover or click. Auto-repositions when the child element moves.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `text` | string | — | Tooltip text |
| `action` | string | `"hover"` | `"hover"`, `"click"`, `"manual"` |
| `delay` | number | `500` | Show delay in ms |
| `offset` | string | — | `"left,top,right,bottom"` |
| `show` | boolean | `false` | Persistent show state |
| `open` | boolean | `false` | Programmatic show/hide |
```html
<fig-tooltip text="Helpful info">
<fig-button>Hover me</fig-button>
</fig-tooltip>
```
Escape dismisses an open tooltip and returns focus to its trigger.
---
#### Separator
`<fig-separator>` — [demo](https://rog.ie/figui3/#separator)
A visual divider between content groups. The optional `label` attribute adds a group label and accessible name. `<fig-menu-separator>` is a backwards-compatible alias.
```html
<fig-separator></fig-separator>
<fig-separator label="More"></fig-separator>
<fig-menu-separator></fig-menu-separator>
```
---
#### Menu
`<fig-menu>` / `<fig-menu-item>` / `<fig-separator>` / `<fig-menu-separator>` — [demo](https://rog.ie/figui3/#menu)
Triggered menu with native keyboard patterns. The trigger gets `aria-haspopup="menu"`, `aria-expanded`, and `aria-controls`; menu items use `role="menuitem"` and disabled items are skipped by keyboard navigation.
Items stay in the menu's light DOM and project into the popup through slots (same pattern as `fig-select` / `fig-select-options`). The trigger is assigned `slot="trigger"` automatically; items use the default slot. React can add or remove `fig-menu-item` children without `removeChild` errors.
`fig-menu-item` also works as a list row outside `fig-menu` — typically in `<dialog is="fig-popup">` with `<fig-content padding="none">`, sticky `<fig-separator>`s, and a nested `<fig-menu>` for row actions. Item color inherits from the parent surface.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `open` | boolean | `false` | Open state |
| `disabled` | boolean | `false` | Disable trigger/menu |
| `position` | string | `"bottom left"` | Popup placement |
| `offset` | string | — | Popup offset |
| `closedby` | string | — | Popup close behavior |
| `trigger` | string | — | Use `"contextmenu"` to open on right-click |
**Keyboard:** Arrow keys move between enabled items, Home/End jump to edges, Enter/Space selects, Escape closes and returns focus to the trigger.
**Methods:** `showAt(x, y)` opens the menu at viewport coordinates, useful for custom context menu behavior.
```html
<fig-menu position="bottom left">
<fig-button fig-menu-trigger>Actions</fig-button>
<fig-menu-item value="copy">Copy</fig-menu-item>
<fig-menu-item value="paste">Paste</fig-menu-item>
<fig-separator></fig-separator>
<fig-menu-item value="delete" disabled>Delete</fig-menu-item>
<fig-separator label="More"></fig-separator>
<fig-menu-item value="settings">Settings</fig-menu-item>
</fig-menu>
```
Popup list (no wrapping `fig-menu`):
```html
<dialog is="fig-popup" title="Version history" anchor="#versions" position="bottom left">
<fig-content padding="none">
<fig-separator sticky label="Today"></fig-separator>
<fig-menu-item value="v9" subtle>
Version 9
<fig-menu position="bottom right">
<fig-button fig-menu-trigger variant="ghost" icon aria-label="More">
<fig-icon name="more"></fig-icon>
</fig-button>
<fig-menu-item value="restore">Restore this version</fig-menu-item>
</fig-menu>
</fig-menu-item>
</fig-content>
</dialog>
```
`fig-separator` and `fig-menu-separator` accept optional `label` — renders the rule, then a generated `<label>` with secondary group text underneath. An authored child `<label>` takes precedence and is preserved.
---
#### Header
`<fig-header>` — [demo](https://rog.ie/figui3/#header)
A section header component.
```html
<fig-header>Section Title</fig-header>
```
---
#### Layer
`<fig-layer>` — [demo](https://rog.ie/figui3/#layer)
A collapsible layer list item with expand/collapse and visibility toggling. Supports nesting and exposes `role="treeitem"`, `aria-expanded`, `aria-hidden`, `aria-disabled`, and a keyboard-toggleable chevron button.
`fig.js` already registers `fig-layer`. Import `fig-layer.css` to style it.
The standalone `fig-layer.js` entry remains available when layer registration
is needed without the rest of Core.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `open` | boolean | `false` | Whether children are expanded |
| `visible` | boolean | `true` | Whether the layer is visible |
**Events:** `openchange` (detail: `{ open }`), `visibilitychange` (detail: `{ visible }`).
```html
<fig-layer open="true">
<div class="fig-layer-row">
<span class="fig-layer-icon"></span>
<span class="fig-layer-name">Group 1</span>
</div>
<fig-layer>
<div class="fig-layer-row">
<span class="fig-layer-icon"></span>
<span class="fig-layer-name">Child 1</span>
</div>
</fig-layer>
</fig-layer>
```
---
#### Preview
`<fig-preview>`
A thin styled layer for arbitrary visual content. Use it for generated previews, canvas output, SVG, images, or other custom rendered surfaces when you do not need media upload behavior.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `aspect-ratio` | string | `"4/3"` | CSS aspect ratio such as `"1/1"` or `"16/9"` |
| `fit` | string | `contain` | Object fit for direct media children |
| `full` | boolean | `false` | Stretch to the available width |
| `checkerboard` | boolean | `false` | Show checkerboard behind transparent content |
Set `--fig-preview-background` to customize the surface color, including `transparent` to remove it.
```html
<fig-preview full style="height: 96px">
<canvas width="320" height="180"></canvas>
</fig-preview>
<fig-preview checkerboard>
<img src="photo.png" alt="Preview">
</fig-preview>
```
---
#### Media
`<fig-media>`
Unified media component that supports image/video modes and shared sizing/upload behavior. The media surface is rendered inside a `fig-preview`; generated video controls render below that preview rather than as an overlay. Set `size` for a token-sized square, or `aspect-ratio` to fill the container width with a fixed ratio.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `type` | string | `"image"` | `"image"` or `"video"` |
| `src` | string | — | Media URL |
| `alt` | string | `""` | Alt text forwarded to the generated `<img>` (image mode) |
| `loaded` | boolean | `false` | Read-only reflected state after an image loads successfully |
| `upload` | boolean | `false` | Show upload overlay (`fig-input-file`) |
| `loading-indicator` | boolean | `true` | Set to `"false"` to disable the delayed loading spinner for generated images |
| `label` | string | `"Upload"` | Upload button label |
| `size` | string | — | `small` \| `medium` \| `large` \| `auto` (token-sized square) |
| `aspect-ratio` | string | — | CSS aspect-ratio (e.g. `"16 / 9"`); fills container width |
| `fit` | string | `"contain"` | CSS object-fit (`"cover"`, `"contain"`, etc.) |
| `checkerboard` | boolean | `false` | Show checkerboard behind transparent media |
| `caption` | string | — | Caption text rendered below the media preview |
| `controls` | boolean | `false` | Show playback controls for video |
| `autoplay` | boolean | `false` | Video autoplay |
| `loop` | boolean | `false` | Video loop |
| `muted` | boolean | `false` | Video muted |
| `poster` | string | — | Video poster URL |
| `aria-label` | string | — | Accessible label forwarded to generated videos |
Use meaningful `alt` text for informative images. Use `alt=""` only when the image is decorative or already described by nearby text.
```html
<fig-media type="image" src="photo.jpg" alt="Selected image"></fig-media>
<fig-media type="image" src="photo.jpg" alt="Cover image" aspect-ratio="16 / 9" fit="cover"></fig-media>
<fig-media type="video" src="clip.mp4" aria-label="Product demo video" caption="Looping product demo" controls muted></fig-media>
<fig-media type="image" src="photo.jpg" alt="Selected image">
<figcaption>Selected image from the current document.</figcaption>
</fig-media>
```
Use the `caption` attribute for a plain-text caption, or a direct `<figcaption>` child for authored caption content.
Native load lifecycle events are re-emitted from the `fig-media` host as bubbling, composed `CustomEvent`s. Image mode emits `load` and `error`. Video mode forwards `loadstart`, `progress`, `suspend`, `abort`, `error`, `emptied`, `stalled`, `loadedmetadata`, `loadeddata`, `canplay`, `canplaythrough`, `playing`, `waiting`, `seeking`, `seeked`, `durationchange`, `timeupdate`, `ratechange`, `resize`, and `volumechange`; existing `play`, `pause`, and `ended` events remain available. Event `detail` includes `src`, `media`, and `originalEvent`, plus video timing and readiness state.
For generated images, a spinner appears when loading exceeds 150ms and is removed on `load` or `error`. The host reflects `aria-busy="true"` while pending. Authored media or preview content does not receive an automatic spinner.
---
#### Image
`<fig-image>` — [demo](https://rog.ie/figui3/#image)
An image display component with optional upload, aspect ratio, and object-fit control. Renders a real `<img>` inside a `fig-preview`.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `src` | string | — | Image URL |
| `alt` | string | `""` | Alt text forwarded to the generated `<img>` |
| `loaded` | boolean | `false` | Read-only reflected state after the image loads successfully |
| `upload` | boolean | `false` | Show upload overlay (`fig-input-file`) |
| `loading-indicator` | boolean | `true` | Set to `"false"` to disable the delayed loading spinner |
| `label` | string | `"Upload"` | Upload button label |
| `size` | string | — | `small` \| `medium` \| `large` \| `auto` (token-sized square) |
| `aspect-ratio` | string | — | CSS aspect-ratio (e.g. `"16 / 9"`); fills container width |
| `fit` | string | `"contain"` | CSS object-fit (`"cover"`, `"contain"`, etc.) |
| `checkerboard` | boolean | `false` | Show checkerboard behind transparent images |
| `caption` | string | — | Caption text rendered below the image preview |
Use meaningful `alt` text for informative images. Use `alt=""` for decorative previews, thumbnails with visible labels, or upload placeholders.
The generated image's native `load` and `error` events are re-emitted from `fig-image` as bubbling, composed `CustomEvent`s with `src`, `media`, and `originalEvent` in `event.detail`.
The `loaded` attribute is removed when `src` changes or loading fails, so it can be used as a CSS state selector such as `fig-image[loaded]`.
```html
<fig-image src="photo.jpg" alt="Selected image"></fig-image>
<fig-image src="photo.jpg" alt="Cover image" aspect-ratio="16 / 9" fit="cover" caption="Cover image"></fig-image>
<fig-image upload label="Upload Image" alt=""></fig-image>
<fig-image src="photo.jpg" alt="Selected image">
<figcaption>Selected image from the current document.</figcaption>
<fig-input-file slot="overlay" variant="overlay" label="Change image"></fig-input-file>
</fig-image>
```
Use `slot="overlay"` for custom overlay controls. Slotted overlays stay as direct light-DOM children so frameworks like React keep ownership of their nodes, while CSS places them over the preview and keeps them visible on hover, focus, and active interaction.
---
#### Card
`<fig-card>` — [demo](https://rog.ie/figui3/#card)
A media card with a truncated label and attribute-only selection chrome. With `src`, it composes a generated `fig-image`. The `label` and `sublabel` attributes render inside a generated `fig-footer`.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `src` | string | — | Image URL forwarded to generated `fig-image` |
| `alt` | string | `""` | Alt text forwarded to generated `fig-image` |
| `label` | string | — | Card title (preferred over `text`) |
| `text` | string | — | Alias for `label` |
| `sublabel` | string | — | Secondary one-line text under the label |
| `selected` | boolean | `false` | Selected chrome only (no click-toggle) |
| `disabled` | boolean | `false` | Dim + non-interactive |
| `full` | boolean | `false` | Stretch to the available width (cards are already `width: 100%` by default) |
| `size` | string | default | Set to `"large"` for `--spacer-2` card padding and `--spacer-1` label spacing |
| `direction` | string | `"vertical"` | Set to `"horizontal"` for a list layout with 40px media on the left (56px with `size="large"`) and stacked labels on the right |
| `aspect-ratio` | string | `"1/1"` | Forwarded to generated `fig-image` |
| `fit` | string | `"contain"` | Forwarded to generated `fig-image` |
| `label-line-clamp` | string | `"1"` | `"1"` or `"2"` line clamp for the label |
| `label-overflow` | string | `"ellipsis"` | Set to `"fade"` to apply horizontal overflow fades to the label and sublabel |
Horizontal thumbnail sizing uses `--fig-card-thumbnail-width` (`2.5rem` by default, `3.5rem` with `size="large"`) and `--fig-card-thumbnail-height` (`auto` by default). Leaving height at `auto` preserves the media `aspect-ratio`.
```html
<fig-card src="photo.jpg" label="Autumn field"></fig-card>
<fig-card src="photo.jpg" label="Autumn field" sublabel="Landscape photography" direction="horizontal"></fig-card>
<fig-card src="photo.jpg" label="A long card label" sublabel="A long card sublabel" direction="horizontal" label-overflow="fade"></fig-card>
<fig-card src="photo.jpg" label="Large card" size="large"></fig-card>
<fig-card src="photo.jpg" label="Shader pill" sublabel="Generative tools/effects" selected></fig-card>
<fig-card src="photo.jpg" label="Wide card" aspect-ratio="16/9" full></fig-card>
<fig-card label="Custom preview">
<fig-preview>...</fig-preview>
</fig-card>
<fig-card>
<fig-preview>...</fig-preview>
<fig-footer><label>Authored footer</label></fig-footer>
</fig-card>
```
`label-overflow="fade"` adds both `fig-overflow-fade` and `fig-overflow-fade-horizontal` to generated or authored `.fig-card-label` and `.fig-card-sublabel` elements. Any other value uses the default ellipsis behavior.
When `src` is omitted, authored direct children such as `fig-image`, `fig-media`, or `fig-preview` remain direct children of the card. An authored `fig-footer` is preserved; when no `label`, `text`, or `sublabel` attributes are present, the card does not generate another footer.
Place cards in a CSS grid for multi-column layouts — there is no built-in columns attribute. Prefer `full` in fluid layouts for consistency with other FigUI controls.
---
#### Video
`<fig-video>`
Video display/upload component with the same preview styling model as `fig-image`. Renders a real `<video>` inside a `fig-preview`; generated playback controls tack onto the bottom.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `src` | string | — | Video URL |
| `upload` | boolean | `false` | Show upload overlay (`fig-input-file`) |
| `label` | string | `"Upload"` | Upload button label |
| `size` | string | — | `small` \| `medium` \| `large` \| `auto` (token-sized square) |
| `aspect-ratio` | string | — | CSS aspect-ratio (e.g. `"16 / 9"`); fills container width |
| `fit` | string | `"contain"` | CSS object-fit (`"cover"`, `"contain"`, etc.) |
| `controls` | boolean | `false` | Show playback controls |
| `autoplay` | boolean | `false` | Autoplay video |
| `loop` | boolean | `false` | Loop video |
| `muted` | boolean | `false` | Mute video |
| `poster` | string | — | Poster image URL (forwarded to inner `<video>`) |
| `aria-label` | string | — | Accessible label forwarded to the generated `<video>` |
| `caption` | string | — | Caption text rendered below the video preview |
Prefer `controls` for videos that play motion. Use native `<track>` text tracks when the video includes speech or essential audio.
```html
<fig-video src="clip.mp4" aria-label="Product demo video" caption="Product demo" controls></fig-video>
<fig-video src="clip.mp4" aria-label="Product demo video" aspect-ratio="16 / 9" controls></fig-video>
<fig-video upload label="Upload Video" aria-label="Uploaded video preview" controls muted>
<figcaption>Uploaded video preview.</figcaption>
</fig-video>
```
---
#### Avatar
`<fig-avatar>` — [demo](https://rog.ie/figui3/#avatar)
Profile image or initials fallback.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `src` | string | — | Image URL |
| `name` | string | — | Name for initials fallback |
| `size` | string | — | `"large"` |
```html
<fig-avatar src="https://example.com/photo.jpg" name="John Doe"></fig-avatar>
<fig-avatar name="Jane Smith" size="large"></fig-avatar>
```
---
#### Icon
`<fig-icon>` — [demo](https://rog.ie/figui3/#icon)
Masked icon using `--icon-16-*` and `--icon-24-*` design tokens (SVG artboard size). Display size is controlled separately via the `size` attribute.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `name` | string | — | Icon name: `add`, `send`, `close`, `chevron`, `arrow-left`, etc. |
| `size` | string | `medium` | `medium` (1.5rem) or `small` (1rem) |
| `color` | string | — | Alias (`primary`, `secondary`, `tertiary`, `disabled`, `brand`, `component`, `danger`, `success`, `warning`, `selected`, `hover`, `pressed`, `onbrand`, …); CSS variables and explicit CSS colors also accepted |
```html
<fig-icon name="close"></fig-icon>
<fig-icon name="send" color="brand"></fig-icon>
<fig-icon name="chevron" size="small"></fig-icon>
```
Legacy: `<span class="fig-mask-icon" style="--icon: var(--icon-24-add)"></span>` still works.
Icon tokens are included by `fig.css`. To consume only the generated token
variables, import `@rogieking/figui3/icons.css` (or
`@rogieking/figui3/src/icons.css` for the unminified source). Override any
glyph by redefining its custom property after that import:
```css
@import "@rogieking/figui3/icons.css";
:root {
--icon-24-add: url("./icons/custom-add.svg");
}
```
---
#### Spinner
`<fig-spinner>` — [demo](https://rog.ie/figui3/#spinner)
A loading spinner.
Defaults to `role="status"` and `aria-label="Loading"`; override the label when the loading target needs a more specific name.
```html
<fig-spinner></fig-spinner>
```
---
#### Shimmer
`<fig-shimmer>` — [demo](https://rog.ie/figui3/#shimmer)
A shimmer loading placeholder.
| Attribute | Type | Default | Description |
|---|---|---|---|
| `duration` | string | `"1.5s"` | Animation cycle duration |
| `playing` | boolean | `true` | Whether animating |
Shimmer and skeleton placeholders are hidden from assistive tech unless you add `aria-label` or `aria-labelledby`; named placeholders expose `role="status"` and `aria-busy`.
```html
<fig-shimmer style="width: 200px; height: 20px;"></fig-shimmer>
```
---
#### Skeleton
`<fig-skeleton>`
Extends `<fig-shimmer>` for structured loading placeholders. Skeletons are inert by default, so any placeholder inputs or buttons inside them are removed from tab focus while loading.
```html
<fig-skeleton style="width: 100%; height: 1rem; border-radius: 4px;"></fig-skeleton>
```
---
## Theming
FigUI3 adapts to light and dark themes via CSS custom properties using Figma's naming convention:
```css
--figma-color-bg
--figma-color-bg-secondary
--figma-color-bg-hover
--figma-color-text
--figma-color-text-secondary
--figma-color-border
--figma-color-icon
/* ... and more */
```
In Figma plugins, these variables are provided automatically. For standalone usage, the library includes fallback values that respond to `prefers-color-scheme`.
Force a theme manually:
```html
<body style="color-scheme: dark;">
<!-- Forces dark theme -->
</body>
```
Focus indicators are controlled with shared tokens:
```css
--figma-focus-outline
--figma-focus-outline-offset
--figma-focus-outline-radius
```
`--figma-focus-outline-radius` defaults to `inherit`, so focused controls can inherit their component radius unless a component overrides it for a specific shape.
---
## Framework Integration
Public FigUI events that bubble are also composed. Events such as `input`,
`change`, `openchange`, and `reorder` therefore cross shadow DOM boundaries and
can be handled by an ancestor component or application. Cancelability remains
event-specific; check `event.cancelable` before relying on `preventDefault()`.
### React
Event handling differs between React 18 and React 19:
| Event | React 19 | React 18 |
|---|---|---|
| `click` | `onClick` | `onClick` |
| `input` | `onInput`; read `event.nativeEvent.detail` | `onInput`; read `event.nativeEvent.detail` |
| `change` | `onChange`; read `event.nativeEvent.detail` | Use `addEventListener` |
| Named events such as `loaded` or `reorder` | Use `addEventListener` for portable code | Use `addEventListener` |
React handlers receive a `SyntheticEvent`, so their custom-event payload is at
`event.nativeEvent.detail`, not `event.detail`. Native listeners receive the
`CustomEvent` directly and use `event.detail`.
The native-listener pattern works in both React versions:
```jsx
import { useRef, useEffect, useLayoutEffect } from 'react';
import '@rogieking/figui3/react';
import '@rogieking/figui3/fig.css';
import '@rogieking/figui3/fig.js';
function ColorPicker({ value, onChange, isAllowed }) {
const ref = useRef(null);
const committed = useRef(value);
committed.current = value;
useEffect(() => {
const el = ref.current;
if (!el) return;
const handleChange = (e) => {
const next = e.detail.value ?? e.detail;
if (isAllowed && !isAllowed(next)) {
el.setAttribute('value', committed.current);
return;
}
onChange(next);
};
el.addEventListener('change', handleChange);
return () => el.removeEventListener('change', handleChange);
}, [isAllowed, onChange]);
useLayoutEffect(() => {
const el = ref.current;
if (el && el.getAttribute('value') !== value) {
el.setAttribute('value', value);
}
});
return <fig-input-color ref={ref} text="true" alpha="true" />;
}
```
The React subpath supplies JSX tags, typed refs and imperative methods, and
typed `nativeEvent.detail` payloads for every core, editor, and Lab component.
DOM consumers receive the same element types through
`HTMLElementTagNameMap`.
In React 19, JSX handlers can be used for `input` and `change`:
```jsx
function onChange(event) {
const detail = event.nativeEvent.detail;
console.log('Final:', detail);
}
<fig-input-color onChange={onChange} text="true" alpha="true" />
```
In React 18, do not rely on JSX `onChange` for custom elements. Use the
native-listener pattern above for `change` and named custom events.
> **Controlled state:** FigUI3 controls are event-driven/uncontrolled from
> React's perspective. React does not restore an unchanged JSX `value` or
> `checked` prop after a rejected edit. Synchronize through a ref after every
> committed render and immediately restore rejected edits in the event
> handler. For checked controls, set `.checked` and call
> `.toggleAttribute("checked", checked)`.
>
> **SSR (Next.js/Remix/Astro):** The JavaScript bundles can be imported by the
> server without throwing, but browser-side registration must happen after
> hydration. Use `@rogieking/figui3/register.js` from a post-hydration effect;
> do not statically import `fig.js`, `fig-editor.js`, or `fig-lab.js` in a
> hydrating client bundle.
### Vue
```vue
<template>
<fig-input-color :value="color" text="true" alpha="true" @input="onInput" @change="onChange" />
</template>
<script setup>
import { ref } from 'vue';
import '@rogieking/figui3/fig.css';
import '@rogieking/figui3/fig.js';
const color = ref('#FF5733');
const onInput = (e) => { color.value = e.detail.color; };
const onChange = (e) => { console.log('Final:', e.detail); };
</script>
```
### Svelte
```svelte
<script>
import '@rogieking/figui3/fig.css';
import '@rogieking/figui3/fig.js';
let color = '#FF5733';
</script>
<fig-input-color value={color} text="true" alpha="true"
on:input={(e) => color = e.detail.color}
on:change={(e) => console.log('Saved:', e.detail)} />
```
---
## Development
```bash
git clone https://github.com/rogie/figui3.git
cd figui3
bun install
bun dev # Component docs at http://localhost:3000
npm run dev:playground # Playground at http://localhost:6600 (/figui3, /figui3/lab, /sandbox)
npm run build # Build minified dist/ (JS + CSS)
npm run build:icons # Regenerate icons.css from icons/ SVG sources
npm run check:icons # Verify the manifest, SVGs, and generated CSS agree
npm run build:css # Build minified CSS only
```
To add an icon, place its mask-safe monochrome SVG in `icons/<size>/<name>.svg`
and add the name, sizes, and optional `<fig-icon>` mapping to
`icons/manifest.js`. Do not edit `icons.css` directly.
Component implementations live under `src/`:
- `src/core/` — MIT core components and styles
- `src/editor/` — PolyForm editor components and styles
- `src/lab/` — PolyForm experimental components and styles
- `src/shared/` — MIT runtime helpers shared across bundles
Each registered custom element owns a matching
`components/fig-<name>.js` / `components/fig-<name>.css` pair. Shared runtime
and selector primitives live outside `components/`; they must not register a
tag themselves.
The aggregate `fig.*`, `fig-editor.*`, and `fig-lab.*` barrels remain at the
repository root. Standalone component source entrypoints live in each domain's
`entrypoints/` directory; their npm and `dist/` import names remain unchanged.
Add or edit component implementation in its `src/` domain; do not move
consumer imports to internal paths.
### Build Output
`npm run build` produces minified files in `dist/`:
| Source | Minified | Tool |
|---|---|---|
| `fig.js` + `src/core/` | `dist/fig.js` (395 KB) | Bun `--minify` |
| `fig-editor.js` + `src/editor/` | `dist/fig-editor.js` (154 KB) | Bun `--minify` |
| `fig-lab.js` + `src/lab/` | `dist/fig-lab.js` (81 KB) | Bun `--minify` |
| `fig.css` + imported source CSS | `dist/fig.css` (218 KB) | lightningcss `--minify --nesting --bundle` |
| `components.css` + `src/core/` CSS | `dist/components.css` (216 KB) | lightningcss |
| `icons.css` (generated) | `dist/icons.css` | `scripts/build-icons.mjs` + lightningcss |
| `fig-editor.css` + `src/editor/` CSS | `dist/fig-editor.css` (24 KB) | lightningcss |
| `fig-lab.css` + `src/lab/` CSS | `dist/fig-lab.css` (46 KB) | lightningcss |
| `base.css` (2 KB) | `dist/base.css` (2 KB) | lightningcss |
Default imports resolve to minified `dist/` files. Unminified source is available via `@rogieking/figui3/src/*`:
```js
import "@rogieking/figui3/fig.css"; // minified (default)
import "@rogieking/figui3/src/fig.css"; // unminified source
```
### Playground
The playground is the fastest way to explore and validate component markup:
- **`/figui3`** — component examples and property panel patterns with attribute controls
- **`/figui3/lab`** — experimental component examples
- **`/sandbox`** — styled React sample app
---
## Browser Support
- Chrome/Edge 123+
- Firefox 120+
- Safari 17.5+
These floors match the modern CSS baseline used by the distributed styles,
including CSS nesting, `:has()`, and `light-dark()`. Releases run the full
suite in Playwright Chromium plus a core, editor, Lab, events, and customized
built-ins smoke suite in current Playwright Firefox and WebKit. Older browser
versions are not supported; FigUI3 does not transpile JavaScript or polyfill
general platform features. Safari's customized built-in elements use the
included WebKit polyfill.
---
## License
Split license. See [LICENSE](LICENSE).
- **MIT:** Core, including `fig.js`, `fig-layer.js`, `fig-color.js`, and core CSS
- **PolyForm Shield 1.0.0 (not OSI open source):** Editor and Lab entry points, helper modules, CSS, and skill docs enumerated in `LICENSE`
- **ISC:** Vendored `@ungap/custom-elements-builtin` WebKit polyfill
© Rogie King