@mocanvas/editor · interface

TLCustomRecord

interface TLCustomRecord<Type extends string = RegisteredCustomRecordType>

One custom record.

The shape of the record mirrors a shape's: a type discriminant, a props bag the app owns, and a meta bag for anything the app wants to hang off it without declaring. Everything a custom record type shares with every other record — id, typeName — is fixed here so the store can treat them all alike.


Properties · 5

readonly id: TLCustomRecordId<Type>
meta: JsonObject
props: CustomRecordPropsForType<Type>
type: Type
readonly typeName: "custom"

mocanvas is built by Symbio. Free for non-commercial, non-profit and development use; commercial use needs an agreement. Not affiliated with or endorsed by tldraw.