TldrawBaseProps
See source codeTable of contents
- acceptedImageMimeTypes
- acceptedVideoMimeTypes
- assetUrls
- autoFocus
- bindingUtils
- cameraOptions
- children
- className
- components
- deepLinks
- embeds
- forceMobile
- hideUi
- inferDarkMode
- initialState
- licenseKey
- maxAssetSize
- maxImageDimension
- mediaMimeTypes
- onMount
- onUiEvent
- options
- overrides
- shapeUtils
- textOptions
- tools
- user
- Properties
- Methods
Extends TldrawUiProps, TldrawEditorBaseProps, TLExternalContentProps
.
interface TldrawBaseProps
extends TldrawUiProps,
TldrawEditorBaseProps,
TLExternalContentProps {}
Properties
acceptedImageMimeTypes
The mime types of images that are allowed to be handled. Defaults to DEFAULT_SUPPORTED_IMAGE_TYPES.
acceptedImageMimeTypes?: readonly string[]
acceptedVideoMimeTypes
The mime types of videos that are allowed to be handled. Defaults to DEFAULT_SUPPORT_VIDEO_TYPES.
acceptedVideoMimeTypes?: readonly string[]
assetUrls
Asset URL override.
assetUrls?: TLUiAssetUrlOverrides
autoFocus
Whether to automatically focus the editor when it mounts.
autoFocus?: boolean
bindingUtils
An array of binding utils to use in the editor.
bindingUtils?: readonly TLAnyBindingUtilConstructor[]
cameraOptions
Camera options for the editor.
cameraOptions?: Partial<TLCameraOptions>
children
The component's children.
children?: ReactNode
className
A classname to pass to the editor's container.
className?: string
components
components?: TLComponents
deepLinks
Options for syncing the editor's camera state with the URL.
deepLinks?: TLDeepLinkOptions | true
embeds
embeds?: TLEmbedDefinition[]
forceMobile
Whether to always should the mobile breakpoints.
forceMobile?: boolean
hideUi
Whether to hide the user interface and only display the canvas.
hideUi?: boolean
inferDarkMode
Whether to infer dark mode from the user's OS. Defaults to false.
inferDarkMode?: boolean
initialState
The editor's initial state (usually the id of the first active tool).
initialState?: string
licenseKey
The license key.
licenseKey?: string
maxAssetSize
The maximum size (in bytes) of an asset. Assets larger than this will be rejected. Defaults to 10mb (10 * 1024 * 1024).
maxAssetSize?: number
maxImageDimension
The maximum dimension (width or height) of an image. Images larger than this will be rescaled to fit. Defaults to infinity.
maxImageDimension?: number
mediaMimeTypes
Supported mime types for media files.
mediaMimeTypes?: string[]
onMount
Called when the editor has mounted.
onMount?: TLOnMountHandler
onUiEvent
Callback for when an event occurs in the UI.
onUiEvent?: TLUiEventHandler
options
Options for the editor.
options?: Partial<TldrawOptions>
overrides
Overrides for the UI.
overrides?: TLUiOverrides | TLUiOverrides[]
shapeUtils
An array of shape utils to use in the editor.
shapeUtils?: readonly TLAnyShapeUtilConstructor[]
textOptions
Text options for the editor.
textOptions?: Partial<TLTextOptions>
tools
An array of tools to add to the editor's state chart.
tools?: readonly TLStateNodeConstructor[]
user
The user interacting with the editor.
user?: TLUser
Methods
isShapeHidden
Predicate for whether or not a shape should be hidden.
Hidden shapes will not render in the editor, and they will not be eligible for hit test via and . But otherwise they will remain in the store and participate in all other operations.
Parameters
Returns
boolean
renderDebugMenuItems
Additional items to add to the debug menu (will be deprecated)