History

David Sheldrick 356a0d1e73 [chore] refactor user preferences (#1435 ) - Remove TLUser, TLUserPresence - Add first-class support for user preferences that persists across rooms and tabs ### Change Type <!-- 💡 Indicate the type of change your pull request is. --> <!-- 🤷‍♀️ If you're not sure, don't select anything --> <!-- ✂️ Feel free to delete unselected options --> <!-- To select one, put an x in the box: [x] --> - [ ] `patch` — Bug Fix - [ ] `minor` — New Feature - [x] `major` — Breaking Change - [ ] `dependencies` — Dependency Update (publishes a `patch` release, for devDependencies use `internal`) - [ ] `documentation` — Changes to the documentation only (will not publish a new version) - [ ] `tests` — Changes to any testing-related code only (will not publish a new version) - [ ] `internal` — Any other changes that don't affect the published package (will not publish a new version) ### Test Plan 1. Add a step-by-step description of how to test your PR here. 2. - [ ] Unit Tests - [ ] Webdriver tests ### Release Notes - Add a brief release note for your PR here.		2023-05-25 09:54:29 +00:00
..
scripts	transfer-out: transfer out	2023-04-25 12:01:25 +01:00
src	[chore] refactor user preferences (#1435 )	2023-05-25 09:54:29 +00:00
api-extractor.json	transfer-out: transfer out	2023-04-25 12:01:25 +01:00
api-report.md	[refactor] restore createTLSchema (#1444 )	2023-05-24 10:48:31 +00:00
CHANGELOG.md	transfer-out: transfer out	2023-04-25 12:01:25 +01:00
LICENSE	transfer-out: transfer out	2023-04-25 12:01:25 +01:00
package.json	avoid lazy race conditions (#1364 )	2023-05-12 15:41:40 +00:00
README.md	readmes	2023-05-04 13:47:56 +01:00
setupTests.js	derived presence state (#1204 )	2023-04-27 18:03:19 +00:00
tsconfig.json	transfer-out: transfer out	2023-04-25 12:01:25 +01:00

README.md

@tldraw/tldraw

This is the alpha version of tldraw. It is very much a work in progress.

Installation

Install the @tldraw/tldraw package using @alpha for the latest alpha release.

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

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/styles-editor.css'
import '@tldraw/tldraw/styles-ui.css'

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

See the examples repo for more examples.

License

The source code in this repository (as well as our 2.0+ distributions and releases) are currently licensed under Apache-2.0. These licenses are subject to change in our upcoming 2.0 release. If you are planning to use tldraw in a commercial product, please reach out at hello@tldraw.com.