justdom-three

A reactive Three.js scene graph, built on justdom-signal with the same operator vocabulary as justdom-core — $, set, children, effects, on — except targeting THREE.Object3D instead of DOM nodes. No VDOM, no diffing: every reactive value is wired directly to a Three.js mutation through a signal effect. On top of the scene graph it has the WebXR session lifecycle, controller and hand rays with pointer events on the objects they hit, and a portal that projects ordinary DOM into the scene as panels a ray can click.

Installation

npm install justdom-three justdom-signal three

three and justdom-signal are peer dependencies. The package has three entry points: justdom-three, justdom-three/page for the parts that import nothing from three.js, and justdom-three/svg for the inline SVG plugin.

Usage

import * as THREE from "three";
import { render, $, children, getScene, useFrame } from "justdom-three";
import { effects, effectsOnly, useEffects } from "justdom-signal";

const Scene = effectsOnly((ctx) => {
  useEffects(getScene(ctx), [
    children(
      $(new THREE.AmbientLight(0xffffff, 1)),
      $(new THREE.Mesh(new THREE.BoxGeometry(), new THREE.MeshStandardMaterial()), [
        effects((cube) => {
          useFrame(ctx, () => {
            cube.rotation.y += 0.01;
          });
        }),
      ]),
    ),
  ]);
});

render(Scene).subscribe((renderer) => {
  document.body.appendChild(renderer.domElement);
});

Learn more

• The guide: Rendering a scene, Headset sessions, Pointing and grabbing, DOM panels and Writing CSS for a panel.
• The API reference in six pages: rendering and sessions, input, panels, what a panel draws, and the theming and outlines modes for working on a panel's CSS.

License

MIT — see LICENSE.

---

This page is the package's README.