Learn
Reference
Examples
Learn
Reference
Examples
API Reference
@tldraw/editor
Class
Function
Variable
Interface
TypeAlias
@tldraw/store
Class
Function
Enum
Interface
TypeAlias
tldraw
Class
Function
Variable
Enum
Interface
TypeAlias
Component
AlignMenuItems
ArrangeMenuSubmenu
ArrowDownToolbarItem
ArrowheadStylePickerSet
ArrowLeftToolbarItem
ArrowRightToolbarItem
ArrowToolbarItem
ArrowUpToolbarItem
AssetToolbarItem
BreakPointProvider
CenteredTopPanelContainer
CheckBoxToolbarItem
ClipboardMenuGroup
CloudToolbarItem
CommonStylePickerSet
ConversionsMenuGroup
ConvertToBookmarkMenuItem
ConvertToEmbedMenuItem
CopyAsMenuGroup
CopyMenuItem
CutMenuItem
DebugFlags
DefaultActionsMenu
DefaultActionsMenuContent
DefaultContextMenu
DefaultContextMenuContent
DefaultDebugMenu
DefaultDebugMenuContent
DefaultHelperButtons
DefaultHelperButtonsContent
DefaultHelpMenu
DefaultHelpMenuContent
DefaultKeyboardShortcutsDialog
DefaultKeyboardShortcutsDialogContent
DefaultMainMenu
DefaultMainMenuContent
DefaultMenuPanel
DefaultMinimap
DefaultNavigationPanel
DefaultPageMenu
DefaultQuickActions
DefaultQuickActionsContent
DefaultSharePanel
DefaultStylePanel
DefaultStylePanelContent
DefaultToolbar
DefaultToolbarContent
DefaultTopPanel
DefaultZoomMenu
DefaultZoomMenuContent
DeleteMenuItem
DiamondToolbarItem
DistributeMenuItems
DrawToolbarItem
DuplicateMenuItem
EditLinkMenuItem
EditSubmenu
EllipseToolbarItem
EraserToolbarItem
ExampleDialog
ExportFileContentSubMenu
ExtrasGroup
FeatureFlags
FitFrameToContentMenuItem
FrameToolbarItem
GeoStylePickerSet
GroupMenuItem
GroupOrUngroupMenuItem
HandToolbarItem
HelpGroup
HexagonToolbarItem
HighlightToolbarItem
KeyboardShortcutsMenuItem
LanguageMenu
LaserToolbarItem
LineToolbarItem
MiscMenuGroup
MoveToPageMenu
NoteToolbarItem
OfflineIndicator
OpacitySlider
OvalToolbarItem
PageItemInput
PasteMenuItem
PeopleMenu
PreferencesGroup
PrintItem
RectangleToolbarItem
RemoveFrameMenuItem
ReorderMenuItems
ReorderMenuSubmenu
RhombusToolbarItem
RotateCWMenuItem
SelectAllMenuItem
SelectToolbarItem
SplineStylePickerSet
StackMenuItems
StarToolbarItem
TextLabel
TextStylePickerSet
TextToolbarItem
Tldraw
TldrawHandles
TldrawImage
TldrawScribble
TldrawSelectionBackground
TldrawShapeIndicators
TldrawUi
TldrawUiButton
TldrawUiButtonCheck
TldrawUiButtonIcon
TldrawUiButtonLabel
TldrawUiComponentsProvider
TldrawUiContextProvider
TldrawUiDialogBody
TldrawUiDialogCloseButton
TldrawUiDialogFooter
TldrawUiDialogHeader
TldrawUiDialogTitle
TldrawUiDropdownMenuCheckboxItem
TldrawUiDropdownMenuContent
TldrawUiDropdownMenuGroup
TldrawUiDropdownMenuIndicator
TldrawUiDropdownMenuItem
TldrawUiDropdownMenuRoot
TldrawUiDropdownMenuSub
TldrawUiDropdownMenuSubTrigger
TldrawUiDropdownMenuTrigger
TldrawUiIcon
TldrawUiInput
TldrawUiKbd
TldrawUiMenuCheckboxItem
TldrawUiMenuContextProvider
TldrawUiMenuGroup
TldrawUiMenuItem
TldrawUiMenuSubmenu
TldrawUiPopover
TldrawUiPopoverContent
TldrawUiPopoverTrigger
ToggleAutoSizeMenuItem
ToggleDebugModeItem
ToggleEdgeScrollingItem
ToggleFocusModeItem
ToggleGridItem
ToggleLockMenuItem
ToggleReduceMotionItem
ToggleSnapModeItem
ToggleToolLockItem
ToggleTransparentBgMenuItem
ToggleWrapModeItem
ToolbarItem
TrapezoidToolbarItem
TriangleToolbarItem
UiEventsProvider
UndoRedoGroup
UngroupMenuItem
UnlockAllMenuItem
ViewSubmenu
XBoxToolbarItem
ZoomOrRotateMenuItem
ZoomTo100MenuItem
ZoomToFitMenuItem
ZoomToSelectionMenuItem
@tldraw/tlschema
Class
Function
Variable
Interface
TypeAlias
@tldraw/validate
Class
TypeAlias
Namespace
Close
API Reference
/
tldraw
TldrawScribble
component
Table of contents
className
color
opacity
scribble
zoom
Properties
Properties
className
optional
className?:
string
color
optional
color?:
string
opacity
optional
opacity?:
number
scribble
scribble
:
TLScribble
zoom
zoom
:
number
TldrawImage
TldrawSelectionBackground
