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
AlignMenuItems
ArrangeMenuSubmenu
ArrowDownToolbarItem
ArrowheadStylePickerSet
ArrowLeftToolbarItem
ArrowRightToolbarItem
ArrowToolbarItem
ArrowUpToolbarItem
AssetToolbarItem
BreakPointProvider
CheckBoxToolbarItem
ClipboardMenuGroup
CloudToolbarItem
CommonStylePickerSet
containBoxSize
ConversionsMenuGroup
ConvertToBookmarkMenuItem
ConvertToEmbedMenuItem
copyAs
CopyAsMenuGroup
CopyMenuItem
CutMenuItem
DebugFlags
DefaultActionsMenuContent
DefaultContextMenuContent
DefaultDebugMenu
DefaultDebugMenuContent
DefaultHelperButtons
DefaultHelperButtonsContent
DefaultHelpMenuContent
DefaultKeyboardShortcutsDialogContent
DefaultMainMenuContent
DefaultMinimap
DefaultQuickActionsContent
DefaultStylePanelContent
DefaultToolbarContent
DefaultZoomMenuContent
DeleteMenuItem
DiamondToolbarItem
DistributeMenuItems
downsizeImage
DrawToolbarItem
DuplicateMenuItem
EditLinkMenuItem
EditSubmenu
EllipseToolbarItem
EraserToolbarItem
ExampleDialog
exportAs
ExportFileContentSubMenu
exportToBlob
ExtrasGroup
FeatureFlags
fitFrameToContent
FitFrameToContentMenuItem
FrameToolbarItem
GeoStylePickerSet
getEmbedInfo
getOccludedChildren
getPerfectDashProps
getSvgAsImage
GroupMenuItem
GroupOrUngroupMenuItem
HandToolbarItem
HexagonToolbarItem
HighlightToolbarItem
isGifAnimated
KeyboardShortcutsMenuItem
LanguageMenu
LaserToolbarItem
LineToolbarItem
MiscMenuGroup
MoveToPageMenu
NoteToolbarItem
OfflineIndicator
OpacitySlider
OvalToolbarItem
PageItemInput
parseTldrawJsonFile
PasteMenuItem
PreferencesGroup
preloadFont
PrintItem
RectangleToolbarItem
removeFrame
RemoveFrameMenuItem
ReorderMenuItems
ReorderMenuSubmenu
RhombusToolbarItem
RotateCWMenuItem
SelectAllMenuItem
SelectToolbarItem
serializeTldrawJson
serializeTldrawJsonBlob
setDefaultEditorAssetUrls
SplineStylePickerSet
StackMenuItems
StarToolbarItem
TextStylePickerSet
TextToolbarItem
Tldraw
TldrawHandles
TldrawScribble
TldrawSelectionBackground
TldrawUiButtonCheck
TldrawUiButtonIcon
TldrawUiButtonLabel
TldrawUiComponentsProvider
TldrawUiContextProvider
TldrawUiDialogBody
TldrawUiDialogCloseButton
TldrawUiDialogFooter
TldrawUiDialogHeader
TldrawUiDialogTitle
TldrawUiDropdownMenuCheckboxItem
TldrawUiDropdownMenuContent
TldrawUiDropdownMenuGroup
TldrawUiDropdownMenuIndicator
TldrawUiDropdownMenuItem
TldrawUiDropdownMenuRoot
TldrawUiDropdownMenuSub
TldrawUiDropdownMenuSubTrigger
TldrawUiDropdownMenuTrigger
TldrawUiKbd
TldrawUiMenuCheckboxItem
TldrawUiMenuContextProvider
TldrawUiMenuGroup
TldrawUiMenuItem
TldrawUiMenuSubmenu
TldrawUiPopover
TldrawUiPopoverContent
TldrawUiPopoverTrigger
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
ViewSubmenu
XBoxToolbarItem
ZoomOrRotateMenuItem
ZoomTo100MenuItem
ZoomToFitMenuItem
ZoomToSelectionMenuItem
Variable
Enum
Interface
TypeAlias
@tldraw/tlschema
Class
Function
Variable
Interface
TypeAlias
@tldraw/validate
Class
Namespace
Close
API Reference
/
tldraw
useReadonly
Public function
Signature
function
useReadonly
(
):
boolean
Source
packages/tldraw/src/lib/ui/hooks/useReadonly.ts
usePreloadAssets
useRelevantStyles