Updated the documentation for the `<html>` element by removing obsolete examples related to scene identity and layout practices. This change streamlines the content, focusing on the current best practices for using `<html>` in JSX, while ensuring clarity and relevance for users.
4.5 KiB
<html>
An element whose children are real HTML: the browser lays them out at the element's box size and the result is drawn into the box via the html-in-canvas API. dapi always drives the Diffusion Studio Electron app, which ships with this API enabled, so <html> is always available — reach for it liberally. It is the recommended way to build motion graphics, overlays, and any UI-heavy content: styled cards, tables, code blocks, flex/grid layouts — anything painful to assemble from <rect> and <text>.
Drive the markup with an anime.js timeline and it stays frame-accurate: build the timeline paused, then seek it from the useTicker playhead so it follows scrubbing and exports rather than the wall clock.
import { createTimeline } from "animejs";
import { useTicker } from "@diffusionstudio/jsx";
import { createEffect } from "solid-js";
export default function Intro() {
const { time } = useTicker();
let index!: HTMLSpanElement;
let label!: HTMLSpanElement;
const tl = createTimeline({ autoplay: false })
.add(index, { opacity: [0, 1], x: [-24, 0], ease: "outQuad", duration: 400 })
.add(label, { opacity: [0, 1], ease: "outQuad", duration: 400 }, "-=200");
createEffect(() => tl.seek(time() * 1000));
return (
<rect scene="intro" width={800} height={120}>
<html x={50} y={5} width={700} height={110} cornerRadius={24} end={32}>
<div style={`display:flex;align-items:center;gap:16px;height:100%;
background:#111;color:#fff;font:500 40px Inter;padding:0 32px;`}>
<span ref={index} style="color:#7c9cff;">01</span>
<span ref={label}>Introduction</span>
</div>
</html>
</rect>
);
}
Prefer this timeline over hand-animating styles: keep the markup static and let the paused anime.js timeline own every moving value, so one seek keeps the whole host frame-accurate. A static style may be a plain string, but one spanning multiple lines has to be a template literal in braces (style={…}), as above. Reach for a derived style only for values the timeline does not drive, and write it as a style object (style={{ color: c() }}) rather than interpolating the signal into a style string, so each property updates independently.
The <html> box carries all common props. Its paint child form, <htmlPaint>, draws the same reactive HTML onto any existing filled geometry; <html> is just a <rect> that carries one.
Reactivity
The children are part of the project's Solid graph: signals in attributes and text update the live DOM, and the drawn content follows on the next frame. A dapi mount stays live, so the graph keeps running and useTicker or timers can drive the markup:
const [count, setCount] = createSignal(0);
setInterval(() => setCount((c) => c + 1), 1000);
<html width={400} height={200}>
<div style="font:700 96px Inter;color:#fff;">{count()}</div>
</html>
Props
<html> takes all common props. <htmlPaint> takes:
| Prop | Type | Default | Meaning |
|---|---|---|---|
opacity |
Animatable<number> |
1 |
Paint opacity, 0-1. |
Like all paints, <htmlPaint> stacks with siblings in document order and clips to the parent's box (including cornerRadius).
Persistence and export
The compiled module is persisted with the document: on reload, export, and dapi node capture the engine re-executes it and rebuilds the DOM content in that context. Exports wait for the browser's rendering update before sampling each frame, so the drawn HTML appears in the output; ticker-driven signals follow the playhead and animate frame-accurately. This assumes the module's structure is deterministic (Math.random()/Date.now() must not decide the shape of the tree).
Requirements and limitations
<audio>and<video>tags are rejected: media doesn't play under a paint host. Use the<audio>and<video>composition elements, which own playback and the timeline.- Cross-origin subresources (e.g. remote images, remote web fonts) are excluded from the painted output by the browser's read-back rules; use local assets and locally installed fonts (see fonts.md).
<html>is sourceless, so with noendit defaults to a 16-second duration and disappears after 16 s — a silent cutoff with no error.