tldraw 3.16.0-canary.fa3749606e52 → 3.16.0-next.34fddf633325

package/src/lib/ui/components/primitives/TldrawUiTooltip.tsx

@@ -0,0 +1,313 @@
+import { Editor, uniqueId, useMaybeEditor, Vec } from '@tldraw/editor'
+import { Tooltip as _Tooltip } from 'radix-ui'
+import React, { createContext, useContext, useEffect, useRef, useState } from 'react'
+import { usePrefersReducedMotion } from '../../../shapes/shared/usePrefersReducedMotion'
+
+const DEFAULT_TOOLTIP_DELAY_MS = 700
+
+/** @public */
+export interface TldrawUiTooltipProps {
+	children: React.ReactNode
+	content?: string | React.ReactNode
+	side?: 'top' | 'right' | 'bottom' | 'left'
+	sideOffset?: number
+	disabled?: boolean
+}
+
+// Singleton tooltip manager
+class TooltipManager {
+	private static instance: TooltipManager | null = null
+	private currentTooltipId: string | null = null
+	private currentContent: string | React.ReactNode = ''
+	private currentSide: 'top' | 'right' | 'bottom' | 'left' = 'bottom'
+	private currentSideOffset: number = 5
+	private destroyTimeoutId: number | null = null
+	private subscribers: Set<() => void> = new Set()
+	private activeElement: HTMLElement | null = null
+	private editor: Editor | null = null
+
+	static getInstance(): TooltipManager {
+		if (!TooltipManager.instance) {
+			TooltipManager.instance = new TooltipManager()
+		}
+		return TooltipManager.instance
+	}
+
+	setEditor(editor: Editor | null) {
+		this.editor = editor
+	}
+
+	subscribe(callback: () => void): () => void {
+		this.subscribers.add(callback)
+		return () => this.subscribers.delete(callback)
+	}
+
+	private notify() {
+		this.subscribers.forEach((callback) => callback())
+	}
+
+	showTooltip(
+		tooltipId: string,
+		content: string | React.ReactNode,
+		element: HTMLElement,
+		side: 'top' | 'right' | 'bottom' | 'left' = 'bottom',
+		sideOffset: number = 5
+	) {
+		// Clear any existing destroy timeout
+		if (this.destroyTimeoutId) {
+			clearTimeout(this.destroyTimeoutId)
+			this.destroyTimeoutId = null
+		}
+
+		// Update current tooltip
+		this.currentTooltipId = tooltipId
+		this.currentContent = content
+		this.currentSide = side
+		this.currentSideOffset = sideOffset
+		this.activeElement = element
+
+		this.notify()
+	}
+
+	hideTooltip(tooltipId: string) {
+		// Only hide if this is the current tooltip
+		if (this.currentTooltipId === tooltipId) {
+			// Start destroy timeout (1 second)
+			if (this.editor) {
+				this.destroyTimeoutId = this.editor.timers.setTimeout(() => {
+					this.currentTooltipId = null
+					this.currentContent = ''
+					this.activeElement = null
+					this.destroyTimeoutId = null
+					this.notify()
+				}, 300)
+			}
+		}
+	}
+
+	getCurrentTooltipData() {
+		return {
+			id: this.currentTooltipId,
+			content: this.currentContent,
+			side: this.currentSide,
+			sideOffset: this.currentSideOffset,
+			element: this.activeElement,
+		}
+	}
+}
+
+const tooltipManager = TooltipManager.getInstance()
+
+// Context for the tooltip singleton
+const TooltipSingletonContext = createContext<boolean>(false)
+
+/** @public */
+export interface TldrawUiTooltipProviderProps {
+	children: React.ReactNode
+}
+
+/** @public @react */
+export function TldrawUiTooltipProvider({ children }: TldrawUiTooltipProviderProps) {
+	return (
+		<_Tooltip.Provider skipDelayDuration={700}>
+			<TooltipSingletonContext.Provider value={true}>
+				{children}
+				<TooltipSingleton />
+			</TooltipSingletonContext.Provider>
+		</_Tooltip.Provider>
+	)
+}
+
+// The singleton tooltip component that renders once
+function TooltipSingleton() {
+	const editor = useMaybeEditor()
+	const [, forceUpdate] = useState({})
+	const [isOpen, setIsOpen] = useState(false)
+	const triggerRef = useRef<HTMLDivElement>(null)
+	const previousPositionRef = useRef<{ x: number; y: number } | null>(null)
+	const prefersReducedMotion = usePrefersReducedMotion()
+	const [shouldAnimate, setShouldAnimate] = useState(false)
+	const isFirstShowRef = useRef(true)
+	const showTimeoutRef = useRef<number | null>(null)
+
+	// Set editor in tooltip manager
+	useEffect(() => {
+		tooltipManager.setEditor(editor)
+	}, [editor])
+
+	// Subscribe to tooltip manager updates
+	useEffect(() => {
+		const unsubscribe = tooltipManager.subscribe(() => {
+			forceUpdate({})
+		})
+		return unsubscribe
+	}, [])
+
+	const tooltipData = tooltipManager.getCurrentTooltipData()
+
+	// Update open state and trigger position
+	useEffect(() => {
+		const shouldBeOpen = Boolean(tooltipData.id && tooltipData.element)
+
+		// Clear any existing show timeout
+		if (showTimeoutRef.current) {
+			clearTimeout(showTimeoutRef.current)
+			showTimeoutRef.current = null
+		}
+
+		if (shouldBeOpen && tooltipData.element && triggerRef.current) {
+			// Position the invisible trigger element over the active element
+			const activeRect = tooltipData.element.getBoundingClientRect()
+			const trigger = triggerRef.current
+
+			const newPosition = {
+				x: activeRect.left + activeRect.width / 2,
+				y: activeRect.top + activeRect.height / 2,
+			}
+
+			// Determine if we should animate
+			let shouldAnimateCheck = false
+			if (previousPositionRef.current) {
+				const isNearPrevious = Vec.DistMin(previousPositionRef.current, newPosition, 200)
+				// Only animate if the distance is less than 200px (nearby tooltips)
+				shouldAnimateCheck =
+					!prefersReducedMotion &&
+					isNearPrevious &&
+					Math.abs(newPosition.y - previousPositionRef.current.y) < 50
+			}
+			// Don't animate on initial show (previousPositionRef.current is null)
+
+			setShouldAnimate(isFirstShowRef.current ? false : shouldAnimateCheck)
+			previousPositionRef.current = newPosition
+
+			trigger.style.position = 'fixed'
+			trigger.style.left = `${activeRect.left}px`
+			trigger.style.top = `${activeRect.top}px`
+			trigger.style.width = `${activeRect.width}px`
+			trigger.style.height = `${activeRect.height}px`
+			trigger.style.pointerEvents = 'none'
+			trigger.style.zIndex = '9999'
+
+			// Handle delay for first show
+			if (isFirstShowRef.current && editor) {
+				showTimeoutRef.current = editor.timers.setTimeout(() => {
+					setIsOpen(true)
+					isFirstShowRef.current = false
+				}, editor.options.tooltipDelayMs)
+			} else {
+				// Subsequent tooltips show immediately
+				setIsOpen(true)
+			}
+		} else if (!shouldBeOpen) {
+			// Hide tooltip immediately
+			setIsOpen(false)
+			// Reset position tracking when tooltip closes
+			previousPositionRef.current = null
+			setShouldAnimate(false)
+			// Reset first show state after tooltip is hidden
+			isFirstShowRef.current = true
+		}
+	}, [tooltipData.id, tooltipData.element, editor, prefersReducedMotion])
+
+	if (!tooltipData.id) {
+		return null
+	}
+
+	return (
+		<_Tooltip.Root open={isOpen} delayDuration={0}>
+			<_Tooltip.Trigger asChild>
+				<div ref={triggerRef} />
+			</_Tooltip.Trigger>
+			<_Tooltip.Content
+				className="tlui-tooltip"
+				data-should-animate={shouldAnimate}
+				side={tooltipData.side}
+				sideOffset={tooltipData.sideOffset}
+				avoidCollisions
+				collisionPadding={8}
+				dir="ltr"
+			>
+				{tooltipData.content}
+				<_Tooltip.Arrow className="tlui-tooltip__arrow" />
+			</_Tooltip.Content>
+		</_Tooltip.Root>
+	)
+}
+
+/** @public @react */
+export function TldrawUiTooltip({
+	children,
+	content,
+	side = 'bottom',
+	sideOffset = 5,
+	disabled = false,
+}: TldrawUiTooltipProps) {
+	const editor = useMaybeEditor()
+	const tooltipId = useRef<string>(uniqueId())
+	const hasProvider = useContext(TooltipSingletonContext)
+
+	// Don't show tooltip if disabled, no content, or UI labels are disabled
+	if (disabled || !content) {
+		return <>{children}</>
+	}
+
+	// Fallback to old behavior if no provider
+	if (!hasProvider) {
+		return (
+			<_Tooltip.Root
+				delayDuration={editor?.options.tooltipDelayMs || DEFAULT_TOOLTIP_DELAY_MS}
+				disableHoverableContent
+			>
+				<_Tooltip.Trigger asChild>{children}</_Tooltip.Trigger>
+				<_Tooltip.Content
+					className="tlui-tooltip"
+					side={side}
+					sideOffset={sideOffset}
+					avoidCollisions
+					collisionPadding={8}
+					dir="ltr"
+				>
+					{content}
+					<_Tooltip.Arrow className="tlui-tooltip__arrow" />
+				</_Tooltip.Content>
+			</_Tooltip.Root>
+		)
+	}
+
+	const handleMouseEnter = (event: React.MouseEvent<HTMLElement>) => {
+		tooltipManager.showTooltip(
+			tooltipId.current,
+			content,
+			event.currentTarget as HTMLElement,
+			side,
+			sideOffset
+		)
+	}
+
+	const handleMouseLeave = () => {
+		tooltipManager.hideTooltip(tooltipId.current)
+	}
+
+	const handleFocus = (event: React.FocusEvent<HTMLElement>) => {
+		tooltipManager.showTooltip(
+			tooltipId.current,
+			content,
+			event.currentTarget as HTMLElement,
+			side,
+			sideOffset
+		)
+	}
+
+	const handleBlur = () => {
+		tooltipManager.hideTooltip(tooltipId.current)
+	}
+
+	const childrenWithHandlers = React.cloneElement(children as React.ReactElement, {
+		onMouseEnter: handleMouseEnter,
+		onMouseLeave: handleMouseLeave,
+		onFocus: handleFocus,
+		onBlur: handleBlur,
+	})
+
+	return childrenWithHandlers
+}

package/src/lib/ui/components/primitives/menus/TldrawUiMenuItem.tsx

@@ -1,17 +1,9 @@
-import {
-	exhaustiveSwitchError,
-	getPointerInfo,
-	preventDefault,
-	TLPointerEventInfo,
-	useEditor,
-	Vec,
-} from '@tldraw/editor'
+import { exhaustiveSwitchError, preventDefault } from '@tldraw/editor'
 import { ContextMenu as _ContextMenu } from 'radix-ui'
-import { useMemo, useState } from 'react'
+import { useState } from 'react'
 import { unwrapLabel } from '../../../context/actions'
 import { TLUiEventSource } from '../../../context/events'
 import { useReadonly } from '../../../hooks/useReadonly'
-import { TLUiToolItem } from '../../../hooks/useTools'
 import { TLUiTranslationKey } from '../../../hooks/useTranslation/TLUiTranslationKey'
 import { useTranslation } from '../../../hooks/useTranslation/useTranslation'
 import { kbdStr } from '../../../kbd-utils'
@@ -71,10 +63,6 @@ export interface TLUiMenuItemProps<
 	 * Whether the item is selected.
 	 */
 	isSelected?: boolean
-	/**
-	 * The function to call when the item is dragged. If this is provided, the item will be draggable.
-	 */
-	onDragStart?(source: TLUiEventSource, info: TLPointerEventInfo): void
 }
 
 /** @public @react */
