Skip to content

Animate config — full field reference

This is the exhaustive reference for every field of the domotion animate config. It is generated directly from schemas/animate-config.schema.json — the same schema the CLI validates against and ships in the npm package — so it can never drift from what domotion animate actually accepts.

New here? Start with the guided Animate config format page for a narrative introduction, then come back here for the complete field list. Within each table and section below, fields are ordered most-common-first (not in raw schema order), so the everyday options come before the rarely-used ones.

Config for the domotion animate CLI: a list of frames captured from a URL / HTML file, with per-frame actions, overlays, intra-frame animations, and transitions, composed into one animated SVG. Authoritative validation is the zod schema in src/cli/animate.ts; cross-field rules (frame-0 input, scroll-pattern / regex validity) are enforced at runtime and not expressed here.

Field Type Required Default Description
width number ✔
height number ✔
frames object[] ✔
output string
optimize boolean
mobile boolean
colorScheme "light" | "dark" | "no-preference"
vars object
cursor string | object
$schema string Optional pointer to this JSON Schema for editor support; ignored by the CLI.
brand string | object
autoCompress boolean
realText boolean

One of 2 variants:

Field Type Required Default Description
style object
events object[] ✔
Field Type Required Default Description
scale number
color string
pulseColor string
pulseRadius number
pulseDurationMs number
Field Type Required Default Description
frame integer ✔
at number 0
type "move" | "click" | "moveClick" | "hide" ✔
selector string
to object
offset object
duration number
button "primary" | "secondary" | "middle"
Field Type Required Default Description
x number ✔
y number ✔
Field Type Required Default Description
dx number ✔
dy number ✔

One of 2 variants:

Field Type Required Default Description
palette object
font object
radius number Corner radius (px) for panels/cards.
logo string Logo asset (path/URL) for templates with a logo slot.
background string Optional richer scene fill (overrides palette.background full-bleed).
Field Type Required Default Description
primary string Main brand color (buttons, accents, series 1).
accent string Secondary accent (highlights, bars, series 2).
background string Flat surface color behind content.
text string Primary text / foreground color.
muted string Secondary text color.
Field Type Required Default Description
family string CSS font-family stack.
weights number[] Font weights a template may pick from.

Each entry in frames. The first frame must have an input (or template/cast); later frames may set continue: true to keep driving the same page.

Field Type Required Default Description
input string
template string
cast string
continue boolean
duration number 0
transition object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object
actions object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object[]
overlays object | object | object | object | object | object[]
animations object[]
waitForText object
waitForCount object
waitForGone string
waitFor string
wait number
fit "center" | "contain" | "cover"
scroll object
scrollTo any[]
selector string
params object
term object
forceState object[]
hoverReveal object
hoverDetect object
typeResample object
cssPropertyResample object
jsReveal object
states object[]
regions object
caret boolean | object
textTracks object[]
compress boolean

One of 19 variants:

Field Type Required Default Description
type "scroll" ✔
duration number ✔
Field Type Required Default Description
type "crossfade" ✔
duration number ✔
Field Type Required Default Description
type "cut" ✔
duration number ✔
Field Type Required Default Description
type "magic-move" ✔
duration number ✔
Field Type Required Default Description
type "push-left" ✔
duration number ✔
Field Type Required Default Description
type "push-right" ✔
duration number ✔
Field Type Required Default Description
type "push-up" ✔
duration number ✔
Field Type Required Default Description
type "push-down" ✔
duration number ✔
Field Type Required Default Description
type "wipe" ✔
duration number ✔
easing string Named or CSS easing for the transition timeline.
wipeAngle number
Field Type Required Default Description
type "iris" ✔
duration number ✔
easing string Named or CSS easing for the transition timeline.
Field Type Required Default Description
type "wipe-radial" ✔
duration number ✔
easing string Named or CSS easing for the transition timeline.
Field Type Required Default Description
type "wipe-clock" ✔
duration number ✔
easing string Named or CSS easing for the transition timeline.
wipeStartAngle number
wipeCounterclockwise boolean
Field Type Required Default Description
type "zoom-in" ✔
duration number ✔
easing string Named or CSS easing for the transition timeline.
Field Type Required Default Description
type "zoom-out" ✔
duration number ✔
easing string Named or CSS easing for the transition timeline.
Field Type Required Default Description
type "shine" ✔
duration number ✔
shine object
Field Type Required Default Description
angle number 14
bandWidth number 0.28 Band width as a fraction of viewport width.
color string "#ffffff"
opacity number 0.55
Field Type Required Default Description
type "push" ✔
duration number ✔
easing string Named or CSS easing for the transition timeline.
push object | object ✔

