TldrawUi
Public readonly variable
Signature
TldrawUi: React.NamedExoticComponent<{
assetUrls?:
| (import('@tldraw/editor').RecursivePartial<
import('./assetUrls').TLUiAssetUrls
> &
import('@tldraw/editor').RecursivePartial<
import('./assetUrls').TLUiAssetUrls
>)
| undefined
children?: ReactNode
components?:
| Partial<{
ActionsMenu: null | React.ComponentType<
import('../..').TLUiActionsMenuProps
>
ContextMenu: null | React.ComponentType<
import('../..').TLUiContextMenuProps
>
DebugMenu: null | React.ComponentType
DebugPanel: null | React.ComponentType
HelperButtons: null | React.ComponentType<
import('../..').TLUiHelperButtonsProps
>
HelpMenu: null | React.ComponentType<
import('../..').TLUiHelpMenuProps
>
KeyboardShortcutsDialog: null | React.ComponentType<
import('../..').TLUiKeyboardShortcutsDialogProps
>
MainMenu: null | React.ComponentType<
import('../..').TLUiMainMenuProps
>
MenuPanel: null | React.ComponentType
Minimap: null | React.ComponentType
NavigationPanel: null | React.ComponentType
PageMenu: null | React.ComponentType
QuickActions: null | React.ComponentType<
import('../..').TLUiQuickActionsProps
>
SharePanel: null | React.ComponentType
StylePanel: null | React.ComponentType<
import('../..').TLUiStylePanelProps
>
Toolbar: null | React.ComponentType
TopPanel: null | React.ComponentType
ZoomMenu: null | React.ComponentType<
import('../..').TLUiZoomMenuProps
>
}>
| undefined
forceMobile?: boolean | undefined
hideUi?: boolean | undefined
onUiEvent?: import('./context/events').TLUiEventHandler | undefined
overrides?:
| Partial<{
actions: import('./overrides').TLUiOverride<
import('./context/actions').TLUiActionsContextType,
{
addDialog: (
dialog: Omit<import('./context/dialogs').TLUiDialog, 'id'> & {
id?: string | undefined
}
) => string
addToast: (
toast: Omit<import('./context/toasts').TLUiToast, 'id'> & {
id?: string | undefined
}
) => string
clearDialogs: () => void
clearToasts: () => void
isMobile: boolean
msg: (id?: string | undefined) => string
removeDialog: (id: string) => string
removeToast: (id: string) => string
updateDialog: (
id: string,
newDialogData: Partial<import('./context/dialogs').TLUiDialog>
) => string
}
>
tools: import('./overrides').TLUiOverride<
import('./hooks/useTools').TLUiToolsContextType,
{
insertMedia: () => void
} & {
addDialog: (
dialog: Omit<import('./context/dialogs').TLUiDialog, 'id'> & {
id?: string | undefined
}
) => string
addToast: (
toast: Omit<import('./context/toasts').TLUiToast, 'id'> & {
id?: string | undefined
}
) => string
clearDialogs: () => void
clearToasts: () => void
isMobile: boolean
msg: (id?: string | undefined) => string
removeDialog: (id: string) => string
removeToast: (id: string) => string
updateDialog: (
id: string,
newDialogData: Partial<import('./context/dialogs').TLUiDialog>
) => string
}
>
translations: Record<string, Record<string, string>> | undefined
}>
| Partial<{
actions: import('./overrides').TLUiOverride<
import('./context/actions').TLUiActionsContextType,
{
addDialog: (
dialog: Omit<import('./context/dialogs').TLUiDialog, 'id'> & {
id?: string | undefined
}
) => string
addToast: (
toast: Omit<import('./context/toasts').TLUiToast, 'id'> & {
id?: string | undefined
}
) => string
clearDialogs: () => void
clearToasts: () => void
isMobile: boolean
msg: (id?: string | undefined) => string
removeDialog: (id: string) => string
removeToast: (id: string) => string
updateDialog: (
id: string,
newDialogData: Partial<import('./context/dialogs').TLUiDialog>
) => string
}
>
tools: import('./overrides').TLUiOverride<
import('./hooks/useTools').TLUiToolsContextType,
{
insertMedia: () => void
} & {
addDialog: (
dialog: Omit<import('./context/dialogs').TLUiDialog, 'id'> & {
id?: string | undefined
}
) => string
addToast: (
toast: Omit<import('./context/toasts').TLUiToast, 'id'> & {
id?: string | undefined
}
) => string
clearDialogs: () => void
clearToasts: () => void
isMobile: boolean
msg: (id?: string | undefined) => string
removeDialog: (id: string) => string
removeToast: (id: string) => string
updateDialog: (
id: string,
newDialogData: Partial<import('./context/dialogs').TLUiDialog>
) => string
}
>
translations: Record<string, Record<string, string>> | undefined
}>[]
| undefined
renderDebugMenuItems?: (() => React.ReactNode) | undefined
}>
References
TLUiActionsMenuProps, TLUiContextMenuProps, TLUiHelperButtonsProps, TLUiHelpMenuProps, TLUiKeyboardShortcutsDialogProps, TLUiMainMenuProps, TLUiQuickActionsProps, TLUiStylePanelProps, TLUiZoomMenuProps, TLUiEventHandler, TLUiActionsContextType, TLUiDialog, TLUiToast, TLUiToolsContextType
Source