--- name: tldraw-efeb019b4300 description: >- tldraw is a React SDK for building infinite-canvas apps — whiteboards, diagram editors, and visual tools — with a shape system, camera controls, snapshots, and real-time multiplayer. Use when embedding a collaborative canvas or whiteboard in a React app, defining custom shapes, driving the editor programmatically, exporting the canvas to an image, or adding multiplayer sync. Note: production use requires a tldraw license key. license: Apache-2.0 compatibility: "tldraw SDK 5 with React 18.2+ or 19.2.1+. Production use requires a tldraw license key." metadata: author: terminal-skills version: "1.1.0" category: development tags: "canvas, whiteboard, drawing, collaboration, react" repository: https://github.com/tldraw/tldraw --- # tldraw — Infinite Canvas SDK ## Overview tldraw is a React SDK for building infinite-canvas experiences: whiteboards, diagram editors, and visual tools. You drop in the `` component, extend it with custom shapes that render as React/HTML or SVG, drive the canvas through the `Editor` API, persist state with snapshots, and add real-time collaboration with `@tldraw/sync`. ## Instructions ### Basic Setup Install and embed a full-featured canvas. The container needs explicit dimensions, and you must import the stylesheet. ```tsx // src/components/Whiteboard.tsx import { Tldraw } from "tldraw"; import "tldraw/tldraw.css"; export function Whiteboard() { return (
{/* persistenceKey saves to the browser's IndexedDB and syncs across tabs */}
); } ``` ### Custom Shapes Model your domain with a shape util. `BaseBoxShapeUtil` gives you a resizable box; `component()` renders it (full React is allowed), `getIndicatorPath()` returns the selection outline as a `Path2D` (it replaced the JSX `indicator()` in SDK 5). ```tsx // src/shapes/TaskCardShapeUtil.tsx import { BaseBoxShapeUtil, HTMLContainer, T, TLShape } from "tldraw"; // Register the props under the shape's type name (a global registry: keep the name unique). declare module "tldraw" { export interface TLGlobalShapePropsMap { "task-card": { title: string; assignee: string; priority: "low" | "high"; w: number; h: number }; } } type TaskCard = TLShape<"task-card">; export class TaskCardShapeUtil extends BaseBoxShapeUtil { static override type = "task-card" as const; static override props = { // validated by the store title: T.string, assignee: T.string, priority: T.literalEnum("low", "high"), w: T.number, h: T.number, }; getDefaultProps(): TaskCard["props"] { return { title: "New task", assignee: "Unassigned", priority: "low", w: 280, h: 140 }; } component(shape: TaskCard) { const border = shape.props.priority === "high" ? "#ef4444" : "#4ade80"; return ( {shape.props.title}
{shape.props.assignee}
 ); } getIndicatorPath(shape: TaskCard) { const path = new Path2D(); path.roundRect(0, 0, shape.props.w, shape.props.h, 8); return path; } } ``` Register it on the component: ```tsx import { Tldraw } from "tldraw"; import { TaskCardShapeUtil } from "./shapes/TaskCardShapeUtil"; ; ``` ### Driving the Editor API Grab the `Editor` with the `useEditor()` hook (inside the `` tree) or from the `onMount` callback. Create/update use singular and plural forms. ```tsx // src/hooks/useCanvasActions.ts import { useEditor } from "tldraw"; export function useCanvasActions() { const editor = useEditor(); function addTaskCard(title: string, x: number, y: number) { editor.createShape({ type: "task-card", x, y, props: { title } }); } // Export selection (or whole page) to a PNG blob. // getSvg() was removed — use toImage(), getSvgString(), or getSvgElement(). async function exportPng() { const ids = [...editor.getCurrentPageShapeIds()]; if (ids.length === 0) return null; const { blob } = await editor.toImage(ids, { format: "png", scale: 2, background: true }); return blob; } function zoomToFit() { editor.zoomToFit({ animation: { duration: 300 } }); } return { addTaskCard, exportPng, zoomToFit }; } ``` ### Snapshots (save & restore) `getSnapshot`/`loadSnapshot` are top-level functions imported from `tldraw`. `getSnapshot` returns `{ document, session }`; persist the `document` part. ```typescript // src/persistence/snapshots.ts import { Editor, getSnapshot, loadSnapshot } from "tldraw"; export async function saveToServer(editor: Editor, documentId: string) { const { document } = getSnapshot(editor.store); await fetch(`/api/boards/${documentId}`, { method: "PUT", headers: { "Content-Type": "application/json" }, body: JSON.stringify(document), }); } export async function loadFromServer(editor: Editor, documentId: string) { const document = await fetch(`/api/boards/${documentId}`).then((r) => r.json()); loadSnapshot(editor.store, { document }); } // Debounce auto-save — canvas changes fire rapidly while drawing. export function setupAutoSave(editor: Editor, documentId: string) { let timer: ReturnType; return editor.store.listen( () => { clearTimeout(timer); timer = setTimeout(() => saveToServer(editor, documentId), 2000); }, { source: "user", scope: "document" } ); } ``` ### Multiplayer with @tldraw/sync Official real-time collaboration uses the `useSync` hook from `@tldraw/sync` talking to a websocket backend you host (tldraw ships a Cloudflare Durable Objects server template). For a prototype, `useSyncDemo({ roomId })` connects to tldraw's demo server with temporary rooms. There is no `@tldraw/yjs` package. ```tsx // src/components/MultiplayerBoard.tsx import { Tldraw, TLAssetStore, uniqueId } from "tldraw"; import { useSync } from "@tldraw/sync"; // `assets` is required: images and videos go to your own storage, the document keeps the URL. // The /api/uploads and /api/connect routes are the ones tldraw's sync-cloudflare template serves. const assets: TLAssetStore = { async upload(_asset, file) { const name = `${uniqueId()}-${file.name}`.replace(/[^a-zA-Z0-9.]/g, "-"); const res = await fetch(`/api/uploads/${name}`, { method: "POST", body: file }); if (!res.ok) throw new Error(`Failed to upload asset: ${res.statusText}`); return { src: `/api/uploads/${name}` }; }, resolve: (asset) => asset.props.src, }; export function MultiplayerBoard({ roomId }: { roomId: string }) { // useSync manages the websocket and reconciles document + presence state. // An http(s) URI is upgraded to ws(s). const store = useSync({ uri: `${window.location.origin}/api/connect/${roomId}`, assets }); return (
); } ``` ## Installation ```bash npm install tldraw # core SDK (includes the Editor and default UI) # For multiplayer npm install @tldraw/sync ``` ## Examples ### Example 1: Embed a whiteboard with a custom shape **User request:** ``` Add a tldraw canvas to our React dashboard and give it a "task-card" shape so users can drop task cards on the board. ``` The agent runs `npm install tldraw`, creates a `Whiteboard` component that imports `tldraw/tldraw.css` and renders `` inside a `position: fixed; inset: 0` container, and defines `TaskCardShapeUtil extends BaseBoxShapeUtil`. Result: an infinite canvas that persists to IndexedDB, with draggable task cards whose React content stays interactive. ### Example 2: Export the current board as a PNG **User request:** ``` Add a "Download PNG" button that exports whatever is on the tldraw canvas. ``` The agent wires a button to `editor.toImage([...editor.getCurrentPageShapeIds()], { format: "png", scale: 2, background: true })`, turns the returned `blob` into an object URL, and triggers a download. Result: a 2x-resolution PNG of the whole page; if the page is empty the handler returns early. ## Guidelines 1. **Production needs a license key** — since SDK 4, running tldraw in production (HTTPS, non-loopback host, `NODE_ENV=production`) requires a license key; without one the editor stops rendering after five seconds. Commercial use needs a commercial license (no watermark; a free 100-day trial key exists). The free hobby license is for non-commercial projects, is granted on request and keeps the "made with tldraw" watermark. Development needs no key. Pass the key with the `licenseKey` prop on `` or an env var such as `VITE_TLDRAW_LICENSE_KEY`. 2. **Container needs dimensions** — tldraw fills its parent; give it explicit size (e.g. `position: fixed; inset: 0`) or it renders at zero height. 3. **Custom shapes for domain data** — represent tasks, nodes, or cards as shapes instead of forcing everything into draw/text. 4. **Always implement `getIndicatorPath()`** — it returns the selection/hover outline of a custom shape; SDK 5 no longer renders the JSX `indicator()`. 5. **`getSvg()` was removed** — use `editor.toImage()` (blob), or `editor.getSvgString()` / `editor.getSvgElement()` for vector output. SVG exports are resolution-independent and smaller than raster. 6. **Persist the `document` snapshot** — `getSnapshot(editor.store)` returns `{ document, session }`; store `document` on your backend, keep `session` per-client if you want to restore the viewport. 7. **Debounce auto-save** — `editor.store.listen` fires on every change; save every 2–3 seconds, not per event. 8. **Multiplayer is `@tldraw/sync`, not Yjs** — the old community Yjs example is not a maintained package; use `useSync` against a websocket server. --- Source attribution: TerminalSkills Original project: https://github.com/TerminalSkills/skills/blob/3bfbf7f76459d89422eddc0e5f572ad0e6c393c9/skills/tldraw/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Dave AI. ## Upstream license notice Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to the Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by the Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding any notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS Copyright 2025 Terminal Skills Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Dave AI resource metadata Creator / publisher: TerminalSkills Original project: https://github.com/TerminalSkills/skills/blob/3bfbf7f76459d89422eddc0e5f572ad0e6c393c9/skills/tldraw/SKILL.md Attribution basis: Source repository record Fields of work: Design, Development & Engineering, Product Management Roles: Frontend Developer, Product Manager, UX Designer Specialties: API, Cross Platform, Frontend Tools: Tldraw Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 8ab8b4851c8cc2d08377843b41d9cc0ae07d883a891e3ddf04b9f21913c4daef