One of 2 variants:

Field Type Required Default Description
direction "left" | "right" | "up" | "down" "left"
distance number 1
Field Type Required Default Description
angle number ✔
distance number 1
Field Type Required Default Description
type "reveal" ✔
duration number ✔
easing string Named or CSS easing for the transition timeline.
reveal object | object | object ✔

One of 3 variants:

Field Type Required Default Description
shape "linear" ✔
angle number 0
Field Type Required Default Description
shape "radial" ✔
origin object {"x":0.5,"y":0.5}
radius number 1
Field Type Required Default Description
shape "clock" ✔
origin object {"x":0.5,"y":0.5}
startAngle number 0
direction "clockwise" | "counterclockwise" "clockwise"
Field Type Required Default Description
type "zoom" ✔
duration number ✔
easing string Named or CSS easing for the transition timeline.
zoom object ✔
Field Type Required Default Description
fromScale number 0.9
origin object {"x":0.5,"y":0.5}
Field Type Required Default Description
x number ✔ Viewport-relative x coordinate: 0=left, 1=right.
y number ✔ Viewport-relative y coordinate: 0=top, 1=bottom.
Field Type Required Default Description
type "custom" ✔
duration number ✔
easing string Named or CSS easing for the transition timeline.
custom object ✔
Field Type Required Default Description
zOrder "incoming-on-top" "incoming-on-top"
incoming object ✔
outgoing object ✔
overlay object
reducedMotion "crossfade" | "cut" "crossfade"
loop "hold-last" | "crossfade-to-first" "hold-last"
Field Type Required Default Description
opacity number Starting opacity; settles at 1.
translate object Starting viewport-fraction offset; settles at zero.
scale object Starting scale; settles at 1.
clip object | object | object Starting reveal clip; settles fully revealed.
Field Type Required Default Description
opacity number Ending opacity; starts at 1.
translate object Ending viewport-fraction offset; starts at zero.
scale object Ending scale; starts at 1.
Field Type Required Default Description
angle number 14
bandWidth number 0.28 Band width as a fraction of viewport width.
color string "#ffffff"
opacity number 0.55

One of 27 variants:

Field Type Required Default Description
type "click" ✔
selector string ✔
cursorAt "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
cursorOffset object
Field Type Required Default Description
dx number
dy number
Field Type Required Default Description
type "fill" ✔
selector string ✔
value string ✔
cursorAt "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
cursorOffset object
Field Type Required Default Description
dx number
dy number
Field Type Required Default Description
type "press" ✔
key string ✔
Field Type Required Default Description
type "hover" ✔
selector string ✔
cursorAt "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
cursorOffset object
Field Type Required Default Description
dx number
dy number
Field Type Required Default Description
type "scroll" ✔
x number
y number
Field Type Required Default Description
type "wait" ✔
ms number ✔
Field Type Required Default Description
type "scrollIntoView" ✔
selector string ✔
block "start" | "center" | "end" | "nearest"
inline "start" | "center" | "end" | "nearest"
Field Type Required Default Description
type "dispatch" ✔
selector string ✔
event string ✔
bubbles boolean
Field Type Required Default Description
type "focus" ✔
selector string ✔
Field Type Required Default Description
type "blur" ✔
selector string ✔
Field Type Required Default Description
type "selectText" ✔
selector string ✔
Field Type Required Default Description
type "clear" ✔
selector string ✔
Field Type Required Default Description
type "setText" ✔
selector string ✔
value string ✔
Field Type Required Default Description
type "setHtml" ✔
selector string ✔
value string ✔
Field Type Required Default Description
type "remove" ✔
selector string ✔
Field Type Required Default Description
type "setAttribute" ✔
selector string ✔
name string ✔
value string ✔
Field Type Required Default Description
type "removeAttribute" ✔
selector string ✔
name string ✔
Field Type Required Default Description
type "addClass" ✔
selector string ✔
class string ✔
Field Type Required Default Description
type "removeClass" ✔
selector string ✔
class string ✔
Field Type Required Default Description
type "toggleClass" ✔
selector string ✔
class string ✔
Field Type Required Default Description
type "setStyle" ✔
selector string ✔
props object ✔
Field Type Required Default Description
type "insert" ✔
selector string ✔
position "beforebegin" | "afterbegin" | "beforeend" | "afterend" ✔
html string ✔
Field Type Required Default Description
type "setValue" ✔
selector string ✔
value string ✔
Field Type Required Default Description
type "check" ✔
selector string ✔
checked boolean ✔
Field Type Required Default Description
type "selectOption" ✔
selector string ✔
value string ✔
Field Type Required Default Description
type "replaceText" ✔
selector string ✔
pattern string ✔
replacement string ✔
flags string
Field Type Required Default Description
type "evaluate" ✔
script string ✔

