Getting Started
Installation
Install Telva and understand runtime requirements before integrating the editor.
Installation
Package install
npm i telvaPeer dependencies
telva expects:
react >= 16.8react-dom >= 16.8
Runtime model
Telva is a browser editor component that relies on DOM and pointer events. In server-rendered frameworks, render it on the client side.
Sizing requirement
<Telva /> renders an absolute-positioned layout that fills its parent (width: 100%, height: 100%).
Always provide a container with explicit size:
import { Telva } from 'telva'
export function EditorShell() {
return (
<div style={{ position: 'relative', width: '100vw', height: '100vh' }}>
<Telva />
</div>
)
}If parent height collapses, the editor can appear blank even though it mounted correctly.
Workspace scripts (monorepo)
From repository root:
yarn
yarn start
yarn start:www
yarn build
yarn testThese scripts are orchestrated with Turbo and run across apps, examples, and packages.