The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
GDGT-3292: Keep notebook menus on the side they opened on (#83547)
Will Fry5db80b445956
diff --git a/e2e/test/scenarios/question/reproductions.cy.spec.ts b/e2e/test/scenarios/question/reproductions.cy.spec.tsindex 3f7357cce48..5f090e38455 100644--- a/e2e/test/scenarios/question/reproductions.cy.spec.ts+++ b/e2e/test/scenarios/question/reproductions.cy.spec.ts@@ -1,6 +1,6 @@const { H } = cy;-import { WRITABLE_DB_ID } from "e2e/support/cypress_data";+import { SAMPLE_DB_ID, WRITABLE_DB_ID } from "e2e/support/cypress_data";import { SAMPLE_DATABASE } from "e2e/support/cypress_sample_database";import { ORDERS_QUESTION_ID } from "e2e/support/cypress_sample_instance_data";import type { StructuredQuestionDetails } from "e2e/support/helpers";@@ -742,3 +742,97 @@ describe("native query preview on small screens", () => {});});});++describe("issue 74500", () => {+ type Trigger = () => Cypress.Chainable<JQuery<HTMLElement>>;++ beforeEach(() => {+ H.restore();+ cy.signInAsAdmin();+ });++ const VIEWPORT_WIDTH = 1280;++ it("keeps the side it opened on while its content shrinks", () => {+ const summarizeTrigger = () =>+ H.getNotebookStep("summarize").findByText("Pick a function or metric");++ H.startNewQuestion();+ H.miniPicker().within(() => {+ cy.findByText("Sample Database").click();+ cy.findByText("Orders").click();+ });++ cy.log("too little room below for the full list, so it opens above");+ setSpaceBelow(summarizeTrigger, 250);+ summarizeTrigger().click();+ assertPopoverSide(summarizeTrigger, "above");++ cy.log("the filtered list would fit below, but it stays above");+ H.popover().findByPlaceholderText("Find...").type("Count of rows");+ H.popover().findByText("Count of rows").should("be.visible");+ assertPopoverSide(summarizeTrigger, "above");++ cy.log("it picks a side again the next time it opens");+ cy.realPress("Escape");+ H.popover({ skipVisibilityCheck: true }).should("not.exist");+ setSpaceBelow(summarizeTrigger, 800);+ summarizeTrigger().click();+ assertPopoverSide(summarizeTrigger, "below");++ cy.log("resizing the window lets it pick a side again");+ setSpaceBelow(summarizeTrigger, 250);+ assertPopoverSide(summarizeTrigger, "above");+ });++ it("keeps the side it opened on while its content grows", () => {+ const filterTrigger = () =>+ H.getNotebookStep("filter").findByText("Total is greater than 20");++ // Visiting the notebook directly skips the slide-in, which would throw off measurements+ H.visitQuestionAdhoc(+ {+ dataset_query: {+ database: SAMPLE_DB_ID,+ type: "query",+ query: {+ "source-table": ORDERS_ID,+ filter: [">", ["field", ORDERS.TOTAL, null], 20],+ },+ },+ },+ { mode: "notebook" },+ );++ cy.log("the filter editor fits below, so it opens below");+ setSpaceBelow(filterTrigger, 300);+ filterTrigger().click();+ assertPopoverSide(filterTrigger, "below");++ cy.log("the column list doesn't fit below, but it stays below");+ H.popover().findByLabelText("Back").click();+ H.popover().findByText("Discount").should("exist");+ assertPopoverSide(filterTrigger, "below");+ });++ function setSpaceBelow(trigger: Trigger, space: number) {+ trigger().then(($trigger) => {+ const { bottom } = $trigger[0].getBoundingClientRect();+ cy.viewport(VIEWPORT_WIDTH, Math.ceil(bottom + space));+ });+ }++ function assertPopoverSide(trigger: Trigger, side: "above" | "below") {+ trigger().then(($trigger) => {+ H.popover().should(($popover) => {+ const triggerRect = $trigger[0].getBoundingClientRect();+ const popoverRect = $popover[0].getBoundingClientRect();+ if (side === "above") {+ expect(popoverRect.bottom).to.be.at.most(triggerRect.top);+ } else {+ expect(popoverRect.top).to.be.at.least(triggerRect.bottom);+ }+ });+ });+ }+});diff --git a/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/EditTableDataFilterButton.tsx b/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/EditTableDataFilterButton.tsxindex 8205c804e99..4402e95685f 100644--- a/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/EditTableDataFilterButton.tsx+++ b/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/EditTableDataFilterButton.tsx@@ -4,7 +4,14 @@ import { t } from "ttag";import { getFilterItems } from "metabase/querying/filters/components/FilterPanel/utils";import { MultiStageFilterPicker } from "metabase/querying/filters/components/FilterPicker/MultiStageFilterPicker";-import { Badge, Button, Icon, Popover, Tooltip } from "metabase/ui";+import {+ Badge,+ Button,+ Icon,+ Popover,+ Tooltip,+ useStablePopoverPosition,+} from "metabase/ui";import type * as Lib from "metabase-lib";import type Question from "metabase-lib/v1/Question";@@ -27,6 +34,7 @@ export function EditTableDataFilterButton({onQuestionChange,}: EditTableDataFilterButtonProps) {const [isOpened, { close, toggle }] = useDisclosure();+ const stablePositionProps = useStablePopoverPosition("bottom-start");const query = question.query();const items = useMemo(() => (query ? getFilterItems(query) : []), [query]);const hasFilters = items.length > 0;@@ -39,7 +47,13 @@ export function EditTableDataFilterButton({return (<Button.Group>- <Popover opened={isOpened} position="bottom-start" onDismiss={close}>+ <Popover+ position={stablePositionProps.position}+ middlewares={stablePositionProps.middlewares}+ onClose={stablePositionProps.onClose}+ opened={isOpened}+ onDismiss={close}+ ><Popover.Target><ButtonclassName={className}diff --git a/frontend/src/embedding-sdk-bundle/components/private/util/MultiStepPopover/MultiStepPopover.tsx b/frontend/src/embedding-sdk-bundle/components/private/util/MultiStepPopover/MultiStepPopover.tsxindex 8fb7efb3efa..f2406d22a08 100644--- a/frontend/src/embedding-sdk-bundle/components/private/util/MultiStepPopover/MultiStepPopover.tsx+++ b/frontend/src/embedding-sdk-bundle/components/private/util/MultiStepPopover/MultiStepPopover.tsx@@ -5,7 +5,11 @@ import {isValidElement,} from "react";-import { Popover, type PopoverProps } from "metabase/ui";+import {+ Popover,+ type PopoverProps,+ useStablePopoverPosition,+} from "metabase/ui";type StepValue = string | number;@@ -33,6 +37,7 @@ const MultiStepPopoverContent = ({currentStep,onClose,children,+ position = "bottom-start",...popoverProps}: MultiStepPopoverProps &Omit<PopoverProps, "children" | "onClose" | "opened">) => {@@ -57,9 +62,13 @@ const MultiStepPopoverContent = ({(child): child is ReactElement<PropsWithChildren> => child.type === Target,)?.props.children;+ const stablePositionProps = useStablePopoverPosition(position);+return (<Popover- position="bottom-start"+ position={stablePositionProps.position}+ middlewares={stablePositionProps.middlewares}+ onClose={stablePositionProps.onClose}opened={currentStep !== null}onDismiss={onClose}{...popoverProps}diff --git a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/FilterHeaderButton.tsx b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/FilterHeaderButton.tsxindex f272e367290..ee54a9d7051 100644--- a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/FilterHeaderButton.tsx+++ b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/FilterHeaderButton.tsx@@ -8,7 +8,14 @@ import { MultiStageFilterPicker } from "metabase/querying/filters/components/Filimport type { FilterChangeOpts } from "metabase/querying/filters/components/FilterPicker/types";import { useDispatch } from "metabase/redux";import type { QueryBuilderMode } from "metabase/redux/store";-import { Badge, Button, Icon, Popover, Tooltip } from "metabase/ui";+import {+ Badge,+ Button,+ Icon,+ Popover,+ Tooltip,+ useStablePopoverPosition,+} from "metabase/ui";import * as Lib from "metabase-lib";import type Question from "metabase-lib/v1/Question";@@ -30,6 +37,7 @@ export function FilterHeaderButton({}: FilterHeaderButtonProps) {const dispatch = useDispatch();const [isOpened, { close, toggle }] = useDisclosure();+ const stablePositionProps = useStablePopoverPosition("bottom-start");const query = question.query();const items = useMemo(() => (query ? getFilterItems(query) : []), [query]);const hasFilters = items.length > 0;@@ -51,7 +59,13 @@ export function FilterHeaderButton({return (<Button.Group>- <Popover opened={isOpened} position="bottom-start" onDismiss={close}>+ <Popover+ position={stablePositionProps.position}+ middlewares={stablePositionProps.middlewares}+ onClose={stablePositionProps.onClose}+ opened={isOpened}+ onDismiss={close}+ ><Popover.Target><ButtonclassNames={{diff --git a/frontend/src/metabase/query_builder/components/view/sidebars/SummarizeSidebar/AddAggregationButton/AddAggregationButton.tsx b/frontend/src/metabase/query_builder/components/view/sidebars/SummarizeSidebar/AddAggregationButton/AddAggregationButton.tsxindex 6cf632df43e..8e4eaa49e93 100644--- a/frontend/src/metabase/query_builder/components/view/sidebars/SummarizeSidebar/AddAggregationButton/AddAggregationButton.tsx+++ b/frontend/src/metabase/query_builder/components/view/sidebars/SummarizeSidebar/AddAggregationButton/AddAggregationButton.tsx@@ -3,7 +3,13 @@ import { useState } from "react";import { t } from "ttag";import { AggregationPicker } from "metabase/querying/common/components/AggregationPicker";-import { Button, Icon, Popover, Tooltip } from "metabase/ui";+import {+ Button,+ Icon,+ Popover,+ Tooltip,+ useStablePopoverPosition,+} from "metabase/ui";import * as Lib from "metabase-lib";import AddAggregationButtonS from "./AddAggregationButton.module.css";@@ -20,6 +26,7 @@ export function AddAggregationButton({onQueryChange,}: AddAggregationButtonProps) {const [isOpened, setIsOpened] = useState(false);+ const stablePositionProps = useStablePopoverPosition();const hasAggregations = Lib.aggregations(query, stageIndex).length > 0;const operators = Lib.availableAggregationOperators(query, stageIndex);@@ -31,7 +38,13 @@ export function AddAggregationButton({);return (- <Popover opened={isOpened} onChange={setIsOpened}>+ <Popover+ position={stablePositionProps.position}+ middlewares={stablePositionProps.middlewares}+ onClose={stablePositionProps.onClose}+ opened={isOpened}+ onChange={setIsOpened}+ ><Popover.Target>{renderTooltip(<Buttondiff --git a/frontend/src/metabase/query_builder/components/view/sidebars/SummarizeSidebar/AggregationItem/AggregationItem.tsx b/frontend/src/metabase/query_builder/components/view/sidebars/SummarizeSidebar/AggregationItem/AggregationItem.tsxindex 96c04c0229f..bd041818ba1 100644--- a/frontend/src/metabase/query_builder/components/view/sidebars/SummarizeSidebar/AggregationItem/AggregationItem.tsx+++ b/frontend/src/metabase/query_builder/components/view/sidebars/SummarizeSidebar/AggregationItem/AggregationItem.tsx@@ -1,7 +1,7 @@import { useDisclosure } from "@mantine/hooks";import { AggregationPicker } from "metabase/querying/common/components/AggregationPicker";-import { Box, Icon, Popover } from "metabase/ui";+import { Box, Icon, Popover, useStablePopoverPosition } from "metabase/ui";import { PreventPopoverExitProvider } from "metabase/ui/components/utils/PreventPopoverExit";import type * as Lib from "metabase-lib";@@ -29,10 +29,17 @@ export function AggregationItem({operators,}: AggregationItemProps) {const [isOpened, { toggle }] = useDisclosure(false);+ const stablePositionProps = useStablePopoverPosition();return (<PreventPopoverExitProvider>- <Popover opened={isOpened} onChange={toggle}>+ <Popover+ position={stablePositionProps.position}+ middlewares={stablePositionProps.middlewares}+ onClose={stablePositionProps.onClose}+ opened={isOpened}+ onChange={toggle}+ ><Popover.Target><buttonclassName={AggregationItemS.Root}diff --git a/frontend/src/metabase/querying/filters/components/FilterPanel/FilterPanelPopover/FilterPanelPopover.tsx b/frontend/src/metabase/querying/filters/components/FilterPanel/FilterPanelPopover/FilterPanelPopover.tsxindex 82ccc1f423c..95719d8c6b3 100644--- a/frontend/src/metabase/querying/filters/components/FilterPanel/FilterPanelPopover/FilterPanelPopover.tsx+++ b/frontend/src/metabase/querying/filters/components/FilterPanel/FilterPanelPopover/FilterPanelPopover.tsx@@ -4,7 +4,7 @@ import { useLocale } from "metabase/common/hooks";import { useTranslateContent } from "metabase/content-translation/hooks";import { FilterPicker } from "metabase/querying/filters/components/FilterPicker";import { getTranslatedFilterDisplayName } from "metabase/querying/filters/utils/display";-import { Popover } from "metabase/ui";+import { Popover, useStablePopoverPosition } from "metabase/ui";import * as Lib from "metabase-lib";import { FilterPill } from "../FilterPill";@@ -25,6 +25,7 @@ export function FilterPanelPopover({onChange,}: FilterPanelPopoverProps) {const [isOpened, setIsOpened] = useState(false);+ const stablePositionProps = useStablePopoverPosition("bottom-start");const tc = useTranslateContent();const { locale } = useLocale();@@ -45,8 +46,10 @@ export function FilterPanelPopover({return (<Popover+ position={stablePositionProps.position}+ middlewares={stablePositionProps.middlewares}+ onClose={stablePositionProps.onClose}opened={isOpened}- position="bottom-start"transitionProps={{ duration: 0 }}onChange={setIsOpened}>diff --git a/frontend/src/metabase/querying/notebook/components/ClauseStep/ClausePopover.tsx b/frontend/src/metabase/querying/notebook/components/ClauseStep/ClausePopover.tsxindex 0fbf11c1782..99c642940e3 100644--- a/frontend/src/metabase/querying/notebook/components/ClauseStep/ClausePopover.tsx+++ b/frontend/src/metabase/querying/notebook/components/ClauseStep/ClausePopover.tsx@@ -1,7 +1,7 @@import { useDndContext } from "@dnd-kit/core";import { type JSX, useCallback, useLayoutEffect, useState } from "react";-import { Box, Popover } from "metabase/ui";+import { Box, Popover, useStablePopoverPosition } from "metabase/ui";import { PreventPopoverExitProvider } from "metabase/ui/components/utils/PreventPopoverExit";import S from "./ClausePopover.module.css";@@ -22,6 +22,7 @@ export function ClausePopover({renderPopover,}: ClausePopoverProps) {const [isOpen, setIsOpen] = useState(isInitiallyOpen);+ const stablePositionProps = useStablePopoverPosition("bottom-start");const { active } = useDndContext();const handleOpen = useCallback(() => {@@ -48,8 +49,10 @@ export function ClausePopover({return (<PreventPopoverExitProvider><Popover+ position={stablePositionProps.position}+ middlewares={stablePositionProps.middlewares}+ onClose={stablePositionProps.onClose}opened={isOpen}- position="bottom-start"offset={{ mainAxis: 4 }}trapFocusonChange={handleChange}diff --git a/frontend/src/metabase/segments/components/SegmentEditor/FilterStep/FilterStep.tsx b/frontend/src/metabase/segments/components/SegmentEditor/FilterStep/FilterStep.tsxindex 147ce356fb5..b55cad93b18 100644--- a/frontend/src/metabase/segments/components/SegmentEditor/FilterStep/FilterStep.tsx+++ b/frontend/src/metabase/segments/components/SegmentEditor/FilterStep/FilterStep.tsx@@ -3,7 +3,13 @@ import { t } from "ttag";import { FilterPill } from "metabase/querying/filters/components/FilterPanel/FilterPill";import { FilterPicker } from "metabase/querying/filters/components/FilterPicker";-import { Button, Flex, Icon, Popover } from "metabase/ui";+import {+ Button,+ Flex,+ Icon,+ Popover,+ useStablePopoverPosition,+} from "metabase/ui";import * as Lib from "metabase-lib";import { ClauseStep } from "../ClauseStep";@@ -77,6 +83,7 @@ function FilterPopover({readOnly,}: FilterPopoverProps) {const [isOpened, setIsOpened] = useState(false);+ const stablePositionProps = useStablePopoverPosition();const filterInfo = filter? Lib.displayInfo(query, stageIndex, filter): undefined;@@ -97,7 +104,13 @@ function FilterPopover({};return (- <Popover opened={isOpened} onChange={setIsOpened}>+ <Popover+ position={stablePositionProps.position}+ middlewares={stablePositionProps.middlewares}+ onClose={stablePositionProps.onClose}+ opened={isOpened}+ onChange={setIsOpened}+ ><Popover.Target>{filterInfo ? (<FilterPilldiff --git a/frontend/src/metabase/ui/components/overlays/Popover/Popover.config.ts b/frontend/src/metabase/ui/components/overlays/Popover/Popover.config.tsindex e07e1d8267a..83169ce908b 100644--- a/frontend/src/metabase/ui/components/overlays/Popover/Popover.config.ts+++ b/frontend/src/metabase/ui/components/overlays/Popover/Popover.config.ts@@ -1,9 +1,18 @@-import { Popover } from "@mantine/core";+import { Popover, type PopoverProps } from "@mantine/core";import PopoverStyles from "./Popover.module.css";export const DEFAULT_POPOVER_Z_INDEX = 300;+export const DEFAULT_POPOVER_MIDDLEWARES = {+ shift: true,+ flip: true,+ size: {+ // This fixes extra scrollbars on the body when the popover has the same width as viewport+ padding: 5,+ },+} as const satisfies PopoverProps["middlewares"];+export const popoverOverrides = {Popover: Popover.extend({defaultProps: {@@ -11,14 +20,7 @@ export const popoverOverrides = {shadow: "sm_outline",withinPortal: true,hideDetached: false,- middlewares: {- shift: true,- flip: true,- size: {- // This fixes extra scrollbars on the body when the popover has the same width as viewport- padding: 5,- },- },+ middlewares: DEFAULT_POPOVER_MIDDLEWARES,transitionProps: { duration: 0 },},classNames: {diff --git a/frontend/src/metabase/ui/components/overlays/Popover/index.tsx b/frontend/src/metabase/ui/components/overlays/Popover/index.tsxindex 39d4c2a3e7a..b50e6426ce6 100644--- a/frontend/src/metabase/ui/components/overlays/Popover/index.tsx+++ b/frontend/src/metabase/ui/components/overlays/Popover/index.tsx@@ -1,3 +1,4 @@export { Popover } from "@mantine/core";export type { PopoverProps } from "@mantine/core";export { DEFAULT_POPOVER_Z_INDEX, popoverOverrides } from "./Popover.config";+export { useStablePopoverPosition } from "./use-stable-popover-position";diff --git a/frontend/src/metabase/ui/components/overlays/Popover/use-stable-popover-position.ts b/frontend/src/metabase/ui/components/overlays/Popover/use-stable-popover-position.tsnew file mode 100644index 00000000000..62280c37f99--- /dev/null+++ b/frontend/src/metabase/ui/components/overlays/Popover/use-stable-popover-position.ts@@ -0,0 +1,105 @@+import { getOverflowAncestors } from "@floating-ui/dom";+import type { FloatingPosition, PopoverProps } from "@mantine/core";+import { useCallback, useEffect, useMemo, useRef, useState } from "react";++import { DEFAULT_POPOVER_MIDDLEWARES } from "./Popover.config";++type StablePopoverPositionProps = Required<+ Pick<PopoverProps, "position" | "middlewares" | "onClose">+>;++/**+ * Keeps a popover on the side it opened on until it closes, even when its content shrinks (e.g.+ * while searching) or grows. If it grows past the space on that side, it becomes scrollable instead of moving.+ * Scrolling the page or resizing the window repositions it as usual.+ */+export function useStablePopoverPosition(+ defaultPosition: FloatingPosition = "bottom",+): StablePopoverPositionProps {+ const [isOpen, setIsOpen] = useState(false);+ const [currentPosition, setCurrentPosition] = useState<FloatingPosition>();+ // Mirrors `currentPosition`, but changes straight away rather than on the next render+ const currentPositionRef = useRef<FloatingPosition | undefined>(undefined);+ const referenceRef = useRef<Element | null>(null);++ const rememberPosition = useCallback((position?: FloatingPosition) => {+ currentPositionRef.current = position;+ setCurrentPosition(position);+ }, []);++ const middlewares = useMemo<StablePopoverPositionProps["middlewares"]>(+ () => ({+ ...DEFAULT_POPOVER_MIDDLEWARES,+ // Mantine's `onPositionChange` doesn't fire when it reopens on the same side, so read the+ // placement from `size`, which runs after flip on every update+ size: {+ ...DEFAULT_POPOVER_MIDDLEWARES.size,+ apply: ({+ placement,+ initialPlacement,+ rects,+ availableWidth,+ availableHeight,+ elements,+ }) => {+ referenceRef.current =+ elements.reference instanceof Element ? elements.reference : null;+ // A custom `apply` replaces Mantine's default sizing, so cap the size ourselves.+ Object.assign(elements.floating.style, {+ maxWidth: `${availableWidth}px`,+ maxHeight: `${availableHeight}px`,+ });+ // A `keepMounted` dropdown is still positioned while hidden, with no size, and an update+ // can finish just after the popover has closed and been removed+ const isOnScreen =+ rects.floating.height > 0 && elements.floating.isConnected;+ if (!isOnScreen) {+ return;+ }+ setIsOpen(true);+ const isStale =+ initialPlacement !==+ (currentPositionRef.current ?? defaultPosition);+ if (!isStale) {+ rememberPosition(placement);+ }+ },+ },+ }),+ [defaultPosition, rememberPosition],+ );++ useEffect(() => {+ const reference = referenceRef.current;+ if (!isOpen || !reference) {+ return;+ }++ const resetPreferredSide = () => rememberPosition(undefined);+ const scrollAncestors = getOverflowAncestors(reference);++ window.addEventListener("resize", resetPreferredSide);+ scrollAncestors.forEach((ancestor) =>+ ancestor.addEventListener("scroll", resetPreferredSide, {+ passive: true,+ }),+ );+ return () => {+ window.removeEventListener("resize", resetPreferredSide);+ scrollAncestors.forEach((ancestor) =>+ ancestor.removeEventListener("scroll", resetPreferredSide),+ );+ };+ }, [isOpen, rememberPosition]);++ const onClose = useCallback(() => {+ setIsOpen(false);+ rememberPosition(undefined);+ }, [rememberPosition]);++ return {+ position: currentPosition ?? defaultPosition,+ middlewares,+ onClose,+ };+}