@@ -93,7 +81,6 @@ export function TldrawUiMenuItem<
 	onSelect,
 	noClose,
 	isSelected,
-	onDragStart,
 }: TLUiMenuItemProps<TranslationKey, IconType>) {
 	const { type: menuType, sourceId } = useTldrawUiMenuContext()
 
@@ -220,20 +207,6 @@ export function TldrawUiMenuItem<
 			)
 		}
 		case 'toolbar': {
-			if (onDragStart) {
-				return (
-					<DraggableToolbarButton
-						id={id}
-						icon={icon}
-						onSelect={onSelect}
-						onDragStart={onDragStart}
-						labelToUse={labelToUse}
-						titleStr={titleStr}
-						disabled={disabled}
-						isSelected={isSelected}
-					/>
-				)
-			}
 			return (
 				<TldrawUiToolbarButton
 					aria-label={labelStr}
@@ -254,21 +227,6 @@ export function TldrawUiMenuItem<
 			)
 		}
 		case 'toolbar-overflow': {
-			if (onDragStart) {
-				return (
-					<DraggableToolbarButton
-						id={id}
-						icon={icon}
-						onSelect={onSelect}
-						onDragStart={onDragStart}
-						labelToUse={labelToUse}
-						titleStr={titleStr}
-						disabled={disabled}
-						isSelected={isSelected}
-						overflow
-					/>
-				)
-			}
 			return (
 				<TldrawUiToolbarButton
 					aria-label={labelStr}
@@ -291,172 +249,3 @@ export function TldrawUiMenuItem<
 		}
 	}
 }
