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.

feat: improve variable and binding popovers position (#2740)

Bogdan Chadkinab4d5def091f
diff --git a/apps/builder/app/builder/features/inspector/inspector.tsx b/apps/builder/app/builder/features/inspector/inspector.tsx
index 3914af46a7..8b51439df7 100644
--- a/apps/builder/app/builder/features/inspector/inspector.tsx
+++ b/apps/builder/app/builder/features/inspector/inspector.tsx
@@ -27,6 +27,7 @@ import { NavigatorTree } from "~/builder/shared/navigator-tree";
import type { Settings } from "~/builder/shared/client-settings";
import { MetaIcon } from "~/builder/shared/meta-icon";
import { getInstanceLabel } from "~/shared/instance-utils";
+import { BindingPopoverProvider } from "~/builder/shared/binding-popover";
const InstanceInfo = ({ instance }: { instance: Instance }) => {
const metas = useStore(registeredComponentMetasStore);
@@ -105,36 +106,42 @@ export const Inspector = ({ navigatorLayout }: InspectorProps) => {
skipDelayDuration={0}
>
<FloatingPanelProvider container={tabsRef}>
- <PanelTabs
- ref={tabsRef}
- value={availableTabs.includes(tab) ? tab : availableTabs[0]}
- onValueChange={setTab}
- asChild
- >
- <Flex direction="column">
- <PanelTabsList>
- {isStyleTabVisible && (
- <PanelTabsTrigger value="style">Style</PanelTabsTrigger>
- )}
- <PanelTabsTrigger value="settings">Settings</PanelTabsTrigger>
- </PanelTabsList>
- <PanelTabsContent value="style" css={contentStyle} tabIndex={-1}>
- <InstanceInfo instance={selectedInstance} />
- <StylePanel selectedInstance={selectedInstance} />
- </PanelTabsContent>
- <PanelTabsContent value="settings" css={contentStyle} tabIndex={-1}>
- <ScrollArea>
+ <BindingPopoverProvider value={{ containerRef: tabsRef }}>
+ <PanelTabs
+ ref={tabsRef}
+ value={availableTabs.includes(tab) ? tab : availableTabs[0]}
+ onValueChange={setTab}
+ asChild
+ >
+ <Flex direction="column">
+ <PanelTabsList>
+ {isStyleTabVisible && (
+ <PanelTabsTrigger value="style">Style</PanelTabsTrigger>
+ )}
+ <PanelTabsTrigger value="settings">Settings</PanelTabsTrigger>
+ </PanelTabsList>
+ <PanelTabsContent value="style" css={contentStyle} tabIndex={-1}>
<InstanceInfo instance={selectedInstance} />
- <SettingsPanelContainer
- key={
- selectedInstance.id /* Re-render when instance changes */
- }
- selectedInstance={selectedInstance}
- />
- </ScrollArea>
- </PanelTabsContent>
- </Flex>
- </PanelTabs>
+ <StylePanel selectedInstance={selectedInstance} />
+ </PanelTabsContent>
+ <PanelTabsContent
+ value="settings"
+ css={contentStyle}
+ tabIndex={-1}
+ >
+ <ScrollArea>
+ <InstanceInfo instance={selectedInstance} />
+ <SettingsPanelContainer
+ key={
+ selectedInstance.id /* Re-render when instance changes */
+ }
+ selectedInstance={selectedInstance}
+ />
+ </ScrollArea>
+ </PanelTabsContent>
+ </Flex>
+ </PanelTabs>
+ </BindingPopoverProvider>
</FloatingPanelProvider>
</EnhancedTooltipProvider>
);
diff --git a/apps/builder/app/builder/features/settings-panel/variable-popover.tsx b/apps/builder/app/builder/features/settings-panel/variable-popover.tsx
index cec06ab005..4a099721a4 100644
--- a/apps/builder/app/builder/features/settings-panel/variable-popover.tsx
+++ b/apps/builder/app/builder/features/settings-panel/variable-popover.tsx
@@ -1,13 +1,17 @@
import { nanoid } from "nanoid";
import {
+ type ReactNode,
+ type Ref,
+ type RefObject,
forwardRef,
useId,
useState,
- type ReactNode,
useImperativeHandle,
- type Ref,
useRef,
+ createContext,
+ useContext,
} from "react";
+import { mergeRefs } from "@react-aria/utils";
import {
Flex,
FloatingPanelPopover,
@@ -41,6 +45,8 @@ import {
composeFields,
type ComposedFields,
} from "~/shared/form-utils";
+import { BindingPopoverProvider } from "~/builder/shared/binding-popover";
+import { useSideOffset } from "~/builder/shared/floating-panel";
import { ResourceForm } from "./resource-panel";
/**
@@ -424,11 +430,20 @@ const VariablePanel = forwardRef<
});
VariablePanel.displayName = "VariablePanel";
+const VariablePopoverContext = createContext<{
+ containerRef?: RefObject<HTMLElement>;
+}>({});
+
+export const VariablePopoverProvider = VariablePopoverContext.Provider;
+
export const VariablePopoverTrigger = forwardRef<
HTMLButtonElement,
{ variable?: DataSource; children: ReactNode }
>(({ variable, children }, ref) => {
- const [open, setOpen] = useState(false);
+ const [isOpen, setOpen] = useState(false);
+ const { containerRef } = useContext(VariablePopoverContext);
+ const [triggerRef, sideOffsset] = useSideOffset({ isOpen, containerRef });
+ const bindingPopoverContainerRef = useRef<HTMLDivElement>(null);
const panelRef = useRef<undefined | PanelApi>();
const saveAndClose = () => {
if (panelRef.current) {
@@ -445,7 +460,7 @@ export const VariablePopoverTrigger = forwardRef<
return (
<FloatingPanelPopover
modal
- open={open}
+ open={isOpen}
onOpenChange={(newOpen) => {
if (newOpen === false) {
saveAndClose();
@@ -454,10 +469,15 @@ export const VariablePopoverTrigger = forwardRef<
setOpen(newOpen);
}}
>
- <FloatingPanelPopoverTrigger ref={ref} asChild>
+ <FloatingPanelPopoverTrigger ref={mergeRefs(ref, triggerRef)} asChild>
{children}
</FloatingPanelPopoverTrigger>
- <FloatingPanelPopoverContent side="left" align="start">
+ <FloatingPanelPopoverContent
+ ref={bindingPopoverContainerRef}
+ sideOffset={sideOffsset}
+ side="left"
+ align="start"
+ >
<ScrollArea
css={{
// flex fixes content overflowing artificial scroll area
@@ -484,7 +504,11 @@ export const VariablePopoverTrigger = forwardRef<
>
{/* submit is not triggered when press enter on input without submit button */}
<button style={{ display: "none" }}>submit</button>
- <VariablePanel ref={panelRef} variable={variable} />
+ <BindingPopoverProvider
+ value={{ containerRef: bindingPopoverContainerRef }}
+ >
+ <VariablePanel ref={panelRef} variable={variable} />
+ </BindingPopoverProvider>
</form>
</Flex>
</ScrollArea>
diff --git a/apps/builder/app/builder/features/settings-panel/variables-section.tsx b/apps/builder/app/builder/features/settings-panel/variables-section.tsx
index c1df300b4a..874b831106 100644
--- a/apps/builder/app/builder/features/settings-panel/variables-section.tsx
+++ b/apps/builder/app/builder/features/settings-panel/variables-section.tsx
@@ -1,3 +1,4 @@
+import { useRef } from "react";
import { computed } from "nanostores";
import { useStore } from "@nanostores/react";
import {
@@ -33,7 +34,10 @@ import {
useOpenState,
} from "~/builder/shared/collapsible-section";
import { formatValuePreview } from "~/builder/shared/expression-editor";
-import { VariablePopoverTrigger } from "./variable-popover";
+import {
+ VariablePopoverProvider,
+ VariablePopoverTrigger,
+} from "./variable-popover";
/**
* find variables defined specifically on this selected instance
@@ -184,40 +188,43 @@ const VariablesList = () => {
};
export const VariablesSection = () => {
+ const containerRef = useRef<HTMLDivElement>(null);
const [isOpen, setIsOpen] = useOpenState({
label: "variables",
isOpenDefault: true,
});
return (
- <CollapsibleSectionBase
- label="Variables"
- fullWidth={true}
- isOpen={isOpen}
- onOpenChange={setIsOpen}
- trigger={
- <SectionTitle
- suffix={
- <VariablePopoverTrigger>
- <SectionTitleButton
- prefix={<PlusIcon />}
- // open panel when add new varable
- onClick={() => {
- if (isOpen === false) {
- setIsOpen(true);
- }
- }}
- />
- </VariablePopoverTrigger>
- }
- >
- <SectionTitleLabel>Variables</SectionTitleLabel>
- </SectionTitle>
- }
- >
- {/* prevent applyig gap to list items */}
- <div>
- <VariablesList />
- </div>
- </CollapsibleSectionBase>
+ <VariablePopoverProvider value={{ containerRef }}>
+ <CollapsibleSectionBase
+ label="Variables"
+ fullWidth={true}
+ isOpen={isOpen}
+ onOpenChange={setIsOpen}
+ trigger={
+ <SectionTitle
+ suffix={
+ <VariablePopoverTrigger>
+ <SectionTitleButton
+ prefix={<PlusIcon />}
+ // open panel when add new varable
+ onClick={() => {
+ if (isOpen === false) {
+ setIsOpen(true);
+ }
+ }}
+ />
+ </VariablePopoverTrigger>
+ }
+ >
+ <SectionTitleLabel>Variables</SectionTitleLabel>
+ </SectionTitle>
+ }
+ >
+ {/* prevent applyig gap to list items */}
+ <div ref={containerRef}>
+ <VariablesList />
+ </div>
+ </CollapsibleSectionBase>
+ </VariablePopoverProvider>
);
};
diff --git a/apps/builder/app/builder/shared/binding-popover.tsx b/apps/builder/app/builder/shared/binding-popover.tsx
index 36413299ed..70d11f7765 100644
--- a/apps/builder/app/builder/shared/binding-popover.tsx
+++ b/apps/builder/app/builder/shared/binding-popover.tsx
@@ -1,9 +1,12 @@
import {
+ type ButtonHTMLAttributes,
+ type RefObject,
forwardRef,
useMemo,
useRef,
useState,
- type ButtonHTMLAttributes,
+ createContext,
+ useContext,
} from "react";
import { isFeatureEnabled } from "@webstudio-is/feature-flags";
import { DotIcon, PlusIcon, TrashIcon } from "@webstudio-is/icons";
@@ -26,6 +29,7 @@ import {
} from "@webstudio-is/design-system";
import { validateExpression } from "@webstudio-is/react-sdk";
import { ExpressionEditor, formatValuePreview } from "./expression-editor";
+import { useSideOffset } from "./floating-panel";
export const evaluateExpressionWithinScope = (
expression: string,
@@ -250,6 +254,12 @@ const BindingButton = forwardRef<
});
BindingButton.displayName = "BindingButton";
+const BindingPopoverContext = createContext<{
+ containerRef?: RefObject<HTMLElement>;
+}>({});
+
+export const BindingPopoverProvider = BindingPopoverContext.Provider;
+
export const BindingPopover = ({
scope,
aliases,
@@ -265,7 +275,9 @@ export const BindingPopover = ({
onChange: (newValue: string) => void;
onRemove: (evaluatedValue: unknown) => void;
}) => {
- const [open, onOpenChange] = useState(false);
+ const { containerRef } = useContext(BindingPopoverContext);
+ const [isOpen, onOpenChange] = useState(false);
+ const [triggerRef, sideOffset] = useSideOffset({ isOpen, containerRef });
const hasUnsavedChange = useRef<boolean>(false);
const preventedClosing = useRef<boolean>(false);
@@ -276,7 +288,7 @@ export const BindingPopover = ({
return (
<FloatingPanelPopover
modal
- open={open}
+ open={isOpen}
onOpenChange={(newOpen) => {
// handle special case for popover close
if (newOpen === false) {
@@ -291,10 +303,14 @@ export const BindingPopover = ({
onOpenChange(newOpen);
}}
>
- <FloatingPanelPopoverTrigger asChild>
+ <FloatingPanelPopoverTrigger asChild ref={triggerRef}>
<BindingButton error={valueError} />
</FloatingPanelPopoverTrigger>
- <FloatingPanelPopoverContent side="top" align="start">
+ <FloatingPanelPopoverContent
+ sideOffset={sideOffset}
+ side="left"
+ align="start"
+ >
<BindingPanel
scope={scope}
aliases={aliases}
diff --git a/apps/builder/app/builder/shared/floating-panel/floating-panel.tsx b/apps/builder/app/builder/shared/floating-panel.tsx
similarity index 79%
rename from apps/builder/app/builder/shared/floating-panel/floating-panel.tsx
rename to apps/builder/app/builder/shared/floating-panel.tsx
index 693a7a815c..04122537a2 100644
--- a/apps/builder/app/builder/shared/floating-panel/floating-panel.tsx
+++ b/apps/builder/app/builder/shared/floating-panel.tsx
@@ -1,3 +1,12 @@
+import {
+ type MutableRefObject,
+ type RefObject,
+ useContext,
+ useRef,
+ useState,
+ createContext,
+ useLayoutEffect,
+} from "react";
import {
FloatingPanelPopover,
theme,
@@ -6,27 +15,22 @@ import {
FloatingPanelPopoverContent,
FloatingPanelPopoverTitle,
} from "@webstudio-is/design-system";
-import {
- type MutableRefObject,
- useContext,
- useEffect,
- useRef,
- useState,
-} from "react";
-import { FloatingPanelContext } from "./floating-panel-provider";
-const useSideOffset = ({
+export const useSideOffset = ({
isOpen,
+ containerRef,
}: {
isOpen: boolean;
+ containerRef?: RefObject<HTMLElement>;
}): [MutableRefObject<HTMLButtonElement | null>, number] => {
const triggerRef = useRef<HTMLButtonElement | null>(null);
- const { container: containerRef } = useContext(FloatingPanelContext);
const [sideOffset, setSideOffset] = useState(0);
- useEffect(() => {
+ // use layout effect to avoid popover jumping
+ useLayoutEffect(() => {
if (
isOpen === false ||
+ containerRef === undefined ||
containerRef.current === null ||
triggerRef.current === null
) {
@@ -41,9 +45,30 @@ const useSideOffset = ({
return [triggerRef, sideOffset];
};
+const FloatingPanelContext = createContext<{
+ container: RefObject<HTMLElement>;
+}>({
+ container: {
+ current: null,
+ },
+});
+
+export const FloatingPanelProvider = ({
+ children,
+ container,
+}: {
+ children: JSX.Element;
+ container: RefObject<HTMLElement>;
+}) => (
+ <FloatingPanelContext.Provider value={{ container }}>
+ {children}
+ </FloatingPanelContext.Provider>
+);
+
const useLogic = (open?: boolean, onOpenChange?: (isOpen: boolean) => void) => {
+ const { container: containerRef } = useContext(FloatingPanelContext);
const [isOpen, setIsOpen] = useState(Boolean(open));
- const [triggerRef, sideOffset] = useSideOffset({ isOpen });
+ const [triggerRef, sideOffset] = useSideOffset({ isOpen, containerRef });
const handleOpenChange = (open: boolean) => {
setIsOpen(open);
onOpenChange?.(open);
diff --git a/apps/builder/app/builder/shared/floating-panel/floating-panel-provider.tsx b/apps/builder/app/builder/shared/floating-panel/floating-panel-provider.tsx
deleted file mode 100644
index 0bdeadc2c3..0000000000
--- a/apps/builder/app/builder/shared/floating-panel/floating-panel-provider.tsx
+++ /dev/null
@@ -1,21 +0,0 @@
-import { createContext, type RefObject } from "react";
-
-export const FloatingPanelContext = createContext<{
- container: RefObject<HTMLElement>;
-}>({
- container: {
- current: null,
- },
-});
-
-export const FloatingPanelProvider = ({
- children,
- container,
-}: {
- children: JSX.Element;
- container: RefObject<HTMLElement>;
-}) => (
- <FloatingPanelContext.Provider value={{ container }}>
- {children}
- </FloatingPanelContext.Provider>
-);
diff --git a/apps/builder/app/builder/shared/floating-panel/index.ts b/apps/builder/app/builder/shared/floating-panel/index.ts
deleted file mode 100644
index 154ae89ee7..0000000000
--- a/apps/builder/app/builder/shared/floating-panel/index.ts
+++ /dev/null
@@ -1,2 +0,0 @@
-export * from "./floating-panel";
-export { FloatingPanelProvider } from "./floating-panel-provider";