collaboration Drawing app
 
 
 
Go to file
Steve Ruiz 4d19b78ca4 Update test-text.spec.ts 2024-04-14 14:54:53 +01:00
.github use native structuredClone on node, cloudflare workers, and in tests (#3166) 2024-03-18 17:16:09 +00:00
.husky Add yarn immutable check to pre-commit. (#3218) 2024-03-20 11:45:28 +00:00
.yarn/patches
apps Update test-text.spec.ts 2024-04-14 14:54:53 +01:00
assets Simplify RTL 2024-04-04 22:49:28 +01:00
config React-powered SVG exports (#3117) 2024-03-25 14:16:55 +00:00
packages Update test-text.spec.ts 2024-04-14 14:54:53 +01:00
scripts [internal] Add license report scripts (#2751) 2024-04-01 13:36:40 +00:00
templates styling: make dotcom and examples site have consistent font styling (#3271) 2024-03-27 09:44:22 +00:00
.dockerignore
.eslintignore use native structuredClone on node, cloudflare workers, and in tests (#3166) 2024-03-18 17:16:09 +00:00
.eslintplugin.js
.eslintrc.js use native structuredClone on node, cloudflare workers, and in tests (#3166) 2024-03-18 17:16:09 +00:00
.gitignore [internal] Add license report scripts (#2751) 2024-04-01 13:36:40 +00:00
.ignore [dx] Allow vscode to search inside md files by default (#3105) 2024-03-11 14:08:04 +00:00
.prettierignore tooling: prettier ignore pr template (#3210) 2024-03-20 09:56:38 +00:00
.prettierrc
.yarnrc.yml [dx] Allow vscode to search inside md files by default (#3105) 2024-03-11 14:08:04 +00:00
CHANGELOG.md Update CHANGELOG.md [skip ci] 2024-02-29 18:28:45 +00:00
CLA.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE.md
README.md conditionally use star-history dark theme (#3461) 2024-04-14 07:45:22 +00:00
RELEASES.md Add release docs (#3158) 2024-03-17 13:28:18 +00:00
TRADEMARKS.md
lazy.config.ts fix refresh-assets cache inputs 2024-02-29 18:03:10 +00:00
lerna.json Show a broken image for files without assets (#2990) 2024-03-01 18:16:27 +00:00
package.json [internal] Add license report scripts (#2751) 2024-04-01 13:36:40 +00:00
yarn.config.cjs
yarn.lock Bump the npm_and_yarn group across 1 directory with 1 update (#3348) 2024-04-04 07:34:07 +00:00

README.md

tldraw

Welcome to the public monorepo for tldraw. tldraw is a library for creating infinite canvas experiences in React. It's the software behind the digital whiteboard tldraw.com.

Installation

npm i tldraw

Usage

import { Tldraw } from 'tldraw'
import 'tldraw/tldraw.css'

export default function App() {
	return (
		<div style={{ position: 'fixed', inset: 0 }}>
			<Tldraw />
		</div>
	)
}

Learn more at tldraw.dev.

Local development

The local development server will run our examples app. The basic example will show any changes you've made to the codebase.

To run the local development server, first clone this repo.

Install dependencies:

yarn

Start the local development server:

yarn dev

Open the example project at localhost:5420.

License

tldraw's source code and distributed packages are provided under the non-commercial tldraw license.

This license does not permit commercial use. If you wish to use tldraw in a commercial product or enterprise, you will need to purchase a commercial license. To obtain a commercial license, please contact us at sales@tldraw.com.

To learn more, see our license page.

Trademarks

The tldraw name and logo are trademarks of tldraw. Please see our trademark guidelines for info on acceptable usage.

Community

Have questions, comments or feedback? Join our discord or start a discussion.

Contribution

Please see our contributing guide. Found a bug? Please submit an issue.

Contributors

Star History

Star History Chart

Contact

Find us on Twitter at @tldraw or email sales@tldraw.com. You can also join our discord for quick help and support.