Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

remove broken overlays demo (#67995)

Ryan Laurie08421d9ec15a
diff --git a/frontend/src/metabase/css/core/overlays/OverlaysDemo.tsx b/frontend/src/metabase/css/core/overlays/OverlaysDemo.tsx
deleted file mode 100644
index 8030524f46e..00000000000
--- a/frontend/src/metabase/css/core/overlays/OverlaysDemo.tsx
+++ /dev/null
@@ -1,418 +0,0 @@
-/* eslint-disable i18next/no-literal-string */
-import {
- type Dispatch,
- type ReactNode,
- type SetStateAction,
- useState,
-} from "react";
-import _ from "underscore";
-
-import { BulkActionBarPortal } from "metabase/common/components/BulkActionBar/BulkActionBar";
-import { EntityPickerModal } from "metabase/common/components/EntityPicker";
-import LegacyModal from "metabase/common/components/Modal";
-import ModalContent from "metabase/common/components/ModalContent";
-import LegacySelect, { Option } from "metabase/common/components/Select";
-import { Sidesheet } from "metabase/common/components/Sidesheet";
-import Toaster from "metabase/common/components/Toaster";
-import { UndoListOverlay } from "metabase/common/components/UndoListing";
-import {
- Box,
- Button,
- type ButtonProps,
- Flex,
- Group,
- HoverCard,
- Icon,
- Menu as MantineMenu,
- Modal as MantineModal,
- Popover as MantinePopover,
- Select as MantineSelect,
- Tooltip as MantineTooltip,
- type ModalProps,
- Overlay,
- Paper,
- type PaperProps,
- Stack,
- Text,
- Title,
-} from "metabase/ui";
-import { createMockUndo } from "metabase-types/api/mocks";
-
-const LauncherGroup = ({
- title,
- children,
- ...props
-}: React.PropsWithChildren<{ title: string } & PaperProps>) => (
- <Paper {...props} p="md">
- <Stack gap="md">
- <Title order={3}>{title}</Title>
- <Group>{children}</Group>
- </Stack>
- </Paper>
-);
-
-const _Launchers = ({
- nestedLaunchers,
- setUndoCount,
- setToastCount,
- setActionToastCount,
- setLegacyModalCount,
- setMantineModalCount,
- setMantineModalWithTitlePropCount,
- setSidesheetCount,
- setEntityPickerCount,
- setCommandPaletteCount,
-}: {
- nestedLaunchers: ReactNode;
- setUndoCount: Dispatch<SetStateAction<number>>;
- setToastCount: Dispatch<SetStateAction<number>>;
- setActionToastCount: Dispatch<SetStateAction<number>>;
- setLegacyModalCount: Dispatch<SetStateAction<number>>;
- setMantineModalCount: Dispatch<SetStateAction<number>>;
- setSidesheetCount: Dispatch<SetStateAction<number>>;
- setEntityPickerCount: Dispatch<SetStateAction<number>>;
- setCommandPaletteCount: Dispatch<SetStateAction<number>>;
- setMantineModalWithTitlePropCount: Dispatch<SetStateAction<number>>;
-}) => {
- const mantinePopoverDropdownTitleId = _.uniqueId(
- "mantine-popover-dropdown-title",
- );
-
- return (
- <Group>
- <LauncherGroup title="Small overlays">
- <MantineTooltip label="Mantine Tooltip content">
- <Button>Mantine Tooltip</Button>
- </MantineTooltip>
- <MantinePopover>
- <MantinePopover.Target>
- <Button>Mantine Popover</Button>
- </MantinePopover.Target>
- <MantinePopover.Dropdown>
- <Paper
- p="md"
- maw="80vw"
- aria-labelledby={mantinePopoverDropdownTitleId}
- >
- <Title order={3} id={mantinePopoverDropdownTitleId}>
- Mantine Popover content
- </Title>
- Mantine Popover text content
- {nestedLaunchers}
- </Paper>
- </MantinePopover.Dropdown>
- </MantinePopover>
- <MantineMenu>
- <MantineMenu.Target>
- <Button>Mantine Menu</Button>
- </MantineMenu.Target>
- <MantineMenu.Dropdown>
- <MantineMenu.Item>Mantine Menu Item 1</MantineMenu.Item>
- <MantineMenu.Item>Mantine Menu Item 2</MantineMenu.Item>
- <MantineMenu.Divider />
- <MantineMenu.Item>Mantine Menu Item 3</MantineMenu.Item>
- <MantineMenu.Item>Mantine Menu Item 4</MantineMenu.Item>
- </MantineMenu.Dropdown>
- </MantineMenu>
- <HoverCard>
- <HoverCard.Target>
- <Button>Mantine HoverCard</Button>
- </HoverCard.Target>
- <HoverCard.Dropdown>
- <Paper p="md">Mantine HoverCard text content</Paper>
- </HoverCard.Dropdown>
- </HoverCard>
- <MantineSelect
- data={
- [
- {
- label: "Mantine Select option 1",
- value: "1",
- },
- {
- label: "Mantine Select option 2",
- value: "2",
- },
- ] as {
- label: string;
- value: string;
- }[]
- }
- defaultValue={"1"}
- />
- <LegacySelect defaultValue="1" data-testid="LegacySelect">
- <Option value="1">Legacy Select option 1</Option>
- <Option value="2">Legacy Select option 2</Option>
- </LegacySelect>
- </LauncherGroup>
- <LauncherGroup title="Toasts">
- <Button onClick={() => setUndoCount((c) => c + 1)}>
- Undo-style toast
- </Button>
- <Button onClick={() => setActionToastCount((c) => c + 1)}>
- Action-style toast
- </Button>
- <Button onClick={() => setToastCount((c) => c + 1)}>
- Toaster-style toast
- </Button>
- </LauncherGroup>
- <LauncherGroup title="Modals">
- <Button onClick={() => setMantineModalCount((c) => c + 1)}>
- Mantine Modal
- </Button>
- <MantineTooltip label="This kind of modal sets its title via a prop">
- <Button
- onClick={() => setMantineModalWithTitlePropCount((c) => c + 1)}
- >
- Mantine Modal variant
- </Button>
- </MantineTooltip>
- <Button onClick={() => setLegacyModalCount((c) => c + 1)}>
- Legacy modal
- </Button>
- <Button onClick={() => setSidesheetCount((c) => c + 1)}>
- Sidesheet
- </Button>
- <Button onClick={() => setEntityPickerCount((c) => c + 1)}>
- Entity Picker
- </Button>
- <Button onClick={() => setCommandPaletteCount((c) => c + 1)}>
- Command Palette
- </Button>
- </LauncherGroup>
- </Group>
- );
-};
-
-export type OverlaysDemoProps = {
- enableNesting: boolean;
-};
-
-export const OverlaysDemo = ({ enableNesting }: OverlaysDemoProps) => {
- const [legacyModalCount, setLegacyModalCount] = useState(0);
- const [mantineModalCount, setMantineModalCount] = useState(0);
- const [mantineModalWithTitlePropCount, setMantineModalWithTitlePropCount] =
- useState(0);
- const [toastCount, setToastCount] = useState(0);
- const [actionToastCount, setActionToastCount] = useState(0);
- const [sidesheetCount, setSidesheetCount] = useState(0);
- const [entityPickerCount, setEntityPickerCount] = useState(0);
- const [commandPaletteCount, setCommandPaletteCount] = useState(0);
- const [undoCount, setUndoCount] = useState(0);
-
- const Launchers = () => (
- <_Launchers
- setToastCount={setToastCount}
- setActionToastCount={setActionToastCount}
- setUndoCount={setUndoCount}
- setLegacyModalCount={setLegacyModalCount}
- setMantineModalCount={setMantineModalCount}
- setSidesheetCount={setSidesheetCount}
- setEntityPickerCount={setEntityPickerCount}
- setCommandPaletteCount={setCommandPaletteCount}
- setMantineModalWithTitlePropCount={setMantineModalWithTitlePropCount}
- nestedLaunchers={enableNesting ? <Launchers /> : <></>}
- />
- );
-
- return (
- <Stack p="lg">
- <Launchers />
- {undoCount > 0 && (
- <UndoListOverlay
- undos={getToasts(undoCount)}
- onUndo={() => setUndoCount((c) => c - 1)}
- onDismiss={() => setUndoCount((c) => c - 1)}
- />
- )}
- {Array.from({ length: actionToastCount }).map((_value, index) => (
- <BulkActionBarPortal
- key={`simple-bulk-action-bar-${index}`}
- opened
- isNavbarOpen={false}
- message="Action-style toast text content"
- aria-label="Action-style toast content"
- p="lg"
- >
- <CloseButton
- onClick={() => setActionToastCount((c) => c - 1)}
- c="white"
- bg="transparent"
- />
- {enableNesting && <Launchers />}
- </BulkActionBarPortal>
- ))}
- {Array.from({ length: toastCount }).map((_value, index) => (
- <Toaster
- key={`toaster-${index}`}
- message="Toaster-style toast text content"
- aria-label="Toaster-style toast content"
- confirmText="Confirm"
- isShown={true}
- onDismiss={() => {
- setToastCount((c) => c - 1);
- }}
- onConfirm={() => {
- setToastCount((c) => c - 1);
- }}
- className=""
- fixed
- />
- ))}
- {Array.from({ length: legacyModalCount }).map((_, index) => {
- const modalTitleId = `legacy-modal-title-${index}`;
- return (
- <LegacyModal
- isOpen
- key={`legacy-modal-${index}`}
- closeOnClickOutside
- onClose={() => setLegacyModalCount((c) => c - 1)}
- aria-labelledby={modalTitleId}
- >
- <ModalContent>
- <Group style={{ position: "relative" }}>
- <Title p="md" order={3} id={modalTitleId}>
- Legacy modal content
- </Title>
- <Stack gap="md" p="md">
- <Box p="1rem 0">Legacy modal text content</Box>
- {enableNesting && <Launchers />}
- </Stack>
- <CloseButton
- onClick={() => setLegacyModalCount((c) => c - 1)}
- />
- </Group>
- </ModalContent>
- </LegacyModal>
- );
- })}
- {Array.from({ length: mantineModalCount }).map((_, index) => (
- <SimpleModal
- key={`mantine-modal-${index}`}
- title={`Mantine Modal content`}
- onClose={() => setMantineModalCount((c) => c - 1)}
- >
- <Stack gap="md">
- <Text>Mantine Modal text content</Text>
- {enableNesting && <Launchers />}
- </Stack>
- </SimpleModal>
- ))}
- {Array.from({ length: mantineModalWithTitlePropCount }).map(
- (_value, index) => (
- <MantineModal
- opened
- key={`mantine-modal-with-title-prop-${index}`}
- title="Mantine Modal content"
- onClose={() => setMantineModalWithTitlePropCount((c) => c - 1)}
- >
- <Text>Mantine Modal text content</Text>
- {enableNesting && <Launchers />}
- </MantineModal>
- ),
- )}
- {Array.from({ length: sidesheetCount }).map((_value, index) => (
- <Sidesheet
- key={`sidesheet-${index}`}
- isOpen
- onClose={() => setSidesheetCount((c) => c - 1)}
- title="Sidesheet content"
- >
- Sidesheet text content
- {enableNesting && <Launchers />}
- </Sidesheet>
- ))}
- {Array.from({ length: entityPickerCount }).map((_value, index) => (
- <EntityPickerModal
- key={`entity-picker-${index}`}
- title={`Entity Picker content`}
- selectedItem={null}
- canSelectItem={false}
- tabs={[]}
- onClose={() => {
- setEntityPickerCount((c) => c - 1);
- }}
- onItemSelect={_.noop}
- onConfirm={() => {
- setEntityPickerCount((c) => c - 1);
- }}
- >
- <Box p="lg">Entity Picker text content</Box>
- {enableNesting && (
- <Box p="lg">
- <Launchers />
- </Box>
- )}
- </EntityPickerModal>
- ))}
- {Array.from({ length: commandPaletteCount }).map((_value, index) => {
- const modalTitleId = `command-palette-title-${index}`;
- // This isn't a command palette per say, but this does test that "<Overlay>" works as we expect
- return (
- <Overlay
- key={`command-palette-${index}`}
- //@ts-expect-error We are doing a bad job with polymophic mantine component types, but this is fine
- onClick={() => {
- setCommandPaletteCount((c) => c - 1);
- }}
- aria-labelledby={modalTitleId}
- component={Box}
- >
- <div onClick={(e) => e.stopPropagation()}>
- <Flex p="lg">
- <Stack>
- <Title id={modalTitleId} order={3}>
- Command Palette content
- </Title>
- <Text>Command Palette text content</Text>
- {enableNesting && <Launchers />}
- </Stack>
- </Flex>
- </div>
- </Overlay>
- );
- })}
- </Stack>
- );
-};
-
-const CloseButton = (props: ButtonProps) => {
- return (
- <Button
- pos="absolute"
- top={0}
- right={0}
- w="3rem"
- style={{ border: "none" }}
- {...props}
- >
- <Icon name="close" />
- </Button>
- );
-};
-
-const SimpleModal = ({
- title,
- children = "MantineModal body",
- ...props
-}: Omit<ModalProps, "opened">) => (
- <MantineModal.Root {...props} opened size="70rem">
- <MantineModal.Overlay />
- <MantineModal.Content>
- <MantineModal.Header>
- {" "}
- <MantineModal.Title>{title}</MantineModal.Title>
- <MantineModal.CloseButton />
- </MantineModal.Header>
- <MantineModal.Body>{children}</MantineModal.Body>
- </MantineModal.Content>
- </MantineModal.Root>
-);
-
-function getToasts(length: number) {
- return Array.from({ length }).map(() =>
- createMockUndo({
- message: `Undo-style toast text content`,
- }),
- );
-}
diff --git a/frontend/src/metabase/css/core/overlays/find-utils.tsx b/frontend/src/metabase/css/core/overlays/find-utils.tsx
deleted file mode 100644
index 8eff16a717b..00000000000
--- a/frontend/src/metabase/css/core/overlays/find-utils.tsx
+++ /dev/null
@@ -1,33 +0,0 @@
-// eslint-disable-next-line no-restricted-imports -- this is only used in stories
-import { within } from "@storybook/test";
-
-import { EMBEDDING_SDK_PORTAL_ROOT_ELEMENT_ID } from "metabase/embedding-sdk/config";
-
-import { hidden } from "./constants";
-
-export const findListboxWithOption = async (
- portalRoot: HTMLElement,
- optionText: string | RegExp,
-) => {
- const listboxes = await within(portalRoot).findAllByRole("listbox", hidden);
-
- for (const listbox of listboxes) {
- try {
- await within(listbox).findByRole("option", {
- name: optionText,
- ...hidden,
- });
- return listbox;
- } catch (error) {
- // continue
- }
- }
-
- throw new Error(`No listbox found containing the option "${optionText}"`);
-};
-
-/** Overlays are typically appended to a portal root. Normally it's
- * the <body>. In the SDK, it's a custom element. */
-export const getPortalRootElement = () =>
- document.getElementById(EMBEDDING_SDK_PORTAL_ROOT_ELEMENT_ID) ||
- document.body;
diff --git a/frontend/src/metabase/css/core/overlays/overlays.stories.tsx b/frontend/src/metabase/css/core/overlays/overlays.stories.tsx
deleted file mode 100644
index 260ea2ea9d3..00000000000
--- a/frontend/src/metabase/css/core/overlays/overlays.stories.tsx
+++ /dev/null
@@ -1,251 +0,0 @@
-// @ts-expect-error There is no type definition
-import createAsyncCallback from "@loki/create-async-callback";
-import type { Store } from "@reduxjs/toolkit";
-import type { StoryFn } from "@storybook/react";
-import { userEvent, within } from "@storybook/test";
-import { Provider } from "react-redux";
-import _ from "underscore";
-
-import { getStore } from "__support__/entities-store";
-import { mockSettings } from "__support__/settings";
-import { createMockEntitiesState } from "__support__/store";
-import { Api } from "metabase/api";
-import { publicReducers } from "metabase/reducers-public";
-import { createMockCard } from "metabase-types/api/mocks";
-import { createSampleDatabase } from "metabase-types/api/mocks/presets";
-import type { State } from "metabase-types/store";
-import {
- createMockQueryBuilderState,
- createMockState,
-} from "metabase-types/store/mocks";
-
-import { OverlaysDemo, type OverlaysDemoProps } from "./OverlaysDemo";
-import { hidden } from "./constants";
-import { findListboxWithOption } from "./find-utils";
-
-const mockCard = createMockCard();
-const storeInitialState = createMockState({
- qb: createMockQueryBuilderState({ card: mockCard }),
- settings: mockSettings(),
- entities: createMockEntitiesState({
- databases: [createSampleDatabase()],
- questions: [mockCard],
- }),
-});
-const publicReducerNames = Object.keys(publicReducers);
-const initialState = _.pick(storeInitialState, ...publicReducerNames) as State;
-const reducers = publicReducers;
-
-const storeMiddleware = [Api.middleware];
-
-const store = getStore(
- reducers,
- initialState,
- storeMiddleware,
-) as unknown as Store<State>;
-
-const ReduxDecorator = (Story: StoryFn) => {
- return (
- <Provider store={store}>
- <Story />
- </Provider>
- );
-};
-
-const Template: StoryFn<OverlaysDemoProps> = (args) => {
- return <OverlaysDemo {...args} />;
-};
-
-type Scenario = {
- render: StoryFn<OverlaysDemoProps>;
- args: OverlaysDemoProps;
- play?: ({
- canvasElement,
- }: {
- canvasElement: HTMLCanvasElement;
- }) => Promise<void>;
- parameters?: Record<string, unknown>;
-};
-
-const scenarioDefaults: Scenario = {
- render: Template,
- args: {
- enableNesting: true,
- },
-};
-
-export const AllOverlays: Scenario = scenarioDefaults;
-
-export default {
- title: "Patterns/Overlays",
- component: (...args: any) => {
- return <OverlaysDemo {...args} />;
- },
- decorators: [ReduxDecorator],
- parameters: {
- layout: "fullscreen",
- },
-};
-
-type OverlayType =
- | "Mantine Modal"
- | "Mantine Popover"
- | "Mantine HoverCard"
- | "Mantine Select"
- | "Legacy Tooltip"
- | "Legacy Modal"
- | "Legacy Popover"
- | "Legacy Select";
-
-type Launcher = ({
- launchFrom,
- portalRoot,
-}: {
- launchFrom: HTMLElement;
- portalRoot: HTMLElement;
-}) => Promise<HTMLElement>;
-
-const getLaunchers = ({ portalRoot }: { portalRoot: HTMLElement }) => {
- const launchers: Record<OverlayType, Launcher> = {
- "Mantine Modal": async ({ launchFrom }) => {
- await userEvent.click(
- await within(launchFrom).findByRole("button", {
- name: "Mantine Modal",
- }),
- );
- const modal = await within(portalRoot).findByRole("dialog", {
- name: /Mantine Modal content/i,
- });
- await within(modal).findByText("Mantine Modal text content");
- return modal;
- },
- "Legacy Modal": async ({ launchFrom }) => {
- await userEvent.click(
- await within(launchFrom).findByRole("button", { name: "Legacy modal" }),
- );
- const modal = await within(portalRoot).findByRole("dialog", {
- name: "Legacy modal content",
- });
- await within(modal).findByText("Legacy modal text content");
- return modal;
- },
- "Legacy Popover": async ({ launchFrom }) => {
- // NOTE: Legacy Popovers are hovered, not clicked
- await userEvent.hover(
- await within(launchFrom).findByRole("button", {
- name: "Legacy popover",
- }),
- );
- return await within(portalRoot).findByRole("tooltip", {
- name: "Legacy popover content",
- });
- },
- "Legacy Tooltip": async ({ launchFrom }) => {
- await userEvent.hover(
- await within(launchFrom).findByRole("button", {
- name: "Legacy tooltip",
- }),
- );
- return await within(portalRoot).findByRole("tooltip", {
- name: "Legacy tooltip content",
- });
- },
- "Legacy Select": async ({ launchFrom }) => {
- await userEvent.click(
- await within(launchFrom).findByRole("button", {
- name: /Legacy Select option 1/,
- }),
- );
- within(portalRoot).findByRole("option", {
- name: "Legacy Select option 2",
- });
- return await within(portalRoot).findByTestId("LegacySelect-list");
- },
- "Mantine Popover": async ({ launchFrom }) => {
- // NOTE: Mantine Popovers are clicked, not hovered
- await userEvent.click(
- await within(launchFrom).findByRole("button", {
- name: "Mantine Popover",
- }),
- );
- return await within(portalRoot).findByRole("dialog", {
- name: /^Mantine Popover$/i,
- });
- },
- "Mantine HoverCard": async ({ launchFrom }) => {
- await userEvent.hover(
- await within(launchFrom).findByRole("button", {
- name: "Mantine HoverCard",
- }),
- );
- return await within(portalRoot).findByRole("dialog", {
- name: /^Mantine HoverCard$/i,
- ...hidden,
- });
- },
- "Mantine Select": async ({ launchFrom }) => {
- await userEvent.click(
- await within(launchFrom).findByDisplayValue(/Mantine Select option 1/),
- );
- await within(portalRoot).findByRole("option", {
- name: "Mantine Select option 2",
- ...hidden,
- });
- return await findListboxWithOption(portalRoot, /Mantine Select option 2/);
- },
- };
- return launchers;
-};
-
-/** Launch overlay A, then use it to launch overlay B */
-const launchAThenB = async (
- aType: OverlayType,
- bType: OverlayType,
- { canvasElement }: { canvasElement: HTMLElement },
-) => {
- const asyncCallback = createAsyncCallback();
-
- const body = canvasElement.parentElement as HTMLElement;
- const launchers = getLaunchers({ portalRoot: body });
- const [launchA, launchB] = [launchers[aType], launchers[bType]];
- const a = await launchA({ launchFrom: body, portalRoot: body });
- await launchB({ launchFrom: a, portalRoot: body });
-
- // tell loki to make a screenshot
- asyncCallback();
-};
-
-export const MantineModalCanLaunchLegacyModal: Scenario = {
- ...scenarioDefaults,
- play: (props) => launchAThenB("Mantine Modal", "Legacy Modal", props),
-};
-
-export const LegacyModalCanLaunchMantineModal: Scenario = {
- ...scenarioDefaults,
- play: (props) => launchAThenB("Legacy Modal", "Mantine Modal", props),
-};
-
-export const MantinePopoverCanLaunchLegacySelect: Scenario = {
- ...scenarioDefaults,
- play: (props) => launchAThenB("Mantine Popover", "Legacy Select", props),
-};
-
-export const MantinePopoverCanLaunchLegacyModal: Scenario = {
- ...scenarioDefaults,
- play: (props) => launchAThenB("Mantine Popover", "Legacy Modal", props),
-};
-
-export const MantineModalCanLaunchLegacySelect: Scenario = {
- ...scenarioDefaults,
- play: (props) => launchAThenB("Mantine Modal", "Legacy Select", props),
-};
-
-export const MantineModalCanLaunchMantineHovercard: Scenario = {
- ...scenarioDefaults,
- play: (props) => launchAThenB("Mantine Modal", "Mantine HoverCard", props),
-};
-
-export const MantineModalCanLaunchMantineSelect: Scenario = {
- ...scenarioDefaults,
- play: (props) => launchAThenB("Mantine Modal", "Mantine Select", props),
-};