AppOptions

Public Interface

Table of Contents
Signature
interface AppOptions {}

Properties

config

Public PropertySignature

A configuration defining major customizations to the app, such as custom shapes and new tools

Signature
config?: TldrawEditorConfig
References

TldrawEditorConfig


getContainer

Public PropertySignature

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

Signature
getContainer: () => HTMLElement
References

HTMLElement


instanceId

Public PropertySignature

The id of the app instance (e.g. a browser tab if the app will have only one tldraw app per tab). If not given, one will be generated.

Signature
instanceId?: TLInstanceId
References

TLInstanceId


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


userId

Public PropertySignature

The id of the current user. If not given, one will be generated.

Signature
userId?: TLUserId
References

TLUserId


Edit this page
Last edited on 10 May 2023
AppARROW_LABEL_FONT_SIZES