History

alex 965bc10997 [1/4] Blob storage in TLStore (#4068 ) Reworks the store to include information about how blob assets (images/videos) are stored/retrieved. This replaces the old internal-only `assetOptions` prop, and supplements the existing `registerExternalAssetHandler` API. Previously, `registerExternalAssetHandler` had two responsibilities: 1. Extracting asset metadata 2. Uploading the asset and returning its URL Existing `registerExternalAssetHandler` implementation will still work, but now uploading is the responsibility of a new `editor.uploadAsset` method which calls the new store-based upload method. Our default asset handlers extract metadata, then call that new API. I think this is a pretty big improvement over what we had before: overriding uploads was a pretty common ask, but doing so meant having to copy paste our metadata extraction which felt pretty fragile. Just in this codebase, we had a bunch of very slightly different metadata extraction code-paths that had been copy-pasted around then diverged over time. Now, you can change how uploads work without having to mess with metadata extraction and vice-versa. As part of this we also: 1. merge the old separate asset indexeddb store with the main one. because this warrants some pretty big migration stuff, i refactored our indexed-db helpers to work around an instance instead of being free functions 2. move our existing asset stuff over to the new approach 3. add a new hook in `sync-react` to create a demo store with the new assets ### Change type - [x] `api` ### Release notes Introduce a new `assets` option for the store, describing how to save and retrieve asset blobs like images & videos from e.g. a user-content CDN. These are accessible through `editor.uploadAsset` and `editor.resolveAssetUrl`. This supplements the existing `registerExternalAssetHandler` API: `registerExternalAssetHandler` is for customising metadata extraction, and should call `editor.uploadAsset` to save assets. Existing `registerExternalAssetHandler` calls will still work, but if you're only using them to configure uploads and don't want to customise metadata extraction, consider switching to the new `assets` store prop.		2024-07-10 13:00:18 +00:00
..
e2e	Fix fog of war (#4031 )	2024-06-28 09:04:47 +00:00
public	3d example (#3647 )	2024-04-30 09:24:07 +00:00
src	[1/4] Blob storage in TLStore (#4068 )	2024-07-10 13:00:18 +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	Camera options followups (#3701 )	2024-05-07 10:06:35 +00:00
README.md	Update READMEs, add form link (#3741 )	2024-05-12 20:48:07 +00:00
tsconfig.json	Camera options followups (#3701 )	2024-05-07 10:06:35 +00:00
vercel.json	Restore vercel.jsons (#2650 )	2024-01-25 23:24:22 +00:00
vite.config.ts	Set bemo url in examples app (#4091 )	2024-07-08 15:37:04 +00:00

README.md

@tldraw/example

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. To purchase a commercial license or learn more, please fill out this form.

Trademarks

Contact

Find us on Twitter/X at @tldraw.

Community

Have questions, comments or feedback? Join our discord or start a discussion. For the latest news and release notes, check out our Substack.