tldraw/packages
Steve Ruiz fd29006538
[feature] add meta property to records (#1627)
This PR adds a `meta` property to shapes and other records.

It adds it to:
- asset
- camera
- document
- instance
- instancePageState
- instancePresence
- page
- pointer
- rootShape

## Setting meta

This data can generally be added wherever you would normally update the
corresponding record.

An exception exists for shapes, which can be updated using a partial of
the `meta` in the same way that we update shapes with a partial of
`props`.

```ts
this.updateShapes([{
    id: myShape.id,
    type: "geo",
    meta: { 
      nemesis: "steve",
      special: true
    }
])
```

## `Editor.getInitialMetaForShape`

The `Editor.getInitialMetaForShape` method is kind of a hack to set the
initial meta property for newly created shapes. You can set it
externally. Escape hatch!

### Change Type

- [x] `minor` — New feature

### Test Plan

todo

- [ ] Unit Tests (todo)

### Release Notes

- todo
2023-06-28 14:24:05 +00:00
..
assets Update CHANGELOG.md [skip ci] 2023-06-28 11:53:57 +01:00
editor [feature] add meta property to records (#1627) 2023-06-28 14:24:05 +00:00
file-format [feature] add meta property to records (#1627) 2023-06-28 14:24:05 +00:00
indices Update CHANGELOG.md [skip ci] 2023-06-28 11:53:57 +01:00
polyfills Update CHANGELOG.md [skip ci] 2023-06-28 11:53:57 +01:00
primitives Update CHANGELOG.md [skip ci] 2023-06-28 11:53:57 +01:00
state Update CHANGELOG.md [skip ci] 2023-06-28 11:53:57 +01:00
store [fix] mutating snapshot in migrateStoreSnapshot (#1663) 2023-06-28 14:23:56 +00:00
tldraw Update CHANGELOG.md [skip ci] 2023-06-28 11:53:57 +01:00
tlschema [feature] add meta property to records (#1627) 2023-06-28 14:24:05 +00:00
ui [feature] add meta property to records (#1627) 2023-06-28 14:24:05 +00:00
utils [feature] add meta property to records (#1627) 2023-06-28 14:24:05 +00:00
validate [feature] add meta property to records (#1627) 2023-06-28 14:24:05 +00:00