tldraw/docs
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
..
community [docs] Remove embeds page (#1653) 2023-06-26 16:22:29 +00:00
docs [feature] add meta property to records (#1627) 2023-06-28 14:24:05 +00:00
getting-started (1/2) [docs] Restore some missing changes (#1652) 2023-06-26 16:22:48 +00:00
authors.json [1/2] Move docs to brivate (#1640) 2023-06-23 14:23:14 +00:00
README.md [1/2] Move docs to brivate (#1640) 2023-06-23 14:23:14 +00:00
sections.json (1/2) [docs] Restore some missing changes (#1652) 2023-06-26 16:22:48 +00:00