TLEditorOptions

Public Interface

Table of Contents
Signature
interface TLEditorOptions {}

Properties

getContainer

Public PropertySignature

Should return a containing html element which has all the styles applied to the editor. If not given, the body element will be used.

Signature
getContainer: () => HTMLElement
References

HTMLElement


shapes

Public PropertySignature

An array of shapes to use in the editor. These will be used to create and manage shapes in the editor.

Signature
shapes: readonly AnyTLShapeInfo[]
References

AnyTLShapeInfo


store

Public PropertySignature

The Store instance to use for keeping the app's data. This may be prepopulated, e.g. by loading from a server or database.

Signature
store: TLStore
References

TLStore


tools

Public PropertySignature

An array of tools to use in the editor. These will be used to handle events and manage user interactions in the editor.

Signature
tools: readonly TLStateNodeConstructor[]
References

TLStateNodeConstructor


user

Public PropertySignature

A user defined externally to replace the default user.

Signature
user?: TLUser
References

TLUser


Edit this page
Last edited on 15 June 2023
TLEditorComponentsTLEmbedResult