collaboration Drawing app
 
 
 
Go to file
huppy-bot[bot] 933cc6fb77 Update CHANGELOG.md [skip ci] 2024-04-24 15:30:48 +00:00
.github "Soft preload" icons (#3507) 2024-04-17 10:57:08 +00:00
.husky Add yarn immutable check to pre-commit. (#3218) 2024-03-20 11:45:28 +00:00
.yarn/patches
apps Update CHANGELOG.md [skip ci] 2024-04-24 15:30:48 +00:00
assets Stickies: release candidate (#3249) 2024-04-14 18:40:02 +00:00
config "Soft preload" icons (#3507) 2024-04-17 10:57:08 +00:00
packages Update CHANGELOG.md [skip ci] 2024-04-24 15:30:48 +00:00
scripts v2.1.x: fix 2024-04-24 16:27:19 +01:00
templates styling: make dotcom and examples site have consistent font styling (#3271) 2024-03-27 09:44:22 +00:00
.dockerignore
.eslintignore
.eslintplugin.js
.eslintrc.js Export `createShapePropsMigrationIds` (#3594) 2024-04-24 16:20:27 +01:00
.gitignore New migrations again (#3220) 2024-04-15 12:53:42 +00:00
.ignore
.prettierignore tooling: prettier ignore pr template (#3210) 2024-03-20 09:56:38 +00:00
.prettierrc
.yarnrc.yml
CHANGELOG.md Update CHANGELOG.md [skip ci] 2024-04-24 15:30:48 +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 css more shapes that need transparent behavior (#3497) 2024-04-16 15:19:30 +00:00
TRADEMARKS.md
lazy.config.ts
lerna.json Update CHANGELOG.md [skip ci] 2024-04-24 15:30:48 +00:00
package.json New migrations again (#3220) 2024-04-15 12:53:42 +00:00
yarn.config.cjs
yarn.lock Fix deploy script (#3550) 2024-04-22 15:33:25 +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.