History

Lu Wilson 7a09581081 Add example for external UI (#2846 ) This PR adds an example for how to add external UI components. It's something that I've been asked for help with in the past, and it's something I wish more consumers would do when using tldraw inline - it would help the editor feel less cramped. Therefore, I'd like to have it is as an example we can point people to. ![2024-02-19 at 11 53 18 - Maroon Boar](https://github.com/tldraw/tldraw/assets/15892272/f043bb77-3181-4a7d-b736-2b6a5012e208) > Some other context: > We've talked about giving this sorta thing more first-class support in the future, eg: with a `useEditorInstance` hook or something. Closes TLD-2128 ### 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 ### Test Plan 1. Try out the External UI example. 2. Make sure you can change tool by pressing the toolbar buttons. 3. Make sure you can change tool by pressing keys (eg: d, e) - [ ] Unit Tests - [ ] End to end tests ### Release Notes - Docs: Added external UI example. --------- Co-authored-by: Steve Ruiz <steveruizok@gmail.com>		2024-02-23 16:07:08 +00:00
..
e2e	E2E Style Panel Tests (#2878 )	2024-02-23 14:37:15 +00:00
public	Add custom static assets example, extract preloadFont (#2932 )	2024-02-23 13:58:06 +00:00
src	Add example for external UI (#2846 )	2024-02-23 16:07:08 +00:00
.gitignore	feat: add new prop to force mobile mode layout (#1734 )	2023-11-11 14:11:59 +00:00
LICENSE.md	Change licenses to tldraw (#2167 )	2023-12-19 10:41:01 +00:00
package.json	examples: clean up Canvas/Store events and make UiEvents have code snippets (#2770 )	2024-02-07 16:51:04 +00:00
README.md	Fix trademark links (#2380 )	2023-12-26 09:22:04 +00:00
tsconfig.json	Check tsconfig "references" arrays (#2891 )	2024-02-21 13:07:53 +00:00
vercel.json	Restore vercel.jsons (#2650 )	2024-01-25 23:24:22 +00:00
vite.config.ts	Examples tweaks (#2681 )	2024-02-02 17:36:30 +00:00

README.md

@tldraw/example

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 hello@tldraw.com for more inforion about obtaining a commercial license.

Trademarks

Contact

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