# tldraw **Repository Path**: anydev/tldraw ## Basic Information - **Project Name**: tldraw - **Description**: tldraw 是一个轻量级的绘图软件.基于 React+TypeScript 开发的高性能无限画布开源 SDK,同时提供开箱即用的独立在线协作白板应用,主打极简流畅的交互、原生多人实时协同、高度可定制扩展,可直接私有化内网部署,用来快速搭建流程图、架构图、思维导图、原型草稿、安全拓扑分析类可视化画布场景。 - **Primary Language**: TypeScript - **License**: Not specified - **Default Branch**: main - **Homepage**: https://www.oschina.net/p/tldraw - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 7 - **Created**: 2026-06-17 - **Last Updated**: 2026-06-17 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README
tldraw

npm npm downloads Discord Ask DeepWiki

Build infinite canvas apps in React with the tldraw SDK.

Docs · Examples · Starter kits

## Feature highlights tldraw provides a feature-complete infinite canvas engine designed to be the foundation for any canvas app. Create custom shapes, tools, bindings and UI components for a custom experience. Use the default whiteboarding tool set or use the library's primitives to build entirely new shapes and interactions. - **Multiplayer** — self-hostable real-time collaboration with [`@tldraw/sync`](https://tldraw.dev/docs/sync) - **Drawing and diagramming** — pressure-sensitive drawing, geometric shapes, rich text, arrows, snapping to shapes, edge scrolling, image and video support, image export - **Runtime API** - drive the canvas at runtime with the Editor API - **Fully extensible** — custom [shapes](https://tldraw.dev/docs/shapes), [tools](https://tldraw.dev/docs/tools), [bindings](https://tldraw.dev/sdk-features/bindings), [UI components](https://tldraw.dev/sdk-features/ui-components), side effects, and event hooks - **AI integrations** — canvas primitives for [building with LLMs](https://tldraw.dev/docs/ai) - **DOM canvas** — web rendering supports anything the browser supports, including embedded websites from YouTube, Figma, GitHub, [and more](https://tldraw.dev/sdk-features/embed-shape) - **Broad support** — works in any browser across desktop, touch screens, tablets, and mobile devices ## Who's using tldraw The tldraw SDK powers canvas experiences in products from [Google](https://about.google), [Shopify](https://www.shopify.com), [BlackRock](https://www.blackrock.com), [Autodesk](https://blogs.autodesk.com/forma/2024/06/20/forma-board-collaborative-tool-for-architects/), [ClickUp](https://tldraw.dev/blog/clickup), [Replit](https://docs.replit.com/replitai/canvas), [Google Stitch](https://stitch.withgoogle.com), [Luma](https://lumalabs.ai/app), [Runway](https://runwayml.com), [Padlet](https://tldraw.dev/blog/padlet), [Mobbin](https://tldraw.dev/blog/mobbin), [Jam](https://tldraw.dev/blog/jam), [Craft](https://support.craft.do/en/write-and-edit/whiteboards), [Honeycomb](https://www.honeycomb.io/platform/canvas), [SchoolAI](https://schoolai.com/products/powerups), [Brisk](https://www.briskteaching.com/post/boost-whiteboard), [CADChat](https://cadchat.com), [bigpi](https://www.bigpi.ai), [Genio](https://genio.co), [Pollination](https://www.pollination.solutions), [Legendkeeper](https://www.legendkeeper.com), [Matilda](https://www.matilda.io), [Aries](https://aries.com/infinite), [Alai](https://getalai.com), [Dirac](https://www.diracinc.com), and many more. See our [showcase](https://tldraw.dev/showcase) for case studies on how teams build with tldraw. ## Quick start Install the tldraw package: ```bash npm i tldraw ``` Then, use the `` component in your React app: ```tsx import { Tldraw } from 'tldraw' import 'tldraw/tldraw.css' export default function App() { return (
) } ``` ## Starter kits Starter kits provide the custom shapes, tools, and user interface needed for common applications. Each kit is MIT-licensed. Hack together a prototype, build out an app on top, or reference the code in a larger project. Start building with: ```bash npx create-tldraw@latest ``` - **Multiplayer** — self-hosted real-time collaboration powered by `@tldraw/sync` and Cloudflare Durable Objects, the same stack behind [tldraw.com](https://tldraw.com) - **Agent** — AI agents that read, interpret, and modify canvas content - **Workflow** — drag-and-drop node builder for automation pipelines, visual programming, and no-code platforms - **Chat** — canvas-powered AI chat where users sketch, annotate, and mark up images alongside conversations - **Image pipeline** — node-based builder for image generation pipelines - **Branching chat** — AI chat with visual branching, letting users explore and compare different conversation paths - **Shader** — WebGL shaders that respond to canvas interactions ## Local development The development server runs the examples app at `localhost:5420`. You'll need [Node.js](https://nodejs.org) `^20.0.0`. Clone the repo, then enable [corepack](https://nodejs.org/api/corepack.html) for the correct yarn version: ```bash npm i -g corepack ``` Install dependencies and start the dev server: ```bash yarn yarn dev ``` ## Documentation Documentation for the most recent release can be found on [tldraw.dev/docs](https://tldraw.dev/docs), including [reference docs](https://tldraw.dev/reference/editor/Editor). Our release notes can be found [here](https://tldraw.dev/releases). For more agent-friendly docs, see our [LLMs.txt](https://tldraw.dev/llms.txt). From 5.1.x onward, published packages also include a `DOCS.md` file with the appropriate docs-site content and a generated `RELEASE_NOTES.md` file with versioned release notes. If you or your coding agent need release notes for your installed version specifically, check these files alongside the source in your `node_modules` folder. ## Community - [Discord](https://discord.tldraw.com/?utm_source=github&utm_medium=readme&utm_campaign=sociallink) — questions, feedback, and discussion - [Twitter/X](https://twitter.com/tldraw) — news and updates - [Submit an issue](https://github.com/tldraw/tldraw/issues/new) — bug reports and feature requests ## Contributing We are not accepting contributions at this time. If you've found a bug or have a feature request, please [create an issue](https://github.com/tldraw/tldraw/issues/new/choose) and we can discuss it there. See our [contributing guide](https://github.com/tldraw/tldraw/blob/main/CONTRIBUTING.md) for details. ## License The tldraw SDK is provided under the [tldraw license](https://github.com/tldraw/tldraw/blob/main/LICENSE.md). You can use the SDK freely in development. Production use requires a [license key](https://tldraw.dev/pricing). Visit [tldraw.dev](https://tldraw.dev) to learn more. ## Trademarks Copyright (c) 2024-present tldraw Inc. The tldraw name and logo are trademarks of tldraw. Please see our [trademark guidelines](https://github.com/tldraw/tldraw/blob/main/TRADEMARKS.md) for info on acceptable usage. ## Contributors ## Star history Star History Chart