One of 6 variants:

Field Type Required Default Description
kind "typing" ✔
text string ✔
x number 0
y number 0
fontSize number
fontFamily string
kern boolean
color string
delay number
speed number
mode "type" | "paste"
jitter number
wrapWidth number
mask object
bgColor string
bgWidth number
bgHeight number
caret boolean | object
mistakes number | array
mistakeThinkMs number
holdToFrameEnd boolean
endAt number
anchor object
maxWidth string | number
Field Type Required Default Description
width number
height number
color string

One of 2 variants:

Field Type Required Default Description
color string
width number
blinkMs number
shape "bar" | "block" | "underscore"
Field Type Required Default Description
selector string ✔
at "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
dx number
dy number
baseline boolean
Field Type Required Default Description
kind "tap" ✔
x number 0
y number 0
delay number
endAt number
anchor object
Field Type Required Default Description
selector string ✔
at "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
dx number
dy number
Field Type Required Default Description
kind "svg" ✔
src string ✔
x number 0
y number 0
width number ✔
height number ✔
enter object
exit object
anchor object
delay number
endAt number
Field Type Required Default Description
from "top" | "bottom" | "left" | "right" ✔
duration number ✔
easing string
delay number
Field Type Required Default Description
from "top" | "bottom" | "left" | "right" ✔
duration number ✔
easing string
delay number
Field Type Required Default Description
selector string ✔
at "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
dx number
dy number
Field Type Required Default Description
kind "blink" ✔
x number 0
y number 0
width number ✔
height number ✔
periodMs number
color string
fillOpacity number
radius number
delay number
endAt number
anchor object
Field Type Required Default Description
selector string ✔
at "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
dx number
dy number
Field Type Required Default Description
kind "shine" ✔
x number 0
y number 0
width number 0
height number 0
delay number
duration number
color string
opacity number
bandWidth number
skewDeg number
radius number
repeat number | string
repeatPeriodMs number
endAt number
anchor object
Field Type Required Default Description
selector string ✔
at "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
dx number
dy number
Field Type Required Default Description
kind "interact" ✔
x number 0
y number 0
width number 0
height number 0
treatment "hover" | "focus" | "press"
fill string
fillOpacity number
ring string
ringWidth number
radius number
scale number
delay number
duration number
holdMs number
releaseMs number
repeat number | string
repeatPeriodMs number
endAt number
anchor object
Field Type Required Default Description
selector string ✔
at "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
dx number
dy number
Field Type Required Default Description
property "width" | "height" | "opacity" | "transform" | "translateX" | "translateY" | "scale" | "clipPath"
from string
to string
duration number ✔
easing string
transformOrigin string
transformBox "fill-box" | "stroke-box" | "view-box"
delay number
repeat integer | string
alternate boolean
fuse object[]
selector string ✔
preset string Named motion preset supplying property/from/to/fuse/easing.
presetDistance number Travel px for slide/fade presets.
presetScaleFrom number Start scale for the pop preset.
exit boolean Reverse the preset (animate the element OUT).
Field Type Required Default Description
property "width" | "height" | "opacity" | "transform" | "translateX" | "translateY" | "scale" | "clipPath" ✔
from string ✔
to string ✔
duration number
delay number
easing string
Field Type Required Default Description
selector string ✔
equals string
contains string
Field Type Required Default Description
selector string ✔
equals number
atLeast number
atMost number
Field Type Required Default Description
pattern string ✔
speed number
selector string
clip any[]
prescroll boolean
Field Type Required Default Description
theme string | object
mode "incremental" | "full"
cursor "block" | "bar" | "underline" | "none"
cursorColor string
fontSize number
fontFamily string
padding number
cols integer
rows integer
settleMs number
minFrameMs number
maxFrameMs number
tailMs number

