LearnReferenceExamples
LearnReferenceExamples
  • API Reference
    • @tldraw/editor

    • @tldraw/store

    • tldraw

    • @tldraw/tlschema

    • @tldraw/validate

Close
API Reference / tldraw

tldraw

  • AlertSeverity
  • AlignMenuItems
  • ArrangeMenuSubmenu
  • ArrowDownToolbarItem
  • ArrowheadStylePickerSet
  • ArrowLeftToolbarItem
  • ArrowRightToolbarItem
  • ArrowShapeTool
  • ArrowShapeUtil
  • ArrowToolbarItem
  • ArrowUpToolbarItem
  • AssetToolbarItem
  • BookmarkShapeUtil
  • BreakPointProvider
  • CheckBoxToolbarItem
  • ClipboardMenuGroup
  • CloudToolbarItem
  • CommonStylePickerSet
  • containBoxSize
  • ConversionsMenuGroup
  • ConvertToBookmarkMenuItem
  • ConvertToEmbedMenuItem
  • copyAs
  • CopyAsMenuGroup
  • CopyMenuItem
  • CutMenuItem
  • DebugFlags
  • DEFAULT_ACCEPTED_IMG_TYPE
  • DEFAULT_ACCEPTED_VID_TYPE
  • DefaultActionsMenu
  • DefaultActionsMenuContent
  • DefaultContextMenu
  • DefaultContextMenuContent
  • DefaultDebugMenu
  • DefaultDebugMenuContent
  • defaultEditorAssetUrls
  • DefaultHelperButtons
  • DefaultHelperButtonsContent
  • DefaultHelpMenu
  • DefaultHelpMenuContent
  • DefaultKeyboardShortcutsDialog
  • DefaultKeyboardShortcutsDialogContent
  • DefaultMainMenu
  • DefaultMainMenuContent
  • DefaultMinimap
  • DefaultPageMenu
  • DefaultQuickActions
  • DefaultQuickActionsContent
  • defaultShapeTools
  • defaultShapeUtils
  • DefaultStylePanel
  • DefaultStylePanelContent
  • DefaultToolbar
  • DefaultToolbarContent
  • defaultTools
  • DefaultZoomMenu
  • DefaultZoomMenuContent
  • DeleteMenuItem
  • DiamondToolbarItem
  • DistributeMenuItems
  • downsizeImage
  • DrawShapeTool
  • DrawShapeUtil
  • DrawToolbarItem
  • DuplicateMenuItem
  • EditLinkMenuItem
  • EditSubmenu
  • EllipseToolbarItem
  • EmbedShapeUtil
  • EraserTool
  • EraserToolbarItem
  • EventsProviderProps
  • ExampleDialog
  • exportAs
  • ExportFileContentSubMenu
  • exportToBlob
  • ExtrasGroup
  • FeatureFlags
  • fitFrameToContent
  • FitFrameToContentMenuItem
  • FONT_FAMILIES
  • FrameShapeTool
  • FrameShapeUtil
  • FrameToolbarItem
  • GeoShapeTool
  • GeoShapeUtil
  • GeoStylePickerSet
  • getEmbedInfo
  • getOccludedChildren
  • getPerfectDashProps
  • getSvgAsImage
  • GroupMenuItem
  • GroupOrUngroupMenuItem
  • HandTool
  • HandToolbarItem
  • HexagonToolbarItem
  • HighlightShapeTool
  • HighlightShapeUtil
  • HighlightToolbarItem
  • ImageShapeUtil
  • isGifAnimated
  • KeyboardShortcutsMenuItem
  • LABEL_FONT_SIZES
  • LanguageMenu
  • LaserTool
  • LaserToolbarItem
  • LineShapeTool
  • LineShapeUtil
  • LineToolbarItem
  • MiscMenuGroup
  • MoveToPageMenu
  • NoteShapeTool
  • NoteShapeUtil
  • NoteToolbarItem
  • OfflineIndicator
  • OpacitySlider
  • OvalToolbarItem
  • PageItemInput
  • PageItemSubmenu
  • parseTldrawJsonFile
  • PasteMenuItem
  • PORTRAIT_BREAKPOINT
  • PreferencesGroup
  • preloadFont
  • PrintItem
  • RectangleToolbarItem
  • removeFrame
  • RemoveFrameMenuItem
  • ReorderMenuItems
  • ReorderMenuSubmenu
  • RhombusToolbarItem
  • RotateCWMenuItem
  • SelectAllMenuItem
  • SelectTool
  • SelectToolbarItem
  • serializeTldrawJson
  • serializeTldrawJsonBlob
  • setDefaultEditorAssetUrls
  • SplineStylePickerSet
  • StackMenuItems
  • StarToolbarItem
  • TEXT_PROPS
  • TextLabel
  • TextShapeTool
  • TextShapeUtil
  • TextStylePickerSet
  • TextToolbarItem
  • TLComponents
  • TLDRAW_FILE_EXTENSION
  • Tldraw
  • TldrawFile
  • TldrawHandles
  • TldrawImage
  • TldrawImageProps
  • TldrawProps
  • TldrawScribble
  • TldrawSelectionBackground
  • TldrawSelectionForeground
  • TldrawUi
  • TldrawUiBaseProps
  • TldrawUiButton
  • TldrawUiButtonCheck
  • TldrawUiButtonIcon
  • TldrawUiButtonLabel
  • TldrawUiButtonPicker
  • TldrawUiComponentsProvider
  • TldrawUiContextProvider
  • TldrawUiContextProviderProps
  • 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
  • TldrawUiProps
  • TLExportType
  • TLUiActionItem
  • TLUiActionsContextType
  • TLUiActionsMenuProps
  • TLUiAssetUrlOverrides
  • TLUiButtonCheckProps
  • TLUiButtonIconProps
  • TLUiButtonLabelProps
  • TLUiButtonPickerProps
  • TLUiButtonProps
  • TLUiComponents
  • TLUiComponentsProviderProps
  • TLUiContextMenuProps
  • TLUiDebugMenuProps
  • TLUiDialog
  • TLUiDialogBodyProps
  • TLUiDialogFooterProps
  • TLUiDialogHeaderProps
  • TLUiDialogProps
  • TLUiDialogsContextType
  • TLUiDialogTitleProps
  • TLUiDropdownMenuCheckboxItemProps
  • TLUiDropdownMenuContentProps
  • TLUiDropdownMenuGroupProps
  • TLUiDropdownMenuItemProps
  • TLUiDropdownMenuRootProps
  • TLUiDropdownMenuSubProps
  • TLUiDropdownMenuSubTriggerProps
  • TLUiDropdownMenuTriggerProps
  • TLUiEventContextType
  • TLUiEventHandler
  • TLUiEventMap
  • TLUiEventSource
  • TLUiHelperButtonsProps
  • TLUiHelpMenuProps
  • TLUiIconProps
  • TLUiIconType
  • TLUiInputProps
  • TLUiKbdProps
  • TLUiKeyboardShortcutsDialogProps
  • TLUiMainMenuProps
  • TLUiMenuCheckboxItemProps
  • TLUiMenuContextProviderProps
  • TLUiMenuGroupProps
  • TLUiMenuItemProps
  • TLUiMenuSubmenuProps
  • TLUiOverrides
  • TLUiPopoverContentProps
  • TLUiPopoverProps
  • TLUiPopoverTriggerProps
  • TLUiQuickActionsProps
  • TLUiStylePanelContentProps
  • TLUiStylePanelProps
  • TLUiToast
  • TLUiToastAction
  • TLUiToastsContextType
  • TLUiToolItem
  • TLUiToolsContextType
  • TLUiToolsProviderProps
  • TLUiTranslation
  • TLUiTranslationContextType
  • TLUiTranslationKey
  • TLUiZoomMenuProps
  • ToggleAutoSizeMenuItem
  • ToggleDarkModeItem
  • ToggleDebugModeItem
  • ToggleEdgeScrollingItem
  • ToggleFocusModeItem
  • ToggleGridItem
  • ToggleLockMenuItem
  • ToggleReduceMotionItem
  • ToggleSnapModeItem
  • ToggleToolLockItem
  • ToggleTransparentBgMenuItem
  • ToggleWrapModeItem
  • TrapezoidToolbarItem
  • TriangleToolbarItem
  • truncateStringWithEllipsis
  • UiEventsProvider
  • UndoRedoGroup
  • UngroupMenuItem
  • UnlockAllMenuItem
  • unwrapLabel
  • useActions
  • useBreakpoint
  • useCanRedo
  • useCanUndo
  • useCopyAs
  • useCurrentTranslation
  • useDefaultColorTheme
  • useDefaultHelpers
  • useDialogs
  • useEditableText
  • useExportAs
  • useIsToolSelected
  • useKeyboardShortcuts
  • useLocalStorageState
  • useMenuClipboardEvents
  • useMenuIsOpen
  • useNativeClipboardEvents
  • usePreloadAssets
  • useReadonly
  • useRelevantStyles
  • useTldrawUiComponents
  • useToasts
  • useTools
  • useTranslation
  • useUiEvents
  • VideoShapeUtil
  • ViewSubmenu
  • XBoxToolbarItem
  • ZoomOrRotateMenuItem
  • ZoomTo100MenuItem
  • ZoomToFitMenuItem
  • ZoomTool
  • ZoomToSelectionMenuItem

tldraw © 2025