History

David Sheldrick 12fe9d9c4e Allow dismissing dialogs by clicking backdrop (#2497 ) Closes #2496 Radix is supposed to handle this behaviour for us. Something we are doing related to dom structure or css is preventing that from happening, but I spent a while debugging and didn't get to the bottom of it. For now let's just implement it ourselves and we can revisit making radix behave properly later? ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Release Notes - Allows dismissing dialogs by clicking the backdrop.		2024-01-18 14:53:16 +00:00
..
api	Add docs (#2470 )	2024-01-15 12:33:15 +00:00
scripts	tldraw zero - package shuffle (#1710 )	2023-07-17 21:22:34 +00:00
src	Allow dismissing dialogs by clicking backdrop (#2497 )	2024-01-18 14:53:16 +00:00
api-extractor.json	transfer-out: transfer out	2023-04-25 12:01:25 +01:00
api-report.md	Add docs (#2470 )	2024-01-15 12:33:15 +00:00
CHANGELOG.md	Update CHANGELOG.md [skip ci]	2024-01-10 12:03:59 +00:00
LICENSE.md	Change licenses to tldraw (#2167 )	2023-12-19 10:41:01 +00:00
package.json	Bump Yarn to 4.0.2 and add version constraints (#2481 )	2024-01-18 11:09:17 +00:00
README.md	add descriptions to examples (#2375 )	2023-12-27 17:17:18 +00:00
setupTests.js	[fix] Asset versions (#2389 )	2023-12-31 11:07:38 +00:00
tsconfig.json	tldraw zero - package shuffle (#1710 )	2023-07-17 21:22:34 +00:00

README.md

@tldraw/tldraw

This package contains the source code for the tldraw library. Learn more at our docs site: tldraw.dev.

Installation

Install the @tldraw/tldraw package using @canary for the latest canary release. (Or @alpha for the latest alpha release.)

yarn add @tldraw/tldraw@canary
# or
npm install @tldraw/tldraw@canary
# or
pnpm i @tldraw/tldraw@canary

Then start the local development server.

yarn dev
# or
npm run dev
# or
pnpm dev

Usage

An extremely minimal usage (without our UI) might look like this:

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

export default function () {
	return <Tldraw/>
}

See the examples folder for more examples.

Community

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

Distributions

You can find tldraw on npm here.

Contribution

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

License

The tldraw source code and its distributions are provided under the tldraw license. This license does not permit commercial use.

If you wish to use this project in commercial product, you need to purchase a commercial license. Please contact us at hello@tldraw.com for more inforion about obtaining a commercial license.

Trademarks

Contact

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