One of 2 variants:

Field Type Required Default Description
extends string
name string
bg string
fg string
ansi string[]
Field Type Required Default Description
selector string ✔
states "hover" | "active" | "focus" | "focus-within" | "focus-visible" | "visited" | "target" | "enabled" | "disabled" | "checked" | "indeterminate" | "read-only" | "read-write" | "link"[]
reset boolean
Field Type Required Default Description
selector string ✔
states "hover" | "active" | "focus" | "focus-within" | "focus-visible" | "visited" | "target" | "enabled" | "disabled" | "checked" | "indeterminate" | "read-only" | "read-write" | "link"[]
crossfadeMs number
hoverMs number
cursor boolean
Field Type Required Default Description
selector string ✔
states "hover" | "active" | "focus" | "focus-within" | "focus-visible" | "visited" | "target" | "enabled" | "disabled" | "checked" | "indeterminate" | "read-only" | "read-write" | "link"[]
transitionMs number
hoverMs number
cursor boolean
Field Type Required Default Description
selector string ✔
text string ✔
speed number
delay number
tailMs number
clear boolean
caret boolean
caretShape "auto" | "bar" | "block" | "underscore"
regionOnly boolean
Field Type Required Default Description
selector string ✔
fps number
Field Type Required Default Description
selector string ✔
event "mouseover" | "mouseenter" | "mousedown" | "mouseup" | "click" | "pointerover" | "pointerenter" | "pointerdown"
settleMs number
debounceMs number
holdMs number
crossfadeMs number
Field Type Required Default Description
actions object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object[]
duration number ✔
advances string[]
overlays object | object | object | object | object | object[]

One of 27 variants:

Field Type Required Default Description
type "click" ✔
selector string ✔
cursorAt "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
cursorOffset object
Field Type Required Default Description
dx number
dy number
Field Type Required Default Description
type "fill" ✔
selector string ✔
value string ✔
cursorAt "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
cursorOffset object
Field Type Required Default Description
dx number
dy number
Field Type Required Default Description
type "press" ✔
key string ✔
Field Type Required Default Description
type "hover" ✔
selector string ✔
cursorAt "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
cursorOffset object
Field Type Required Default Description
dx number
dy number
Field Type Required Default Description
type "scroll" ✔
x number
y number
Field Type Required Default Description
type "wait" ✔
ms number ✔
Field Type Required Default Description
type "scrollIntoView" ✔
selector string ✔
block "start" | "center" | "end" | "nearest"
inline "start" | "center" | "end" | "nearest"
Field Type Required Default Description
type "dispatch" ✔
selector string ✔
event string ✔
bubbles boolean
Field Type Required Default Description
type "focus" ✔
selector string ✔
Field Type Required Default Description
type "blur" ✔
selector string ✔
Field Type Required Default Description
type "selectText" ✔
selector string ✔
Field Type Required Default Description
type "clear" ✔
selector string ✔
Field Type Required Default Description
type "setText" ✔
selector string ✔
value string ✔
Field Type Required Default Description
type "setHtml" ✔
selector string ✔
value string ✔
Field Type Required Default Description
type "remove" ✔
selector string ✔
Field Type Required Default Description
type "setAttribute" ✔
selector string ✔
name string ✔
value string ✔
Field Type Required Default Description
type "removeAttribute" ✔
selector string ✔
name string ✔
Field Type Required Default Description
type "addClass" ✔
selector string ✔
class string ✔
Field Type Required Default Description
type "removeClass" ✔
selector string ✔
class string ✔
Field Type Required Default Description
type "toggleClass" ✔
selector string ✔
class string ✔
Field Type Required Default Description
type "setStyle" ✔
selector string ✔
props object ✔
Field Type Required Default Description
type "insert" ✔
selector string ✔
position "beforebegin" | "afterbegin" | "beforeend" | "afterend" ✔
html string ✔
Field Type Required Default Description
type "setValue" ✔
selector string ✔
value string ✔
Field Type Required Default Description
type "check" ✔
selector string ✔
checked boolean ✔
Field Type Required Default Description
type "selectOption" ✔
selector string ✔
value string ✔
Field Type Required Default Description
type "replaceText" ✔
selector string ✔
pattern string ✔
replacement string ✔
flags string
Field Type Required Default Description
type "evaluate" ✔
script string ✔