-
-function useDraggableEvents(
-	onDragStart: TLUiToolItem['onDragStart'],
-	onSelect: TLUiToolItem['onSelect']
-) {
-	const editor = useEditor()
-	const events = useMemo(() => {
-		let state = { name: 'idle' } as
-			| {
-					name: 'idle'
-			  }
-			| {
-					name: 'pointing'
-					start: Vec
-			  }
-			| {
-					name: 'dragging'
-					start: Vec
-			  }
-			| {
-					name: 'dragged'
-			  }
-
-		function handlePointerDown(e: React.PointerEvent<HTMLButtonElement>) {
-			state = {
-				name: 'pointing',
-				start: editor.inputs.currentPagePoint.clone(),
-			}
-
-			e.currentTarget.setPointerCapture(e.pointerId)
-		}
-
-		function handlePointerMove(e: React.PointerEvent<HTMLButtonElement>) {
-			if ((e as any).isSpecialRedispatchedEvent) return
-
-			if (state.name === 'pointing') {
-				const distance = Vec.Dist2(state.start, editor.inputs.currentPagePoint)
-				if (
-					distance >
-					(editor.getInstanceState().isCoarsePointer
-						? editor.options.coarseDragDistanceSquared
-						: editor.options.dragDistanceSquared)
-				) {
-					const start = state.start
-					state = {
-						name: 'dragging',
-						start,
-					}
-
-					editor.run(() => {
-						// Set origin point
-						editor.dispatch({
-							type: 'pointer',
-							target: 'canvas',
-							name: 'pointer_down',
-							...getPointerInfo(e),
-							point: start,
-						})
-
-						// Pointer down potentially selects shapes, so we need to deselect them.
-						editor.selectNone()
-
-						// start drag
-						onDragStart?.('toolbar', {
-							type: 'pointer',
-							target: 'canvas',
-							name: 'pointer_move',
-							...getPointerInfo(e),
-						})
-					})
-				}
-			}
-		}
-
-		function handlePointerUp(e: React.PointerEvent<HTMLButtonElement>) {
-			if ((e as any).isSpecialRedispatchedEvent) return
-
-			e.currentTarget.releasePointerCapture(e.pointerId)
-
-			editor.dispatch({
-				type: 'pointer',
-				target: 'canvas',
-				name: 'pointer_up',
-				...getPointerInfo(e),
-			})
-		}
-
-		function handleClick() {
-			if (state.name === 'dragging' || state.name === 'dragged') {
-				state = { name: 'idle' }
-				return true
-			}
-
-			state = { name: 'idle' }
-			onSelect?.('toolbar')
-		}
-
-		return {
-			onPointerDown: handlePointerDown,
-			onPointerMove: handlePointerMove,
-			onPointerUp: handlePointerUp,
-			onClick: handleClick,
-		}
-	}, [onDragStart, editor, onSelect])
-
-	return events
-}
-
-function DraggableToolbarButton({
-	id,
-	labelToUse,
-	titleStr,
-	disabled,
-	isSelected,
-	icon,
-	onSelect,
-	onDragStart,
-	overflow,
-}: {
-	id: string
-	disabled: boolean
-	labelToUse?: string
-	titleStr?: string
-	isSelected?: boolean
-	icon: TLUiMenuItemProps['icon']
-	onSelect: TLUiMenuItemProps['onSelect']
-	onDragStart: TLUiMenuItemProps['onDragStart']
-	overflow?: boolean
-}) {
-	const events = useDraggableEvents(onDragStart, onSelect)
-
-	if (overflow) {
-		return (
-			<TldrawUiToolbarButton
-				aria-label={labelToUse}
-				aria-pressed={isSelected ? 'true' : 'false'}
-				isActive={isSelected}
-				className="tlui-button-grid__button"
-				data-testid={`tools.more.${id}`}
-				data-value={id}
-				disabled={disabled}
-				title={titleStr}
-				type="icon"
-				{...events}
-			>
-				<TldrawUiButtonIcon icon={icon!} />
-			</TldrawUiToolbarButton>
-		)
-	}
-
-	return (
-		<TldrawUiToolbarButton
-			aria-label={labelToUse}
-			aria-pressed={isSelected ? 'true' : 'false'}
-			data-testid={`tools.${id}`}
-			data-value={id}
-			disabled={disabled}
-			onTouchStart={(e) => {
-				preventDefault(e)
-				onSelect('toolbar')
-			}}
-			title={titleStr}
-			type="tool"
-			{...events}
-		>
-			<TldrawUiButtonIcon icon={icon!} />
-		</TldrawUiToolbarButton>
-	)
-}

