PrivateCoffee/tldraw
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Relax the params (#4190)

Browse source 
Feels like we can relax what we expect? It gets passed to `loadSnapshot`
which allows for partials.

Resolves https://github.com/tldraw/tldraw/issues/3999

### Change type

- [ ] `bugfix`
- [x] `improvement`
- [ ] `feature`
- [ ] `api`
- [ ] `other`

### Release notes

- Allow passing partial `TLEditorSnapshot` to `TldrawImage` and
`useTLStore`.
This commit is contained in:
Mitja Bezenšek 2024-07-16 16:11:12 +02:00 committed by GitHub
parent 48d1f4e0d7
commit e784d3182f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
packages/editor/api-report.md
View file

@ -3539,7 +3539,7 @@ export function useTLSchemaFromUtils(opts: TLStoreSchemaOptions): StoreSchema<TL
// @public (undocumented) // @public (undocumented)
export function useTLStore(opts: TLStoreOptions & { export function useTLStore(opts: TLStoreOptions & {
snapshot?: TLEditorSnapshot | TLStoreSnapshot; snapshot?: Partial<TLEditorSnapshot> | TLStoreSnapshot;
}): TLStore; }): TLStore;
// @public (undocumented) // @public (undocumented)

4
packages/editor/src/lib/hooks/useTLStore.ts
View file

@ -11,7 +11,7 @@ import {
/** @public */ /** @public */
type UseTLStoreOptions = TLStoreOptions & { type UseTLStoreOptions = TLStoreOptions & {
snapshot?: TLEditorSnapshot | TLStoreSnapshot snapshot?: Partial<TLEditorSnapshot> | TLStoreSnapshot
} }
function createStore(opts: UseTLStoreOptions) { function createStore(opts: UseTLStoreOptions) {
@ -24,7 +24,7 @@ function createStore(opts: UseTLStoreOptions) {
/** @public */ /** @public */
export function useTLStore( export function useTLStore(
opts: TLStoreOptions & { snapshot?: TLEditorSnapshot | TLStoreSnapshot } opts: TLStoreOptions & { snapshot?: Partial<TLEditorSnapshot> | TLStoreSnapshot }
) { ) {
const [current, setCurrent] = useState(() => createStore(opts)) const [current, setCurrent] = useState(() => createStore(opts))

2
packages/tldraw/api-report.md
View file

@ -1584,7 +1584,7 @@ export interface TldrawImageProps extends TLSvgOptions {
licenseKey?: string; licenseKey?: string;
pageId?: TLPageId; pageId?: TLPageId;
shapeUtils?: readonly TLAnyShapeUtilConstructor[]; shapeUtils?: readonly TLAnyShapeUtilConstructor[];
snapshot: TLEditorSnapshot | TLStoreSnapshot; snapshot: Partial<TLEditorSnapshot> | TLStoreSnapshot;
} }
// @public (undocumented) // @public (undocumented)

2
packages/tldraw/src/lib/TldrawImage.tsx
View file

@ -24,7 +24,7 @@ export interface TldrawImageProps extends TLSvgOptions {
/** /**
* The snapshot to display. * The snapshot to display.
*/ */
snapshot: TLEditorSnapshot | TLStoreSnapshot snapshot: Partial<TLEditorSnapshot> | TLStoreSnapshot
/** /**
* The image format to use. Defaults to 'svg'. * The image format to use. Defaults to 'svg'.