One of 6 variants:

Field Type Required Default Description
kind "typing" ✔
text string ✔
x number 0
y number 0
fontSize number
fontFamily string
kern boolean
color string
delay number
speed number
mode "type" | "paste"
jitter number
wrapWidth number
mask object
bgColor string
bgWidth number
bgHeight number
caret boolean | object
mistakes number | array
mistakeThinkMs number
holdToFrameEnd boolean
endAt number
anchor object
maxWidth string | number
Field Type Required Default Description
width number
height number
color string

One of 2 variants:

Field Type Required Default Description
selector string ✔
at "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
dx number
dy number
baseline boolean
Field Type Required Default Description
kind "tap" ✔
x number 0
y number 0
delay number
endAt number
anchor object
Field Type Required Default Description
selector string ✔
at "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
dx number
dy number
Field Type Required Default Description
kind "svg" ✔
src string ✔
x number 0
y number 0
width number ✔
height number ✔
enter object
exit object
anchor object
delay number
endAt number
Field Type Required Default Description
from "top" | "bottom" | "left" | "right" ✔
duration number ✔
easing string
delay number
Field Type Required Default Description
from "top" | "bottom" | "left" | "right" ✔
duration number ✔
easing string
delay number
Field Type Required Default Description
selector string ✔
at "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
dx number
dy number
Field Type Required Default Description
kind "blink" ✔
x number 0
y number 0
width number ✔
height number ✔
periodMs number
color string
fillOpacity number
radius number
delay number
endAt number
anchor object
Field Type Required Default Description
selector string ✔
at "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
dx number
dy number
Field Type Required Default Description
kind "shine" ✔
x number 0
y number 0
width number 0
height number 0
delay number
duration number
color string
opacity number
bandWidth number
skewDeg number
radius number
repeat number | string
repeatPeriodMs number
endAt number
anchor object
Field Type Required Default Description
selector string ✔
at "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
dx number
dy number
Field Type Required Default Description
kind "interact" ✔
x number 0
y number 0
width number 0
height number 0
treatment "hover" | "focus" | "press"
fill string
fillOpacity number
ring string
ringWidth number
radius number
scale number
delay number
duration number
holdMs number
releaseMs number
repeat number | string
repeatPeriodMs number
endAt number
anchor object
Field Type Required Default Description
selector string ✔
at "top-left" | "top" | "top-right" | "left" | "center" | "right" | "bottom-left" | "bottom" | "bottom-right"
dx number
dy number

One of 2 variants:

Field Type Required Default Description
shape "bar" | "block" | "underscore" Caret shape (docs/97). Default bar.
color string Caret color. Default #111111.
Field Type Required Default Description
selector string ✔
shape "bar" | "block" | "underscore"
color string
barWidthPx number
blinkMs number
selectionColor string
events object | object | object | object | object[] ✔
persist boolean

One of 5 variants:

Field Type Required Default Description
type "park" ✔
at number ✔
charOffset integer ✔
selector string
Field Type Required Default Description
type "move" ✔
at number ✔
charOffset integer ✔
selector string
Field Type Required Default Description
type "hide" ✔
at number ✔
Field Type Required Default Description
type "select" ✔
at number ✔
charStart integer ✔
charEnd integer ✔
sweepMs number
color string
selector string
Field Type Required Default Description
type "clearSelection" ✔
at number ✔