package/src/lib/ui/context/TldrawUiContextProvider.tsx

@@ -1,6 +1,7 @@
 import { RecursivePartial, defaultUserPreferences, track, useMaybeEditor } from '@tldraw/editor'
 import { ReactNode } from 'react'
 import { TLUiAssetUrls, useDefaultUiAssetUrlsWithOverrides } from '../assetUrls'
+import { TldrawUiTooltipProvider } from '../components/primitives/TldrawUiTooltip'
 import { ToolsProvider } from '../hooks/useTools'
 import { TldrawUiTranslationProvider } from '../hooks/useTranslation/useTranslation'
 import {
@@ -72,26 +73,28 @@ export const TldrawUiContextProvider = track(function TldrawUiContextProvider({
 	const editor = useMaybeEditor()
 	return (
 		<MimeTypeContext.Provider value={mediaMimeTypes}>
-			<AssetUrlsProvider assetUrls={useDefaultUiAssetUrlsWithOverrides(assetUrls)}>
-				<TldrawUiTranslationProvider
-					overrides={useMergedTranslationOverrides(overrides)}
-					locale={editor?.user.getLocale() ?? defaultUserPreferences.locale}
-				>
-					<TldrawUiEventsProvider onEvent={onUiEvent}>
-						<TldrawUiToastsProvider>
-							<TldrawUiDialogsProvider context={'tla'}>
-								<TldrawUiA11yProvider>
-									<BreakPointProvider forceMobile={forceMobile}>
-										<TldrawUiComponentsProvider overrides={components}>
-											<InternalProviders overrides={overrides}>{children}</InternalProviders>
-										</TldrawUiComponentsProvider>
-									</BreakPointProvider>
-								</TldrawUiA11yProvider>
-							</TldrawUiDialogsProvider>
-						</TldrawUiToastsProvider>
-					</TldrawUiEventsProvider>
-				</TldrawUiTranslationProvider>
-			</AssetUrlsProvider>
+			<TldrawUiTooltipProvider>
+				<AssetUrlsProvider assetUrls={useDefaultUiAssetUrlsWithOverrides(assetUrls)}>
+					<TldrawUiTranslationProvider
+						overrides={useMergedTranslationOverrides(overrides)}
+						locale={editor?.user.getLocale() ?? defaultUserPreferences.locale}
+					>
+						<TldrawUiEventsProvider onEvent={onUiEvent}>
+							<TldrawUiToastsProvider>
+								<TldrawUiDialogsProvider context={'tla'}>
+									<TldrawUiA11yProvider>
+										<BreakPointProvider forceMobile={forceMobile}>
+											<TldrawUiComponentsProvider overrides={components}>
+												<InternalProviders overrides={overrides}>{children}</InternalProviders>
+											</TldrawUiComponentsProvider>
+										</BreakPointProvider>
+									</TldrawUiA11yProvider>
+								</TldrawUiDialogsProvider>
+							</TldrawUiToastsProvider>
+						</TldrawUiEventsProvider>
+					</TldrawUiTranslationProvider>
+				</AssetUrlsProvider>
+			</TldrawUiTooltipProvider>
 		</MimeTypeContext.Provider>
 	)
 })

package/src/lib/ui/context/actions.tsx

@@ -1266,6 +1266,21 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
 				},
 				checkbox: true,
 			},
+			{
+				id: 'toggle-ui-labels',
+				label: {
+					default: 'action.toggle-ui-labels',
+					menu: 'action.toggle-ui-labels.menu',
+				},
+				readonlyOk: true,
+				onSelect(source) {
+					trackEvent('toggle-ui-labels', { source })
+					editor.user.updateUserPreferences({
+						showUiLabels: !editor.user.getShowUiLabels(),
+					})
+				},
+				checkbox: true,
+			},
 			{
 				id: 'toggle-edge-scrolling',
 				label: {

package/src/lib/ui/context/events.tsx

@@ -108,6 +108,7 @@ export interface TLUiEventMap {
 	'toggle-lock': null
 	'toggle-reduce-motion': null
 	'toggle-keyboard-shortcuts': null
+	'toggle-ui-labels': null
 	'toggle-edge-scrolling': null
 	'color-scheme': { value: string }
 	'exit-pen-mode': null
@@ -126,7 +127,6 @@ export interface TLUiEventMap {
 	'open-context-menu': null
 	'adjust-shape-styles': null
 	'copy-link': null
-	'drag-tool': { id: string }
 	'image-replace': null
 	'video-replace': null
 	'open-kbd-shortcuts': null