TldrawEditorConfig

Public Class

Table of Contents
Signature
class TldrawEditorConfig {}

Constructor

Public Constructor

Constructs a new instance of the TldrawEditorConfig class

Parameters
NameDescription

opts

(optional)

TldrawEditorConfigOptions
References

TldrawEditorConfigOptions


Properties

derivePresenceState

Public Readonly Property

Signature
readonly derivePresenceState: (
  store: TLStore
) => Signal<null | TLInstancePresence>
References

TLStore, Signal, TLInstancePresence


setUserPreferences

Public Readonly Property

Signature
readonly setUserPreferences: (userPreferences: TLUserPreferences) => void
References

TLUserPreferences


shapeUtils

Public Readonly Property

Signature
readonly shapeUtils: Record<TLShape['type'], TLShapeUtilConstructor<any>>
References

Record, TLShape, TLShapeUtilConstructor


storeSchema

Public Readonly Property

Signature
readonly storeSchema: StoreSchema<TLRecord, TLStoreProps>
References

StoreSchema, TLRecord, TLStoreProps


TLShape

Public Readonly Property

Signature
readonly TLShape: RecordType<TLShape, 'index' | 'parentId' | 'props' | 'type'>
References

RecordType, TLShape


tools

Public Readonly Property

Signature
readonly tools: readonly StateNodeConstructor[]
References

StateNodeConstructor


userPreferences

Public Readonly Property

Signature
readonly userPreferences: Signal<TLUserPreferences>
References

Signal, TLUserPreferences


Methods

createStore()

Public Method

Parameters
NameDescription

config

{
  initialData?: StoreSnapshot<TLRecord>
  instanceId: TLInstanceId
}
Returns
TLStore
References

StoreSnapshot, TLRecord, TLInstanceId, TLStore


Edit this page
Last edited on 30 May 2023
TldrawEditorTldrawEditorProps