Compatibility

Supported
Pele ^1.7.0 (peer dependency). Tested with 1.7 (the docs site), 1.8 and 1.9.
Diagram types Flowcharts and sequence diagrams (diagram types)
Browsers Current browsers with the Web Animations API, IntersectionObserver and matchMedia (Chrome, Edge, Firefox, Safari). Without IntersectionObserver the intro plays at once.
Module format ESM only
Server rendering Not applicable: mount on the client (recipes)

What pele-animate depends on in Pele

pele-animate reads the SVG Pele produces. It selects on these class names and attributes:

.pele-node, .pele-edge, .pele-edge-label, .pele-marker, .pele-cluster-label, .pele-icon, .pele-lifeline, .pele-actor-participant, and the data-id attribute.

Pele has not promised these are stable across releases (the question is open upstream). That is why Pele is a peer dependency: upgrade it deliberately, and re-check your diagrams afterwards. The repository's tests render every documentation example, which catches parse errors but not visual changes.

Known limits

  • Sequence-diagram participants ignore @{ icon }.
  • Step mode is browser-tested on flowcharts only.
  • Glyph art is square-boxed; wide art is drawn as a wide shape inside the square.

Edit this page on GitHub · View as Markdown