TldrawOptions
See source codeTable of contents
- actionShortcutsLocation
- adjacentShapeMargin
- animationMediumMs
- cameraMovingTimeoutMs
- cameraSlideFriction
- coarseDragDistanceSquared
- coarseHandleRadius
- coarsePointerWidth
- collaboratorCheckIntervalMs
- collaboratorIdleTimeoutMs
- collaboratorInactiveTimeoutMs
- createTextOnCanvasDoubleClick
- defaultSvgPadding
- doubleClickDurationMs
- dragDistanceSquared
- edgeScrollDelay
- edgeScrollDistance
- edgeScrollEaseDuration
- edgeScrollSpeed
- exportProvider
- flattenImageBoundsExpand
- flattenImageBoundsPadding
- followChaseViewportSnap
- gridSteps
- handleRadius
- hitTestMargin
- laserDelayMs
- longPressDurationMs
- maxExportDelayMs
- maxFilesAtOnce
- maxPages
- maxPointsPerDrawShape
- maxShapesPerPage
- multiClickDurationMs
- temporaryAssetPreviewLifetimeMs
- textShadowLod
- Properties
Options for configuring tldraw. For defaults, see defaultTldrawOptions.
interface TldrawOptions {}Example
const options: Partial<TldrawOptions> = {
maxPages: 3,
maxShapesPerPage: 1000,
}
function MyTldrawComponent() {
return <Tldraw options={options} />
}Properties
actionShortcutsLocation
readonly
readonly actionShortcutsLocation: 'menu' | 'swap' | 'toolbar'adjacentShapeMargin
readonly
readonly adjacentShapeMargin: numberanimationMediumMs
readonly
readonly animationMediumMs: numbercameraMovingTimeoutMs
readonly
readonly cameraMovingTimeoutMs: numbercameraSlideFriction
readonly
readonly cameraSlideFriction: numbercoarseDragDistanceSquared
readonly
readonly coarseDragDistanceSquared: numbercoarseHandleRadius
readonly
readonly coarseHandleRadius: numbercoarsePointerWidth
readonly
readonly coarsePointerWidth: numbercollaboratorCheckIntervalMs
readonly
readonly collaboratorCheckIntervalMs: numbercollaboratorIdleTimeoutMs
readonly
readonly collaboratorIdleTimeoutMs: numbercollaboratorInactiveTimeoutMs
readonly
readonly collaboratorInactiveTimeoutMs: numbercreateTextOnCanvasDoubleClick
readonly
readonly createTextOnCanvasDoubleClick: booleandefaultSvgPadding
readonly
readonly defaultSvgPadding: numberdoubleClickDurationMs
readonly
readonly doubleClickDurationMs: numberdragDistanceSquared
readonly
readonly dragDistanceSquared: numberedgeScrollDelay
readonly
readonly edgeScrollDelay: numberedgeScrollDistance
readonly
readonly edgeScrollDistance: numberedgeScrollEaseDuration
readonly
readonly edgeScrollEaseDuration: numberedgeScrollSpeed
readonly
readonly edgeScrollSpeed: numberexportProvider
readonly
The react provider to use when exporting an image. This is useful if your shapes depend on
external context providers. By default, this is React.Fragment.
readonly exportProvider: ComponentType<{
children: React.ReactNode
}>flattenImageBoundsExpand
readonly
readonly flattenImageBoundsExpand: numberflattenImageBoundsPadding
readonly
readonly flattenImageBoundsPadding: numberfollowChaseViewportSnap
readonly
readonly followChaseViewportSnap: numbergridSteps
readonly
readonly gridSteps: readonly {
readonly mid: number
readonly min: number
readonly step: number
}[]handleRadius
readonly
readonly handleRadius: numberhitTestMargin
readonly
readonly hitTestMargin: numberlaserDelayMs
readonly
readonly laserDelayMs: numberlongPressDurationMs
readonly
readonly longPressDurationMs: numbermaxExportDelayMs
readonly
readonly maxExportDelayMs: numbermaxFilesAtOnce
readonly
readonly maxFilesAtOnce: numbermaxPages
readonly
readonly maxPages: numbermaxPointsPerDrawShape
readonly
readonly maxPointsPerDrawShape: numbermaxShapesPerPage
readonly
readonly maxShapesPerPage: numbermultiClickDurationMs
readonly
readonly multiClickDurationMs: numbertemporaryAssetPreviewLifetimeMs
readonly
How long should previews created by Editor.createTemporaryAssetPreview last before they expire? Defaults to 3 minutes.
readonly temporaryAssetPreviewLifetimeMs: numbertextShadowLod
readonly
readonly textShadowLod: numberPrev
TldrawEditorWithStorePropsNext
TLEditorComponents