Core API

The root entry is framework-agnostic and has no React dependency.

prepareSvg

prepareSvg(source, options) reads, validates, sanitizes, namespaces IDs and returns a detached PreparedSvg.

const prepared = await prepareSvg(file, {
  trust: "sanitize",
  maxBytes: 5 * 1024 * 1024,
  signal: abortController.signal,
});

animateSvg(svg, options) is the low-level caller-owned node API. It snapshots all temporary attributes and returns a synchronous controller.

const controller = animateSvg(svg, {
  preset: "stagger",
  autoplay: false,
  stagger: 80,
});
controller.play();
await controller.finished;

mountSvgMotion(container, source, options) combines preparation, mounting and motion. Its instance destroy() also removes the appended SVG.