Skip to content

API Reference

Complete API documentation for all Ripl packages, auto-generated from TypeScript source.

@ripl/core

  • Elements — Built-in shape elements for 2D rendering. (57 exports)
  • Core — Element, Shape, Group, Scene, Renderer, and EventBus — the foundational classes. (49 exports)
  • Context — Canvas rendering context and low-level drawing API. (30 exports)
  • Animation & Easing — Transition utilities and easing functions for smooth animations. (21 exports)
  • Interpolators — Value interpolation factories for animating between states. (20 exports)
  • Scales — Data-to-visual mapping functions: continuous, band, logarithmic, and more. (26 exports)
  • Color — Color parsing, serialization, and utility functions. (30 exports)
  • Math & Geometry — Geometry utilities, trigonometry helpers, and bounding box structures. (27 exports)
  • Gradients — CSS gradient string parsing and serialization. (9 exports)
  • Task — Cancellable promise with AbortController integration. (6 exports)

@ripl/charts

  • Chart Base & Options — Base Chart class, shared options, axis configuration, and chart infrastructure. (41 exports)
  • Charts — All chart types: Bar, Line, Area, Pie, Scatter, and more. (71 exports)
  • Chart Elements — Specialized rendering elements for charts (Ribbon, SankeyLink). (8 exports)

@ripl/svg

  • SVG Context — SVG rendering context with virtual DOM reconciliation. (8 exports)

@ripl/3d

  • Context3D — 3D rendering context extending CanvasContext with projection. (4 exports)
  • Camera — Reactive camera system with orbit, pan, and zoom. (6 exports)
  • Shapes — Built-in 3D shapes: Cube, Sphere, Cylinder, Cone, Plane, Torus. (24 exports)
  • Shading — Flat shading utilities based on face normals and light direction. (3 exports)
  • Math — 3D math utilities: vectors, matrices, and projections. (30 exports)
  • Interpolators — Vector3 and 3D-specific interpolation. (1 exports)

@ripl/utilities

  • Collections — Array and Set helpers: join, group, intersect, difference, map range. (20 exports)
  • Type Guards — Runtime type checking predicates. (10 exports)
  • DOM — DOM element creation and query utilities. (7 exports)
  • Function, String, Number & Object — Miscellaneous utility functions. (17 exports)
  • Types — Shared TypeScript type definitions. (12 exports)