Telva Documentation
Technical documentation for integrating, controlling, and extending Telva in production apps.
Telva Documentation
Telva is a React drawing editor package (telva) built on top of a reusable rendering engine (telva-core) and geometry utilities (telva-vec, telva-intersect, telva-curve).
This documentation is focused on practical implementation:
- integrate
<Telva />into different frontend contexts - control editor state with props or imperative APIs
- build export and multiplayer workflows
- extend the system with custom React components and custom shape utilities
Package map
| Package | Purpose |
|---|---|
telva | High-level embeddable editor component and app API |
telva-core | Low-level renderer, shape util base class, pointer and event types |
telva-vec | Vector math primitives for points, distances, and transforms |
telva-intersect | Geometry intersection/hit-testing helpers |
telva-curve | Curve and spline helpers for drawing/path tools |
Suggested reading path
- Getting Started for install + first render
- Integration for real app patterns (Next.js, controlled mode, export, multiplayer)
- Reference for props, callbacks, and command APIs
- Extension for custom registry entries and shape utilities
- Operations for file workflows and troubleshooting
Source of truth
All examples and API notes in this documentation were derived from the current repository implementation:
packages/telva/srcandpackages/telva/dist/*.d.tspackages/core/dist/*.d.tsexamples/telva-example/srcexamples/core-example/srcexamples/core-example-advanced/src