This PR updates the repo's readme. Some things were out-of-date. For
example, the 'hello world' example didn't work.

See code comments for more detail!

### Change Type

- [x] `documentation` — Changes to the documentation only[^2]

[^1]: publishes a `patch` release, for devDependencies use `internal`
[^2]: will not publish a new version

### Release Notes

- Documentation: Updated readme to reflect recent library changes.

2023-07-04 10:07:05 +00:00

4.7 KiB

Raw Blame History

tldraw

Welcome to the public monorepo for tldraw.

What is tldraw?

tldraw is a collaborative digital whiteboard available at tldraw.com. Its editor, user interface, and other underlying libraries are open source and available in this repository. They are also distributed on npm. You can use tldraw to create a drop-in whiteboard for your product or as the foundation on which to build your own infinite canvas applications.

Learn more at tldraw.dev.

Note

This repo contains source code for the current version of tldraw. You can find the source for the original version here.

Installation & Usage

To learn more about using tldraw in your React application, follow our guide here or see the examples sandbox.

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

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

Local development

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.

Examples

Our development server contains several examples that demonstrates different ways that you can customize tldraw or use its APIs. Each example is found in the apps/examples folder.

eg: localhost:5420 for the basic example.
eg: localhost:5420/api for the API example.

To learn more about using tldraw, visit our docs.

About this repository

Top-level layout

This repository's contents is divided across four primary sections:

/apps contains the source for our applications
/packages contains the source for our public packages
/scripts contains scripts used for building and publishing
/assets contains icons and translations relied on by the app
/docs contains the content for our docs site at tldraw.dev

Applications

examples: our local development / examples project
vscode: our Visual Studio Code extension

Packages

assets: a library for working with tldraw's fonts and translations
editor: the tldraw editor
file-format: a library for working with tldraw's .tldr file format
indices: a library for working with tldraw's indices
polyfills: a collection of polyfills used by tldraw
primitives: low-level primitives for working with vectors and geometry
state: a signals library, also known as signia
store: an in-memory reactive database
tldraw: the main tldraw package containing both the editor and the UI
tlschema: shape definitions and migrations
ui: the editor's user interface
utils: low-level data utilities shared by other libraries
validate: a validation library used for run-time validation

Community

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

Distributions

You can find tldraw on npm here.

At the moment the tldraw package is in alpha. We also ship a canary version which is always up to date with the main branch of this repo.

License

The source code for various apps and packages 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.

Contribution

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

Contact

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

4.7 KiB Raw Blame History