API reference
- TypeScript API (
@dotloomjs/sdk,@dotloomjs/react) — generated with TypeDoc from the published type declarations. - Rust API — rustdoc of the published crates:
dotloom_geometry,dotloom_constraints,dotloom_document,dotloom_scene,dotloom_engine,dotloom_io,dotloom_render.
Main TypeScript entry points
| Export | What it is |
|---|---|
createEditor(container, options) | engine + viewport + tools + input in one call |
DotloomEngine | asynchronous engine client (Worker): transactions, undo/redo, files, queries, drags, plugins |
createNodeEngine() (@dotloomjs/sdk/node) | in-thread engine for Node.js |
Viewport | wgpu canvas: camera, overlays, themes, grid, PNG export, loss recovery |
EditorCore, bindDom | DOM-free tool/selection/snapping/shortcut logic and its DOM binding |
PluginHost, DotloomPlugin | plugin lifecycle and extension points |
Autosave, IndexedDbStorage, MemoryStorage, StorageAdapter | storage |
decodeSceneDelta, SceneStore | the scene contract for custom renderers |
formatLength, parseLength, formatDuration, … | display units |
DotloomEditor, panels, hooks (@dotloomjs/react) | the reference editor |
Versions
Three versions are independent: the package version (semver), the Worker protocol version (PROTOCOL_VERSION, checked when an engine starts) and the document schema version (in every file). engine.capabilities reports the engine version, protocol, schema, .dotl format and scene format versions.