4dfc59e5cb
This PR introduces `@tldraw/tldraw/tldraw.css`, an exported CSS file that replaces the `editor.css` and `ui.css` that were previously copied from the editor and ui packages. Instead, these files are combined into the `tldraw.css` file, simplifying the import story when using `@tldraw/tldraw`. ### Change Type - [x] `major` — Breaking change ### Release Notes - [tldraw] Removes `editor.css` and `ui.css` exports, replaces with `tldraw.css`
49 lines
No EOL
2.4 KiB
Text
49 lines
No EOL
2.4 KiB
Text
---
|
|
title: Introduction
|
|
status: published
|
|
author: steveruizok
|
|
date: 3/22/2023
|
|
order: 0
|
|
---
|
|
|
|
Welcome to the tldraw developer docs.
|
|
|
|
Here at tldraw, we make two things: a very good multiplayer whiteboard (at [tldraw.com](https://www.tldraw.com)) and the [open source](https://github.com/tldraw/tldraw) libraries used to create that product. This page is meant to provide documentation and reference for those open source libraries.
|
|
|
|
```tsx
|
|
import { Tldraw } from '@tldraw/tldraw'
|
|
import '@tldraw/tldraw/tldraw.css'
|
|
|
|
export default function () {
|
|
return (
|
|
<div style={{ position: 'fixed', inset: 0 }}>
|
|
<Tldraw />
|
|
</div>
|
|
)
|
|
}
|
|
```
|
|
|
|
You can use the `<Tldraw>` React component to build on top of the default tldraw experience. It's easy to use and easy to extend with your own [custom shapes](/docs/shapes), [custom tools](/docs/tools), and [user interface](/docs/user-interface) overrides.
|
|
|
|
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.
|
|
|
|
And in either case, you can use the [Editor API](/docs/editor) to drive the experience programatically in order to create or delete shapes, control the camera, or do just about anything you can imagine.
|
|
|
|
Best of all, you can easily plug tldraw into the [collaboration backend](/docs/collaboration) of your choice.
|
|
|
|
- Want to explore the code? Visit the [GitHub repo](https://github.com/tldraw/tldraw).
|
|
- Want to try it out? Visit the [examples sandbox](https://stackblitz.com/github/tldraw/tldraw/tree/examples?file=src%2F1-basic%2FBasicExample.tsx).
|
|
|
|
Otherwise, continue on to the [installation](/docs/installation) and [usage](/docs/usage) guides.
|
|
|
|
## Community
|
|
|
|
Found a bug or want to request a feature? Create a 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).
|
|
|
|
If you spot an issue with these docs, please use the links at the bottom of each page to create a. If you would like to contribute, the docs are part of the [tldraw repo](https://github.com/tldraw/tldraw).
|
|
|
|
## License
|
|
|
|
Our open source libraries are licensed and distributed under Apache-2.0.
|
|
|
|
Our plan is to keep these libraries permissively licensed while we develop a commercial offering for teams who want more from tldraw. If you're planning to use use tldraw in a commercial product, please reach out at [hello@tldraw.com](mailto://hello@tldraw.com). |