View as Markdown · AI documentation index

Type Alias: RefText

RefText = object

Defined in: types.ts:54

A pointer back into the script beat that produced the text.

Remarks

The only form that can carry a React node, since a node cannot be serialized. The content is re-read from the script on every render, so anything dynamic must travel through params rather than being interpolated into the node.

Properties

beatId

beatId: string

Defined in: types.ts:57

---

kind

kind: "ref"

Defined in: types.ts:55

---

scriptId

scriptId: string

Defined in: types.ts:56

---

slot

slot: string

Defined in: types.ts:59

Which text of the beat this refers to, e.g. "text", "caption", "alt:0".