Historia

alex 3a736007e5 Add image annotator example (#3147 ) This diff mostly adds an image annotator example, but also has a couple of drive-by changes: - Added a 'use-cases' category to the examples app for this style of mini-app - Add `editor.pageToViewport`, which is like `editor.pageToScreen` but works with viewport coordinates (better for `InFrontOfTheCanvas` stuff) - Prevent the chrome side-swipe-to-go-back thing in the examples app Some cool features of the image annotator: - The image cannot be unlocked, and cannot have shapes places behind it - I still need to work out a way of removing the context menu though - Anything you place outside the bounds of the image (and therefore outside the bounds of the export) will be greyed out - You can't change pages - unless you find the "move to page" action... need to fix that - The camera is constrained! It'll keep the image roughly centered on the screen. If you pick a very long thin image, you can only scroll vertically. If you pick a very big one, it'll default it to a reasonable size. ### Change Type <!-- ❗ Please select a 'Scope' label ❗️ --> - [x] `sdk` — Changes the tldraw SDK - [x] `docs` — Changes to the documentation, examples, or templates. <!-- ❗ Please select a 'Type' label ❗️ --> - [x] `feature` — New feature		2024-03-19 11:41:25 +00:00
..
api	[tiny] lift theme in style panel (#3170 )	2024-03-17 17:45:45 +00:00
scripts	tldraw_final_v6_final(old version).docx.pdf (#2998 )	2024-02-29 16:06:19 +00:00
src	Add image annotator example (#3147 )	2024-03-19 11:41:25 +00:00
CHANGELOG.md	Update CHANGELOG.md [skip ci]	2024-02-29 18:28:45 +00:00
LICENSE.md	Change licenses to tldraw (#2167 )	2023-12-19 10:41:01 +00:00
README.md	updatereadmes	2024-02-29 18:21:17 +00:00
api-extractor.json	…
api-report.md	[fix] Batch tick events (#3181 )	2024-03-18 14:33:36 +00:00
package.json	use native structuredClone on node, cloudflare workers, and in tests (#3166 )	2024-03-18 17:16:09 +00:00
setupTests.js	reactive context menu overrides (#2697 )	2024-01-31 16:35:49 +00:00
tsconfig.json	Check tsconfig "references" arrays (#2891 )	2024-02-21 13:07:53 +00:00

README.md

tldraw

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

Installation

Install the tldraw package.

npm i tldraw

Then start the local development server.

npm run dev

Usage

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

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

Visit or docs site to learn more. See our 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 sales@tldraw.com for more inforion about obtaining a commercial license.

Trademarks

Contact

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