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 ESC to work at unit menu (#680)

Ivan Starkovafe90ba78953
diff --git a/.lostpixel/baseline/components-enhanced-tooltip--simple.png b/.lostpixel/baseline/components-enhanced-tooltip--simple.png
new file mode 100644
index 0000000000..6400b19900
Binary files /dev/null and b/.lostpixel/baseline/components-enhanced-tooltip--simple.png differ
diff --git a/apps/designer/app/designer/features/breakpoints/breakpoints-editor.tsx b/apps/designer/app/designer/features/breakpoints/breakpoints-editor.tsx
index 3c80b4536d..feac43d2c0 100644
--- a/apps/designer/app/designer/features/breakpoints/breakpoints-editor.tsx
+++ b/apps/designer/app/designer/features/breakpoints/breakpoints-editor.tsx
@@ -1,5 +1,5 @@
import { useState } from "react";
-import { useDebounce } from "react-use";
+import { useDebouncedCallback } from "use-debounce";
import { type Breakpoint } from "@webstudio-is/css-data";
import { type Publish } from "~/shared/pubsub";
import { Button, TextField, Flex, Text } from "@webstudio-is/design-system";
@@ -20,14 +20,13 @@ const BreakpointEditorItem = ({
}: BreakpointEditorItemProps) => {
const [breakpoint, setBreakpoint] = useState(initialBreakpoint);
- useDebounce(
- () => {
- if (breakpoint !== initialBreakpoint) {
- onChange(breakpoint);
+ const handleChangeBreakpointDebounced = useDebouncedCallback(
+ (nextBreakpoint: Breakpoint) => {
+ if (nextBreakpoint !== initialBreakpoint) {
+ onChange(nextBreakpoint);
}
},
- 500,
- [breakpoint]
+ 500
);
return (
@@ -48,6 +47,7 @@ const BreakpointEditorItem = ({
minWidth: Number(data.get("minWidth")),
};
setBreakpoint(nextBreakpoint);
+ handleChangeBreakpointDebounced(nextBreakpoint);
}}
>
<Flex
diff --git a/apps/designer/app/designer/features/inspector/inspector.tsx b/apps/designer/app/designer/features/inspector/inspector.tsx
index 11bbb00d07..6e500ddce6 100644
--- a/apps/designer/app/designer/features/inspector/inspector.tsx
+++ b/apps/designer/app/designer/features/inspector/inspector.tsx
@@ -9,6 +9,7 @@ import {
Paragraph,
Box,
Flex,
+ EnhancedTooltipProvider,
} from "@webstudio-is/design-system";
import { StylePanel } from "~/designer/features/style-panel";
import { PropsPanel } from "~/designer/features/props-panel";
@@ -42,34 +43,42 @@ export const Inspector = ({ publish }: InspectorProps) => {
}
return (
- <FloatingPanelProvider container={tabsRef}>
- <Flex as={Tabs} defaultValue="style" ref={tabsRef}>
- <TabsList>
- <TabsTrigger value="style">
- <Text>Style</Text>
- </TabsTrigger>
- {/* @note: events would be part of props */}
- <TabsTrigger value="props">
- <Text>Props</Text>
- </TabsTrigger>
- <TabsTrigger value="inspect">
- <Text>Inspect</Text>
- </TabsTrigger>
- </TabsList>
- <TabsContent value="style" css={contentStyle}>
- <StylePanel
- publish={publish}
- selectedInstanceData={selectedInstanceData}
- />
- </TabsContent>
- <TabsContent value="props" css={contentStyle}>
- <PropsPanel
- publish={publish}
- key={selectedInstanceData.id /* Re-render when instance changes */}
- selectedInstanceData={selectedInstanceData}
- />
- </TabsContent>
- </Flex>
- </FloatingPanelProvider>
+ <EnhancedTooltipProvider
+ delayDuration={1600}
+ disableHoverableContent={false}
+ skipDelayDuration={0}
+ >
+ <FloatingPanelProvider container={tabsRef}>
+ <Flex as={Tabs} defaultValue="style" ref={tabsRef}>
+ <TabsList>
+ <TabsTrigger value="style">
+ <Text>Style</Text>
+ </TabsTrigger>
+ {/* @note: events would be part of props */}
+ <TabsTrigger value="props">
+ <Text>Props</Text>
+ </TabsTrigger>
+ <TabsTrigger value="inspect">
+ <Text>Inspect</Text>
+ </TabsTrigger>
+ </TabsList>
+ <TabsContent value="style" css={contentStyle}>
+ <StylePanel
+ publish={publish}
+ selectedInstanceData={selectedInstanceData}
+ />
+ </TabsContent>
+ <TabsContent value="props" css={contentStyle}>
+ <PropsPanel
+ publish={publish}
+ key={
+ selectedInstanceData.id /* Re-render when instance changes */
+ }
+ selectedInstanceData={selectedInstanceData}
+ />
+ </TabsContent>
+ </Flex>
+ </FloatingPanelProvider>
+ </EnhancedTooltipProvider>
);
};
diff --git a/apps/designer/app/designer/features/sidebar-left/panels/pages/settings.tsx b/apps/designer/app/designer/features/sidebar-left/panels/pages/settings.tsx
index afc17b6776..34fea34938 100644
--- a/apps/designer/app/designer/features/sidebar-left/panels/pages/settings.tsx
+++ b/apps/designer/app/designer/features/sidebar-left/panels/pages/settings.tsx
@@ -18,7 +18,8 @@ import { Header } from "../../lib/header";
import { useState, useCallback, ComponentProps } from "react";
import { type Page } from "@webstudio-is/project";
import { usePages } from "~/designer/shared/nano-states";
-import { useDebounce, useUnmount } from "react-use";
+import { useDebouncedCallback } from "use-debounce";
+import { useUnmount } from "react-use";
import { useOnFetchEnd, usePersistentFetcher } from "~/shared/fetcher";
import {
normalizeErrors,
@@ -357,34 +358,31 @@ export const PageSettings = ({
: fieldNames,
});
- const handleChange = useCallback(
- <Name extends FieldName>(event: { field: Name; value: FormPage[Name] }) => {
- resetFieldError(event.field);
- setUnsavedValues((values) => ({ ...values, [event.field]: event.value }));
- },
- [resetFieldError]
- );
+ const handleSubmitDebounced = useDebouncedCallback(() => {
+ if (Object.keys(unsavedValues).length === 0) {
+ return;
+ }
- useDebounce(
- () => {
- if (Object.keys(unsavedValues).length === 0) {
- return;
- }
+ // We're re-submitting the submittedValues because previous submit is going to be cancelled
+ // (normally, submittedValues are empty at this point)
+ const valuesToSubmit = { ...submittedValues, ...unsavedValues };
- // We're re-submitting the submittedValues because previous submit is going to be cancelled
- // (normally, submittedValues are empty at this point)
- const valuesToSubmit = { ...submittedValues, ...unsavedValues };
+ fetcher.submit(toFormData({ id: pageId, ...valuesToSubmit }), {
+ method: "post",
+ action: restPagesPath({ projectId }),
+ });
- fetcher.submit(toFormData({ id: pageId, ...valuesToSubmit }), {
- method: "post",
- action: restPagesPath({ projectId }),
- });
+ setSubmittedValues(valuesToSubmit);
+ setUnsavedValues({});
+ }, 1000);
- setSubmittedValues(valuesToSubmit);
- setUnsavedValues({});
+ const handleChange = useCallback(
+ <Name extends FieldName>(event: { field: Name; value: FormPage[Name] }) => {
+ resetFieldError(event.field);
+ setUnsavedValues((values) => ({ ...values, [event.field]: event.value }));
+ handleSubmitDebounced();
},
- 1000,
- [unsavedValues]
+ [handleSubmitDebounced, resetFieldError]
);
useUnmount(() => {
diff --git a/apps/designer/app/designer/features/style-panel/controls/text/text-control.tsx b/apps/designer/app/designer/features/style-panel/controls/text/text-control.tsx
index 0d7af630ff..29be0772b3 100644
--- a/apps/designer/app/designer/features/style-panel/controls/text/text-control.tsx
+++ b/apps/designer/app/designer/features/style-panel/controls/text/text-control.tsx
@@ -6,7 +6,7 @@ import { getFinalValue } from "../../shared/get-final-value";
import { ControlProps } from "../../style-sections";
import type { StyleValue } from "@webstudio-is/css-data";
import { useState } from "react";
-import { Box, Tooltip } from "@webstudio-is/design-system";
+import { Box, EnhancedTooltip } from "@webstudio-is/design-system";
export const TextControl = ({
currentStyle,
@@ -29,11 +29,7 @@ export const TextControl = ({
>();
return (
- <Tooltip
- content={styleConfig.label}
- delayDuration={600}
- disableHoverableContent={true}
- >
+ <EnhancedTooltip content={styleConfig.label}>
<Box>
<CssValueInput
icon={icon}
@@ -72,6 +68,6 @@ export const TextControl = ({
}}
/>
</Box>
- </Tooltip>
+ </EnhancedTooltip>
);
};
diff --git a/apps/designer/app/designer/features/style-panel/shared/css-value-input/unit-select.tsx b/apps/designer/app/designer/features/style-panel/shared/css-value-input/unit-select.tsx
index ff16b68c6a..b8369ebe66 100644
--- a/apps/designer/app/designer/features/style-panel/shared/css-value-input/unit-select.tsx
+++ b/apps/designer/app/designer/features/style-panel/shared/css-value-input/unit-select.tsx
@@ -142,7 +142,21 @@ const UnitSelect = ({
</StyledTrigger>
</SelectPrimitive.SelectTrigger>
<SelectPrimitive.Portal>
- <SelectContent onCloseAutoFocus={onCloseAutoFocus}>
+ <SelectContent
+ onCloseAutoFocus={onCloseAutoFocus}
+ onEscapeKeyDown={() => {
+ // We need to use onEscapeKeyDown and close explicitly as we prevented default at onKeyDown
+ // We can't prevent this event here as it's too late and the non-prevented event is already dispatched
+ // to the ancestors
+ onOpenChange(false);
+ }}
+ onKeyDown={(event) => {
+ // Prevent Esc key to be processed at the parent Component
+ if (event.key === "Escape") {
+ event.preventDefault();
+ }
+ }}
+ >
<SelectScrollUpButton>
<ChevronUpIcon />
</SelectScrollUpButton>
diff --git a/apps/designer/package.json b/apps/designer/package.json
index 79d2bc92d2..b56d6f99ec 100644
--- a/apps/designer/package.json
+++ b/apps/designer/package.json
@@ -82,6 +82,7 @@
"remix-auth-google": "^1.1.0",
"remix-utils": "^4.1.0",
"slugify": "^1.6.5",
+ "use-debounce": "^9.0.2",
"uuid": "^9.0.0",
"warn-once": "^0.1.1",
"zod": "^3.19.1",
diff --git a/packages/design-system/package.json b/packages/design-system/package.json
index 1e4b79c65f..c9b9e3c21f 100644
--- a/packages/design-system/package.json
+++ b/packages/design-system/package.json
@@ -76,7 +76,8 @@
"immer": "^9.0.12",
"lodash.merge": "^4.6.2",
"match-sorter": "^6.3.1",
- "react-hot-toast": "^2.3.0"
+ "react-hot-toast": "^2.3.0",
+ "use-debounce": "^9.0.2"
},
"exports": "./lib/index.js",
"types": "src/index.ts",
diff --git a/packages/design-system/src/components/enhanced-tooltip.stories.tsx b/packages/design-system/src/components/enhanced-tooltip.stories.tsx
new file mode 100644
index 0000000000..c3e878bdb6
--- /dev/null
+++ b/packages/design-system/src/components/enhanced-tooltip.stories.tsx
@@ -0,0 +1,20 @@
+// import React, { useCallback } from "react";
+import { TextField } from "./text-field";
+import { EnhancedTooltip, EnhancedTooltipProvider } from "./enhanced-tooltip";
+import { Flex } from "./flex";
+
+export default {
+ component: EnhancedTooltip,
+};
+
+export const Simple = () => {
+ return (
+ <EnhancedTooltipProvider>
+ <Flex>
+ <EnhancedTooltip content="Hello world">
+ <TextField />
+ </EnhancedTooltip>
+ </Flex>
+ </EnhancedTooltipProvider>
+ );
+};
diff --git a/packages/design-system/src/components/enhanced-tooltip.tsx b/packages/design-system/src/components/enhanced-tooltip.tsx
new file mode 100644
index 0000000000..fb16b579fb
--- /dev/null
+++ b/packages/design-system/src/components/enhanced-tooltip.tsx
@@ -0,0 +1,143 @@
+import React, {
+ Ref,
+ useRef,
+ useState,
+ type ComponentProps,
+ type FocusEvent,
+ createContext,
+ useContext,
+ useMemo,
+} from "react";
+import { Tooltip, type TooltipProps } from "./tooltip";
+import * as TooltipPrimitive from "@radix-ui/react-tooltip";
+import { useDebouncedCallback } from "use-debounce";
+
+const EnhancedTooltipContext = createContext<
+ Omit<ComponentProps<typeof TooltipPrimitive.TooltipProvider>, "children">
+>({});
+
+const DEFAULT_DELAY_DURATION = 1600;
+
+/**
+ * To have the ability to access properties from TooltipPrimitive.TooltipProvider at EnhancedTooltip
+ **/
+export const EnhancedTooltipProvider = ({
+ delayDuration = DEFAULT_DELAY_DURATION,
+ skipDelayDuration = 0,
+ disableHoverableContent = false,
+ children,
+}: ComponentProps<typeof TooltipPrimitive.TooltipProvider>) => {
+ const contextValue = useMemo(
+ () => ({
+ delayDuration,
+ skipDelayDuration,
+ disableHoverableContent,
+ }),
+ [delayDuration, disableHoverableContent, skipDelayDuration]
+ );
+
+ return (
+ <EnhancedTooltipContext.Provider value={contextValue}>
+ <TooltipPrimitive.TooltipProvider {...contextValue}>
+ {children}
+ </TooltipPrimitive.TooltipProvider>
+ </EnhancedTooltipContext.Provider>
+ );
+};
+
+/**
+ * EnhancedTooltip has the following differences from the radix-ui
+ * 1. Don't show the tooltip if any click or key-down was made inside Tooltip.Trigger
+ * 2. Show Tooltip on focus after the delay
+ **/
+export const EnhancedTooltip = React.forwardRef(
+ (
+ props: Omit<TooltipProps, "open" | "onOpenChange">,
+ ref: Ref<HTMLDivElement>
+ ) => {
+ const [open, setOpen] = useState(props.defaultOpen ?? false);
+ const context = useContext(EnhancedTooltipContext);
+
+ /**
+ * Used to skip multiple focus/blur calls
+ */
+ const isFocusedRef = useRef(false);
+
+ /**
+ * Disable opening if any interaction with control occurred
+ */
+ const allowOpenRef = useRef(true);
+
+ const handleDisableOpen = () => {
+ allowOpenRef.current = false;
+ setOpen(false);
+ showTooltipDelayed.cancel();
+ };
+
+ const showTooltipDelayed = useDebouncedCallback(
+ () => {
+ if (allowOpenRef.current) {
+ setOpen(true);
+ }
+ },
+ props.delayDuration ?? context.delayDuration ?? DEFAULT_DELAY_DURATION,
+ { leading: false }
+ );
+
+ // We debounce blur/focus events in a single function, to skip fast `blur/focus` which can occur during select menu hovers
+ const handleFocusEventsDebounced = useDebouncedCallback(
+ (eventType: "focus" | "blur") => {
+ if (eventType === "blur") {
+ isFocusedRef.current = false;
+ allowOpenRef.current = true;
+ setOpen(false);
+ showTooltipDelayed.cancel();
+ return;
+ }
+
+ if (isFocusedRef.current === false) {
+ showTooltipDelayed();
+ }
+
+ isFocusedRef.current = true;
+ },
+ 0,
+ { leading: false }
+ );
+
+ const triggerProps = {
+ onFocus: (event: FocusEvent<HTMLElement>) => {
+ handleFocusEventsDebounced("focus");
+ event.preventDefault();
+ },
+ onBlur: (event: FocusEvent<HTMLElement>) => {
+ handleFocusEventsDebounced("blur");
+ event.preventDefault();
+ },
+ onPointerDown: () => {
+ handleDisableOpen();
+ },
+ onKeyDown: () => {
+ handleDisableOpen();
+ },
+ };
+
+ const onOpenChange = (isOpen: boolean) => {
+ if (allowOpenRef.current) {
+ setOpen(isOpen);
+ }
+ };
+
+ // Wrap in provider so each control will use own hover delay
+ return (
+ <Tooltip
+ {...props}
+ open={open}
+ onOpenChange={onOpenChange}
+ triggerProps={triggerProps}
+ />
+ );
+ }
+);
+
+EnhancedTooltip.displayName = "EnhancedTooltip";
diff --git a/packages/design-system/src/components/tooltip.tsx b/packages/design-system/src/components/tooltip.tsx
index eb45ade568..f8acc5e0ef 100644
--- a/packages/design-system/src/components/tooltip.tsx
+++ b/packages/design-system/src/components/tooltip.tsx
@@ -1,11 +1,11 @@
-import React, { Ref, ComponentProps, Fragment } from "react";
+import React, { Ref, Fragment, type ComponentProps } from "react";
import { styled } from "../stitches.config";
import * as TooltipPrimitive from "@radix-ui/react-tooltip";
import { Box } from "./box";
import { Paragraph } from "./paragraph";
import type { CSS } from "../stitches.config";
-type TooltipProps = ComponentProps<typeof TooltipPrimitive.Root> &
+export type TooltipProps = ComponentProps<typeof TooltipPrimitive.Root> &
ComponentProps<typeof TooltipPrimitive.Content> & {
children: React.ReactElement;
content: React.ReactNode;
@@ -45,19 +45,23 @@ export const Tooltip = React.forwardRef(
{
children,
content,
- open,
defaultOpen,
- onOpenChange,
multiline,
delayDuration,
disableHoverableContent,
+ open,
+ onOpenChange,
+ triggerProps,
...props
- }: TooltipProps,
+ }: TooltipProps & {
+ triggerProps?: ComponentProps<typeof TooltipPrimitive.Trigger>;
+ },
ref: Ref<HTMLDivElement>
) => {
if (!content) {
return children;
}
+
return (
<TooltipPrimitive.Root
open={open}
@@ -66,7 +70,9 @@ export const Tooltip = React.forwardRef(
delayDuration={delayDuration}
disableHoverableContent={disableHoverableContent}
>
- <TooltipPrimitive.Trigger asChild>{children}</TooltipPrimitive.Trigger>
+ <TooltipPrimitive.Trigger asChild {...triggerProps}>
+ {children}
+ </TooltipPrimitive.Trigger>
<TooltipPrimitive.Portal>
<Content
ref={ref}
diff --git a/packages/design-system/src/index.ts b/packages/design-system/src/index.ts
index 40e451c727..1b516452da 100644
--- a/packages/design-system/src/index.ts
+++ b/packages/design-system/src/index.ts
@@ -24,6 +24,10 @@ export {
export { Card } from "./components/card";
export { Toggle } from "./components/toggle";
export { Tooltip, InputErrorsTooltip } from "./components/tooltip";
+export {
+ EnhancedTooltip,
+ EnhancedTooltipProvider,
+} from "./components/enhanced-tooltip";
export { Button } from "./components/button";
export { DeprecatedIconButton } from "./components/__DEPRECATED__/icon-button";
export { IconButton } from "./components/icon-button";
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 71f192a3f2..57deee109e 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -141,6 +141,7 @@ importers:
remix-utils: ^4.1.0
slugify: ^1.6.5
typescript: 4.7.4
+ use-debounce: ^9.0.2
uuid: ^9.0.0
warn-once: ^0.1.1
zod: ^3.19.1
@@ -210,6 +211,7 @@ importers:
remix-auth-google: 1.1.0_aokfpu2sgp732g5yz6iyiwi7l4
remix-utils: 4.1.0_q73k56po2sths2cyphxvf2ziau
slugify: 1.6.5
+ use-debounce: [email protected]
uuid: 9.0.0
warn-once: 0.1.1
zod: 3.19.1
@@ -421,6 +423,7 @@ importers:
react-dom: 17.0.2
react-hot-toast: ^2.3.0
typescript: 4.7.4
+ use-debounce: ^9.0.2
dependencies:
'@radix-ui/colors': 0.1.8
'@radix-ui/react-accessible-icon': 1.0.0_sfoxds7t5ydpegc3knd667wn6m
@@ -460,6 +463,7 @@ importers:
lodash.merge: 4.6.2
match-sorter: 6.3.1
react-hot-toast: 2.3.0_sfoxds7t5ydpegc3knd667wn6m
+ use-debounce: [email protected]
devDependencies:
'@jest/globals': 29.3.1
'@storybook/jest': 0.0.10_sfoxds7t5ydpegc3knd667wn6m
@@ -21494,6 +21498,15 @@ packages:
tslib: 2.4.0
dev: false
+ /use-debounce/[email protected]:
+ resolution: {integrity: sha512-QLyB0sxt9F5AisGDrUybCRJSLE60bTQR0yXc+IebNGUu1GCXwii1zsZl82mPGdWqDVQy7+1FKMLHQUixxf5Nbw==}
+ engines: {node: '>= 10.0.0'}
+ peerDependencies:
+ react: '>=16.8.0'
+ dependencies:
+ react: 17.0.2
+ dev: false
+
/use-isomorphic-layout-effect/1.1.2_sudpmbbyhqtxq6t4xf6jlicdem:
resolution: {integrity: sha512-49L8yCO3iGT/ZF9QttjwLF/ZD9Iwto5LnH5LmEdk/6cFmXddqi2ulF0edxTwjj+7mqvpVVGQWvbXZdn32wRSHA==}
peerDependencies: