How shanorigin/shantanujs works
ShantanuJS is a browser-based 2D graphics and animation library that projects a matrix-driven scene onto SVG. The principal workflow is: consumer creates shapes and adds them to a Canvas; scene ownership and render-node state track changes; the frame Engine resolves transforms and submits nodes to the SVG renderer; pointer events are dispatched through the event system. Other documented capabilities include groups, media, filters, affine transforms, animation, and typed APIs. Relationships below rely on README statements and the cited excerpts; several subsystem implementations were not sampled.
Main entry points: render-node.ts Render node · canvas.ts Canvas · index.ts Public API · engine.ts Frame engine
Components 22
Public graphics API
- Public API
src/index/index.ts - Canvas
src/systems/canvas/canvas.ts - Shapes and media
src/graphics/shapes - Group
src/graphics/container/group/group.ts - Type contracts
src/models/interfaces
Scene and state
- Scene model
src/systems/scene/scene-model.ts - Render node
src/graphics/render-node/render-node.ts - Graphics model
src/core/graphics-model/graphics-model.ts - Property definitions
src/property-definitions - Internal access keys
src/internal/keys - Error diagnostics
src/errors/core/diagnostics/error-context.ts
Frame and rendering
- Frame engine
src/systems/engine/engine.ts - Renderer dispatch
src/systems/renderer/renderer.ts - SVG renderer
src/systems/renderer/svg/svg-renderer/svg-renderer.ts - SVG DOM
- Event system
src/systems/event/event-system.ts
Graphics capabilities
- Transform component
src/components/transformation/transformation.ts - Animation component
src/components/animation/animation.ts - SVG filters
src/components/filter/filters.ts - Affine and matrix math
src/utils/math - Color utilities
src/utils/colors/colors.ts
Other components
- Application code
Connections 31
- Application code → Public API: imports
README.md - Application code → Canvas: creates
README.md - Application code → Shapes and media: creates
README.md - Application code → Canvas: adds shapes
README.md - Public API → Canvas: exports
src/index/index.ts - Public API → Shapes and media: exports
src/index/index.ts - Public API → Group: exports
src/index/index.ts - Canvas → Scene model: initializes
src/systems/canvas/canvas.ts - Canvas → Renderer dispatch: initializes
src/systems/canvas/canvas.ts - Canvas → Frame engine: starts
README.md - Canvas → Event system: connects pointer input
README.md - Scene model → Render node: owns scene nodes
README.md - Render node → Graphics model: holds model state
src/graphics/render-node/render-node.ts - Render node → Transform component: creates component
src/graphics/render-node/render-node.ts - Render node → Animation component: creates component
src/graphics/render-node/render-node.ts - Render node → SVG filters: exposes component
README.md - Render node → Property definitions: uses definitions
src/graphics/render-node/render-node.ts - Render node → Internal access keys: uses access keys
src/graphics/render-node/render-node.ts - Group → Render node: extends model
src/graphics/container/group/group.ts - Group → Transform component: uses transforms
src/graphics/container/group/group.ts - Transform component → Affine and matrix math: parses affine expressions
src/components/transformation/transformation.ts - Frame engine → Scene model: reads scene
src/systems/engine/engine.ts - Frame engine → Affine and matrix math: multiplies matrices
src/systems/engine/engine.ts - Frame engine → Renderer dispatch: renders nodes
README.md - Renderer dispatch → SVG renderer: dispatches rendering
README.md - SVG renderer → SVG DOM: patches attributes
README.md - Canvas → Event system: dispatches pointers
src/systems/canvas/canvas.ts - Event system → Render node: targets nodes
README.md - Scene model → Color utilities: uses colors
src/systems/scene/scene-model.ts - Type contracts → Canvas: specifies API
- Error diagnostics → Graphics model: supports errors