Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

Fix if mouse leaves Tooltip.Content and moves over an iframe, the Radix Tooltip stays open (#2076)

Ivan Starkov81b60abbb948
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsx
index 942d01d943..953999ceeb 100644
--- a/apps/builder/app/builder/builder.tsx
+++ b/apps/builder/app/builder/builder.tsx
@@ -11,7 +11,6 @@ import { useSyncServer } from "./shared/sync/sync-server";
import { useSharedShortcuts } from "~/shared/shortcuts";
import { SidebarLeft, Navigator } from "./features/sidebar-left";
import { Inspector } from "./features/inspector";
-import { isCanvasPointerEventsEnabledStore } from "./shared/nano-states";
import { Topbar } from "./features/topbar";
import builderStyles from "./builder.css";
// eslint-disable-next-line import/no-internal-modules
@@ -286,9 +285,6 @@ export const Builder = ({
},
[publishRef, onRefReadCanvas]
);
- const isCanvasPointerEventsEnabled = useStore(
- isCanvasPointerEventsEnabledStore
- );
const navigatorLayout = useNavigatorLayout();
@@ -306,7 +302,6 @@ export const Builder = ({
<CanvasIframe
ref={iframeRefCallback}
src={canvasUrl}
- pointerEvents={isCanvasPointerEventsEnabled ? "auto" : "none"}
title={project.title}
css={{
height: "100%",
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/components/use-draggable.tsx b/apps/builder/app/builder/features/sidebar-left/panels/components/use-draggable.tsx
index 4e4f52ed07..282646543a 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/components/use-draggable.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/panels/components/use-draggable.tsx
@@ -9,6 +9,8 @@ import {
useDrag,
ComponentCard,
toast,
+ enableCanvasPointerEvents,
+ disableCanvasPointerEvents,
} from "@webstudio-is/design-system";
import {
instancesStore,
@@ -17,11 +19,7 @@ import {
selectedPageStore,
} from "~/shared/nano-states";
import { useSubscribe, type Publish } from "~/shared/pubsub";
-import {
- canvasRectStore,
- isCanvasPointerEventsEnabledStore,
- scaleStore,
-} from "~/builder/shared/nano-states";
+import { canvasRectStore, scaleStore } from "~/builder/shared/nano-states";
import {
computeInstancesConstraints,
findClosestDroppableTarget,
@@ -144,7 +142,7 @@ export const useDraggable = ({
dragComponent: componentName,
},
});
- isCanvasPointerEventsEnabledStore.set(false);
+ disableCanvasPointerEvents();
},
onMove: (point) => {
setPoint(point);
@@ -161,7 +159,8 @@ export const useDraggable = ({
type: "dragEnd",
payload: { isCanceled },
});
- isCanvasPointerEventsEnabledStore.set(true);
+
+ enableCanvasPointerEvents();
},
});
diff --git a/apps/builder/app/builder/features/style-panel/shared/color-picker.tsx b/apps/builder/app/builder/features/style-panel/shared/color-picker.tsx
index 39714da58f..cff3c8d202 100644
--- a/apps/builder/app/builder/features/style-panel/shared/color-picker.tsx
+++ b/apps/builder/app/builder/features/style-panel/shared/color-picker.tsx
@@ -1,4 +1,4 @@
-import { useEffect, useState } from "react";
+import { useState } from "react";
import { colord, extend, type RgbaColor } from "colord";
import namesPlugin from "colord/plugins/names";
import { type ColorResult, type RGBColor, SketchPicker } from "react-color";
@@ -14,14 +14,14 @@ import {
PopoverTrigger,
PopoverContent,
css,
+ enableCanvasPointerEvents,
+ disableCanvasPointerEvents,
} from "@webstudio-is/design-system";
import { toValue } from "@webstudio-is/css-engine";
import { theme } from "@webstudio-is/design-system";
import type { StyleSource } from "./style-info";
import { CssValueInput } from "./css-value-input";
import type { IntermediateStyleValue } from "./css-value-input/css-value-input";
-import { isCanvasPointerEventsEnabledStore } from "~/builder/shared/nano-states";
-import { useStore } from "@nanostores/react";
import { ColorThumb } from "./color-thumb";
// To support color names
@@ -88,35 +88,6 @@ const styleValueToRgbaColor = (value: CssColorPickerValueInput): RgbaColor => {
};
};
-// Dragging over canvas iframe with CORS policies will lead to loosing events and getting stuck in mousedown state.
-const useFixDragOverCanvas = () => {
- const isCanvasPointerEventsEnabled = useStore(
- isCanvasPointerEventsEnabledStore
- );
-
- useEffect(() => {
- const handleMouseUp = () => {
- isCanvasPointerEventsEnabledStore.set(true);
- removeEventListener("mouseup", handleMouseUp);
- };
- if (isCanvasPointerEventsEnabled === false) {
- addEventListener("mouseup", handleMouseUp);
- }
- return () => {
- removeEventListener("mouseup", handleMouseUp);
- };
- }, [isCanvasPointerEventsEnabled]);
-
- const handleChange = (event: MouseEvent) => {
- // Prevents selection of text during drag.
- if (event.type === "mousedown") {
- event.preventDefault();
- isCanvasPointerEventsEnabledStore.set(false);
- }
- };
- return { handleChange };
-};
-
export type CssColorPickerValueInput =
| RgbValue
| KeywordValue
@@ -151,7 +122,6 @@ export const ColorPicker = ({
property,
}: ColorPickerProps) => {
const [displayColorPicker, setDisplayColorPicker] = useState(false);
- const canvasFix = useFixDragOverCanvas();
const currentValue =
intermediateValue ?? styleValueResolve(value, currentColor);
@@ -196,12 +166,18 @@ export const ColorPicker = ({
return colorResultToRgbValue(newColor);
};
+ const handleOpenChange = (open: boolean) => {
+ setDisplayColorPicker(open);
+ if (open) {
+ // Dragging over canvas iframe with CORS policies will lead to loosing events and getting stuck in mousedown state.
+ disableCanvasPointerEvents();
+ return;
+ }
+ enableCanvasPointerEvents();
+ };
+
const prefix = (
- <Popover
- modal
- open={displayColorPicker}
- onOpenChange={setDisplayColorPicker}
- >
+ <Popover modal open={displayColorPicker} onOpenChange={handleOpenChange}>
<PopoverTrigger
asChild
aria-label="Open color picker"
@@ -214,8 +190,10 @@ export const ColorPicker = ({
<SketchPicker
color={rgbValue}
onChange={(color: ColorResult, event) => {
- // SketchPicker event can be mouse event, type is wrong.
- canvasFix.handleChange(event as unknown as MouseEvent);
+ // Prevents selection of text during drag.
+ if (event.type === "mousedown") {
+ event.preventDefault();
+ }
const newColor = fixColor(color);
onChange(newColor);
}}
diff --git a/apps/builder/app/builder/features/workspace/canvas-iframe.tsx b/apps/builder/app/builder/features/workspace/canvas-iframe.tsx
index 4727c50272..59e098408b 100644
--- a/apps/builder/app/builder/features/workspace/canvas-iframe.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-iframe.tsx
@@ -1,32 +1,22 @@
import { forwardRef } from "react";
-import { type CSS, css } from "@webstudio-is/design-system";
+import {
+ type CSS,
+ css,
+ canvasPointerEventsPropertyName,
+} from "@webstudio-is/design-system";
const iframeStyle = css({
border: "none",
- variants: {
- pointerEvents: {
- none: {
- pointerEvents: "none",
- },
- auto: {},
- },
- },
+ pointerEvents: `var(${canvasPointerEventsPropertyName})`,
});
type CanvasIframeProps = {
- pointerEvents: "auto" | "none";
css: CSS;
} & JSX.IntrinsicElements["iframe"];
export const CanvasIframe = forwardRef<HTMLIFrameElement, CanvasIframeProps>(
- ({ pointerEvents = "auto", css, ...rest }, ref) => {
- return (
- <iframe
- {...rest}
- ref={ref}
- className={iframeStyle({ pointerEvents, css })}
- />
- );
+ ({ css, ...rest }, ref) => {
+ return <iframe {...rest} ref={ref} className={iframeStyle({ css })} />;
}
);
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/resize-handles.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/resize-handles.tsx
index 5f2cb7c501..186d47de46 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/resize-handles.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/resize-handles.tsx
@@ -1,11 +1,14 @@
import { useStore } from "@nanostores/react";
import { findApplicableMedia } from "@webstudio-is/css-engine";
-import { css, numericScrubControl, theme } from "@webstudio-is/design-system";
-import { useEffect, useRef } from "react";
import {
- canvasWidthStore,
- isCanvasPointerEventsEnabledStore,
-} from "~/builder/shared/nano-states";
+ css,
+ disableCanvasPointerEvents,
+ enableCanvasPointerEvents,
+ numericScrubControl,
+ theme,
+} from "@webstudio-is/design-system";
+import { useEffect, useRef } from "react";
+import { canvasWidthStore } from "~/builder/shared/nano-states";
import { minCanvasWidth } from "~/shared/breakpoints";
import {
breakpointsStore,
@@ -113,11 +116,11 @@ const useScrub = ({ side }: { side: "right" | "left" }) => {
},
onStatusChange(status) {
if (status === "scrubbing") {
- isCanvasPointerEventsEnabledStore.set(false);
+ disableCanvasPointerEvents();
isResizingCanvasStore.set(true);
return;
}
- isCanvasPointerEventsEnabledStore.set(true);
+ enableCanvasPointerEvents();
isResizingCanvasStore.set(false);
},
onValueInput(event) {
diff --git a/apps/builder/app/builder/shared/nano-states/index.ts b/apps/builder/app/builder/shared/nano-states/index.ts
index cc3878d2ac..ae5f0b69b8 100644
--- a/apps/builder/app/builder/shared/nano-states/index.ts
+++ b/apps/builder/app/builder/shared/nano-states/index.ts
@@ -17,8 +17,6 @@ export const useCanvasWidth = () => useValue(canvasWidthStore);
export const canvasRectStore = atom<DOMRect | undefined>();
-export const isCanvasPointerEventsEnabledStore = atom<boolean>(true);
-
export const workspaceRectStore = atom<DOMRect | undefined>();
export const scaleStore = computed(
diff --git a/packages/design-system/package.json b/packages/design-system/package.json
index 9631b580c8..69f14ebe9b 100644
--- a/packages/design-system/package.json
+++ b/packages/design-system/package.json
@@ -61,6 +61,7 @@
"@radix-ui/react-toggle-group": "^1.0.4",
"@radix-ui/react-toolbar": "^1.0.4",
"@radix-ui/react-tooltip": "^1.0.6",
+ "@radix-ui/react-use-controllable-state": "^1.0.1",
"@react-aria/focus": "^3.13.0",
"@react-aria/interactions": "^3.16.0",
"@react-aria/utils": "^3.18.0",
@@ -73,7 +74,8 @@
"match-sorter": "^6.3.1",
"react-hot-toast": "^2.4.1",
"token-transformer": "^0.0.28",
- "use-debounce": "^9.0.4"
+ "use-debounce": "^9.0.4",
+ "warn-once": "^0.1.1"
},
"exports": {
"source": "./src/index.ts",
diff --git a/packages/design-system/src/components/tooltip.tsx b/packages/design-system/src/components/tooltip.tsx
index 2e50927271..42ae9d60a3 100644
--- a/packages/design-system/src/components/tooltip.tsx
+++ b/packages/design-system/src/components/tooltip.tsx
@@ -1,11 +1,17 @@
import type { Ref, ComponentProps, ReactNode, ReactElement } from "react";
-import { Fragment, forwardRef } from "react";
+import { Fragment, forwardRef, useEffect, useRef } from "react";
import { styled } from "../stitches.config";
import * as TooltipPrimitive from "@radix-ui/react-tooltip";
+import { useControllableState } from "@radix-ui/react-use-controllable-state";
import { Box } from "./box";
import { Text } from "./text";
import type { CSS } from "../stitches.config";
import { theme } from "../stitches.config";
+import warnOnce from "warn-once";
+import {
+ disableCanvasPointerEvents,
+ enableCanvasPointerEvents,
+} from "../utilities";
export type TooltipProps = ComponentProps<typeof TooltipPrimitive.Root> &
Omit<ComponentProps<typeof Content>, "content"> & {
@@ -42,6 +48,32 @@ const Arrow = styled(TooltipPrimitive.Arrow, {
marginTop: -0.5,
});
+let openTooltipsCount = 0;
+
+/**
+ * When the mouse leaves Tooltip.Content and moves over an iframe, the Radix Tooltip stays open.
+ * This happens because Radix's internal grace area relies on the pointermove event, which isn't triggered over iframes.
+ * The current workaround is to set pointer-events: none on the canvas when the tooltip is open.
+ **/
+const handleTooltipOpenChange = (open: boolean) => {
+ if (openTooltipsCount < 0) {
+ // Should be impossible but in case if we've missed a tooltip open/close event,
+ // just enable events and stop this algorithm, to preserve system in working state
+ warnOnce(true, "Tooltip counter can't be less than 0");
+ enableCanvasPointerEvents();
+ return;
+ }
+
+ // Multiple tooltips can open simultaneously. Use a counter instead of a boolean to manage them.
+ openTooltipsCount = openTooltipsCount + (open ? 1 : -1);
+
+ if (openTooltipsCount > 0) {
+ disableCanvasPointerEvents();
+ }
+
+ enableCanvasPointerEvents();
+};
+
export const Tooltip = forwardRef(
(
{
@@ -50,7 +82,7 @@ export const Tooltip = forwardRef(
defaultOpen,
delayDuration,
disableHoverableContent,
- open,
+ open: openProp,
onOpenChange,
triggerProps,
...props
@@ -59,6 +91,32 @@ export const Tooltip = forwardRef(
},
ref: Ref<HTMLDivElement>
) => {
+ const isOpenRef = useRef(false);
+
+ // We need to intercept tooltip open
+ const [open = false, setOpen] = useControllableState({
+ prop: openProp,
+ defaultProp: defaultOpen,
+ onChange: (open) => {
+ onOpenChange?.(open);
+ },
+ });
+
+ // Manage scenarios where defaultOpen or open is initially set, or when the tooltip is unmounted.
+ useEffect(() => {
+ if (isOpenRef.current !== open) {
+ handleTooltipOpenChange(open);
+ isOpenRef.current = open;
+ }
+
+ return () => {
+ if (isOpenRef.current) {
+ handleTooltipOpenChange(false);
+ isOpenRef.current = false;
+ }
+ };
+ }, [open]);
+
if (!content) {
return children;
}
@@ -67,7 +125,7 @@ export const Tooltip = forwardRef(
<TooltipPrimitive.Root
open={open}
defaultOpen={defaultOpen}
- onOpenChange={onOpenChange}
+ onOpenChange={setOpen}
delayDuration={delayDuration}
disableHoverableContent={disableHoverableContent}
>
diff --git a/packages/design-system/src/index.ts b/packages/design-system/src/index.ts
index dcca908cdc..ef3003e426 100644
--- a/packages/design-system/src/index.ts
+++ b/packages/design-system/src/index.ts
@@ -1,5 +1,6 @@
export * from "./stitches.config";
export * from "./components/storybook";
+export * from "./utilities";
// Aligned with Figma
diff --git a/packages/design-system/src/utilities.ts b/packages/design-system/src/utilities.ts
new file mode 100644
index 0000000000..faa6c9eb4a
--- /dev/null
+++ b/packages/design-system/src/utilities.ts
@@ -0,0 +1,14 @@
+export const canvasPointerEventsPropertyName = "--canvas-pointer-events";
+
+export const enableCanvasPointerEvents = () => {
+ document.documentElement.style.removeProperty(
+ canvasPointerEventsPropertyName
+ );
+};
+
+export const disableCanvasPointerEvents = () => {
+ document.documentElement.style.setProperty(
+ canvasPointerEventsPropertyName,
+ "none"
+ );
+};
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 22b02c9590..3a568c9878 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -682,6 +682,9 @@ importers:
'@radix-ui/react-tooltip':
specifier: ^1.0.6
+ '@radix-ui/react-use-controllable-state':
+ specifier: ^1.0.1
+ version: 1.0.1(@types/[email protected])([email protected])
'@react-aria/focus':
specifier: ^3.13.0
version: 3.13.0([email protected])
@@ -721,6 +724,9 @@ importers:
use-debounce:
specifier: ^9.0.4
version: 9.0.4([email protected])
+ warn-once:
+ specifier: ^0.1.1
+ version: 0.1.1
devDependencies:
'@jest/globals':
specifier: ^29.6.2