47 lines
3.2 KiB
Text
47 lines
3.2 KiB
Text
|
---
|
||
|
|
title: Introduction
|
||
|
|
status: published
|
||
|
|
author: steveruizok
|
||
|
|
date: 3/22/2023
|
||
|
|
order: 0
|
||
|
|
---
|
||
|
|
|
||
|
|
Welcome to the developer docs for tldraw, a React library for creating whiteboards and other infinite canvas experiences. These docs are for the 2.0 version which is currently in alpha.
|
||
|
|
|
||
|
|
<a className="hero__images" href="https://examples.tldraw.com">
|
||
|
|
<img src={'/images/hero_light.png'} alt="tldraw demo" className="article__image hero__light" />
|
||
|
|
<img src={'/images/hero_dark.png'} alt="tldraw demo" className="article__image hero__dark" />
|
||
|
|
</a>
|
||
|
|
|
||
|
|
- 🔗 Check out the [CodeSandbox](https://codesandbox.io/s/tldraw-example-canary-2lrzmy)
|
||
|
|
- 🧑💻 Visit the [tldraw repo on Github](https://github.com/tldraw/tldraw)
|
||
|
|
- 💬 Join the [Discord](https://discord.com/invite/SBBEVCA4PG)
|
||
|
|
|
||
|
|
## What can I do with tldraw?
|
||
|
|
|
||
|
|
You can use the [Tldraw](?) React component to embed a fully featured and extendable whiteboard in your app. See the [CodeSandbox](https://codesandbox.io/s/tldraw-example-canary-2lrzmy) for a minimal example.
|
||
|
|
|
||
|
|
For multiplayer whiteboards, you can plug the component into the [collaboration backend](/docs/collaboration) of your choice. Check out our [Yjs example](https://github.com/tldraw/tldraw-yjs-example) to see how you might use tldraw together with [Yjs](https://yjs.dev/).
|
||
|
|
|
||
|
|
You can use the [Editor](?) API to create, update, and delete shapes, control the camera—or do just about anything else. You can extend tldraw with your own [custom shapes](/docs/shapes) and [custom tools](/docs/tools). You can use our [user interface](/docs/user-interface) overrides to change the contents of menus and toolbars, or else hide the UI and replace it with your own.
|
||
|
|
|
||
|
|
If you want to go even deeper, you can use the [TldrawEditor](?) component as a more minimal engine without the default tldraw shapes or user interface.
|
||
|
|
|
||
|
|
## How do I learn tldraw?
|
||
|
|
|
||
|
|
In addition to the docs on this website, we provide [many examples](https://github.com/tldraw/tldraw/tree/main/apps/examples/src/examples) in the tldraw repo that demonstrate different ways of using the tldraw library. You can view them running [here](https://examples.tldraw.com/); or else you can clone the tldraw repo and start a local development server to see them in action.
|
||
|
|
|
||
|
|
You can ask questions and get help on our [Discord](https://discord.gg/JMbeb96jsh) channel or in our Github [issues](https://github.com/tldraw/tldraw/issues).
|
||
|
|
|
||
|
|
## Community
|
||
|
|
|
||
|
|
Found a bug or want to request a feature? Create an issue [here](https://github.com/tldraw/tldraw/issues). To connect with the team and other users, join us on our [Discord](https://discord.gg/JMbeb96jsh). To follow along with updates, you can also [subscribe to our Substack newsletter](https://tldraw.substack.com/) or follow us on [Twitter/X](https://twitter.com/tldraw).
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
tldraw's source code and distributed packages are provided under the non-commercial [tldraw license](https://github.com/tldraw/tldraw/blob/master/LICENSE.md).
|
||
|
|
|
||
|
|
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 [hello@tldraw.com](mailto:hello@tldraw.com).
|
||
|
|
|
||
|
|
To learn more, see our [license](/community/license) page.
|