Skip to content

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

Migrate ChartTypeDropdown to use Mantine ComboBox (#69734)

Sébastiena5a0773eaf34
diff --git a/.loki/reference/chrome_laptop_EmbeddingSDK_SdkQuestion_ChartTypeDropdownInner_Question_Chart_Type_Selector_List.png b/.loki/reference/chrome_laptop_EmbeddingSDK_SdkQuestion_ChartTypeDropdownInner_Question_Chart_Type_Selector_List.png
index 2406fcc8f14..f8cc8cab8ac 100644
Binary files a/.loki/reference/chrome_laptop_EmbeddingSDK_SdkQuestion_ChartTypeDropdownInner_Question_Chart_Type_Selector_List.png and b/.loki/reference/chrome_laptop_EmbeddingSDK_SdkQuestion_ChartTypeDropdownInner_Question_Chart_Type_Selector_List.png differ
diff --git a/e2e/support/helpers/e2e-embedding-sdk-assertion-helpers.ts b/e2e/support/helpers/e2e-embedding-sdk-assertion-helpers.ts
index 05c54af37ad..2e80ccfb7c6 100644
--- a/e2e/support/helpers/e2e-embedding-sdk-assertion-helpers.ts
+++ b/e2e/support/helpers/e2e-embedding-sdk-assertion-helpers.ts
@@ -34,7 +34,7 @@ export function assertSdkInteractiveQuestionOrdersUsable() {
cy.findByTestId("chart-type-selector-button").click();
cy.log("2. can switch to a trend chart");
- cy.findByRole("menu").within(() => {
+ cy.findByRole("listbox").within(() => {
cy.findByText("Trend").click();
});
diff --git a/e2e/test-component/scenarios/embedding-sdk/pivot-table-reproductions.cy.spec.tsx b/e2e/test-component/scenarios/embedding-sdk/pivot-table-reproductions.cy.spec.tsx
index aeb10061ca9..372a5ba6fcf 100644
--- a/e2e/test-component/scenarios/embedding-sdk/pivot-table-reproductions.cy.spec.tsx
+++ b/e2e/test-component/scenarios/embedding-sdk/pivot-table-reproductions.cy.spec.tsx
@@ -60,7 +60,7 @@ describe("scenarios > embedding-sdk > Pivot Table reproductions", () => {
getSdkRoot().within(() => {
cy.findByTestId("chart-type-selector-button").click();
- cy.findByRole("menu").within(() => {
+ cy.findByRole("listbox").within(() => {
cy.findByText("Pivot Table").click();
});
diff --git a/e2e/test-component/scenarios/embedding-sdk/popover.cy.spec.tsx b/e2e/test-component/scenarios/embedding-sdk/popover.cy.spec.tsx
index 16558025cb7..9c0ddab3fbd 100644
--- a/e2e/test-component/scenarios/embedding-sdk/popover.cy.spec.tsx
+++ b/e2e/test-component/scenarios/embedding-sdk/popover.cy.spec.tsx
@@ -190,7 +190,7 @@ describe("scenarios > embedding-sdk > popovers", () => {
});
cy.findByTestId("chart-type-selector-button").click();
- cy.findByRole("menu").within(() => {
+ cy.findByRole("listbox").within(() => {
cy.findByText("Trend").click();
});
diff --git a/e2e/test-component/scenarios/embedding-sdk/sdk-question.cy.spec.tsx b/e2e/test-component/scenarios/embedding-sdk/sdk-question.cy.spec.tsx
index fbcb59d3df5..ad39d9a157a 100644
--- a/e2e/test-component/scenarios/embedding-sdk/sdk-question.cy.spec.tsx
+++ b/e2e/test-component/scenarios/embedding-sdk/sdk-question.cy.spec.tsx
@@ -611,7 +611,7 @@ describe("scenarios > embedding-sdk > interactive-question", () => {
cy.findByTestId("sdk-question-save-button").should("not.exist");
- cy.findByRole("menu").within(() => {
+ cy.findByRole("listbox").within(() => {
cy.findByText("Trend").click();
});
diff --git a/e2e/test-host-app/shared/compatibility.cy.spec.js b/e2e/test-host-app/shared/compatibility.cy.spec.js
index 3a196e27bfb..637e3e7774c 100644
--- a/e2e/test-host-app/shared/compatibility.cy.spec.js
+++ b/e2e/test-host-app/shared/compatibility.cy.spec.js
@@ -62,10 +62,13 @@ describe("Embedding SDK: shared Host Apps compatibility tests", () => {
cy.findByText("Filtro").click();
});
- cy.get('[data-element-id="mantine-popover"]').within(() => {
- cy.findByText("Started At").click();
- cy.findByText(/Rango de fechas relativo…/).click();
- });
+ cy.get('[data-element-id="mantine-popover"]')
+ .should("have.length.above", 0)
+ .last()
+ .within(() => {
+ cy.findByText("Started At").click();
+ cy.findByText(/Rango de fechas relativo…/).click();
+ });
cy.findByTestId("date-filter-picker").within(() => {
cy.findByText(/^dic.*2024/).should("exist");
@@ -85,10 +88,13 @@ describe("Embedding SDK: shared Host Apps compatibility tests", () => {
}).within(() => {
cy.findByText("Filtro").click();
});
- cy.get('[data-element-id="mantine-popover"]').within(() => {
- cy.findByText("Started At").click();
- cy.findByText(/Rango de fechas fijo…/).click();
- });
+ cy.get('[data-element-id="mantine-popover"]')
+ .should("have.length.above", 0)
+ .last()
+ .within(() => {
+ cy.findByText("Started At").click();
+ cy.findByText(/Rango de fechas fijo…/).click();
+ });
cy.findByTestId("date-filter-picker").within(() => {
cy.findByText("enero 2025").should("exist");
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts
index 626bc1e266d..acf4e9ce117 100644
--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts
+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts
@@ -747,8 +747,11 @@ describe(suiteTitle, () => {
if (experience === "chart") {
cy.log("select a different visualization to enable the save button");
H.getSimpleEmbedIframeContent().within(() => {
- cy.findByText("Table").click();
- H.popover().findByText("Number").click();
+ cy.findByTestId("chart-type-selector-button").click();
+
+ cy.findByRole("listbox").within(() => {
+ cy.findByText("Number").click();
+ });
});
}
diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/ChartTypeDropdown/ChartTypeDropdown.tsx b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/ChartTypeDropdown/ChartTypeDropdown.tsx
index 5072961677c..c8f71dcc313 100644
--- a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/ChartTypeDropdown/ChartTypeDropdown.tsx
+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/ChartTypeDropdown/ChartTypeDropdown.tsx
@@ -3,7 +3,7 @@ import { t } from "ttag";
import type { IconName } from "metabase/embedding-sdk/types/icon";
import { isNotNull } from "metabase/lib/types";
-import { Icon, Menu, type MenuProps } from "metabase/ui";
+import { Combobox, Flex, Icon, Text, useCombobox } from "metabase/ui";
import visualizations from "metabase/visualizations";
import type { Visualization } from "metabase/visualizations/types";
import type { CardDisplayType } from "metabase-types/api";
@@ -17,7 +17,11 @@ import { ToolbarButton } from "../util/ToolbarButton";
* @expand
* @category InteractiveQuestion
*/
-export type ChartTypeDropdownProps = MenuProps;
+export interface ChartTypeDropdownProps {
+ opened?: boolean;
+ defaultOpened?: boolean;
+ onOpenChange?: (opened: boolean) => void;
+}
/**
* Dropdown for selecting the visualization type (bar chart, line chart, table, etc.).
@@ -27,7 +31,7 @@ export type ChartTypeDropdownProps = MenuProps;
* @category InteractiveQuestion
* @param props
*/
-export const ChartTypeDropdown = ({ ...menuProps }: ChartTypeDropdownProps) => {
+export const ChartTypeDropdown = (props: ChartTypeDropdownProps) => {
const { selectedVisualization, updateQuestionVisualization } =
useQuestionVisualization();
@@ -40,7 +44,7 @@ export const ChartTypeDropdown = ({ ...menuProps }: ChartTypeDropdownProps) => {
updateQuestionVisualization={updateQuestionVisualization}
sensibleVisualizations={sensibleVisualizations}
nonSensibleVisualizations={nonSensibleVisualizations}
- {...menuProps}
+ {...props}
/>
);
};
@@ -54,7 +58,7 @@ interface ChartTypeDropdownInnerProps extends ChartTypeDropdownProps {
/**
* Exported for testing purposes
- * Renders a menu with a list of visualizations to choose from
+ * Renders a combobox with a list of visualizations to choose from
*
* @internal
* @param props ChartTypeDropdownInnerProps
@@ -65,9 +69,21 @@ export const ChartTypeDropdownInner = (props: ChartTypeDropdownInnerProps) => {
updateQuestionVisualization,
sensibleVisualizations,
nonSensibleVisualizations,
- ...menuProps
+ opened,
+ defaultOpened,
+ onOpenChange,
} = props;
+ const combobox = useCombobox({
+ opened,
+ defaultOpened,
+ onDropdownOpen: () => onOpenChange?.(true),
+ onDropdownClose: () => {
+ onOpenChange?.(false);
+ combobox.resetSelectedOption();
+ },
+ });
+
const getVisualizationItems = (
visualizationType: CardDisplayType,
): {
@@ -106,8 +122,15 @@ export const ChartTypeDropdownInner = (props: ChartTypeDropdownInnerProps) => {
);
return (
- <Menu position="bottom-start" {...menuProps}>
- <Menu.Target>
+ <Combobox
+ store={combobox}
+ position="bottom-start"
+ onOptionSubmit={(value) => {
+ updateQuestionVisualization(value as CardDisplayType);
+ combobox.closeDropdown();
+ }}
+ >
+ <Combobox.DropdownTarget>
<ToolbarButton
data-testid="chart-type-selector-button"
disabled={!selectedElement}
@@ -119,31 +142,55 @@ export const ChartTypeDropdownInner = (props: ChartTypeDropdownInnerProps) => {
pr="md"
rightSection={<Icon ml="xs" size={10} name="chevrondown" />}
className={ToolbarButtonS.PrimaryToolbarButton}
+ onClick={() => combobox.toggleDropdown()}
/>
- </Menu.Target>
- {/* Using overflow: "auto" because Menus have a default overflow: "visible" */}
- <Menu.Dropdown h="30rem" style={{ overflow: "auto" }}>
- {sensibleItems.map(({ iconName, label, value }, index) => (
- <Menu.Item
- key={`${value}/${index}`}
- onClick={() => updateQuestionVisualization(value)}
- leftSection={iconName ? <Icon name={iconName} /> : null}
- >
- {label}
- </Menu.Item>
- ))}
-
- <Menu.Label>{t`More charts`}</Menu.Label>
- {nonsensibleItems.map(({ iconName, label, value }, index) => (
- <Menu.Item
- key={`${value}/${index}`}
- onClick={() => updateQuestionVisualization(value)}
- leftSection={iconName ? <Icon name={iconName} /> : null}
- >
- {label}
- </Menu.Item>
- ))}
- </Menu.Dropdown>
- </Menu>
+ </Combobox.DropdownTarget>
+ <Combobox.Dropdown miw={200}>
+ <Combobox.Options mah="30rem">
+ {sensibleItems.map((item, index) => (
+ <Option
+ key={index}
+ selected={item.value === selectedVisualization}
+ {...item}
+ />
+ ))}
+ <Text
+ c="text-tertiary"
+ size="sm"
+ py="xs"
+ px="sm"
+ >{t`More charts`}</Text>
+ {nonsensibleItems.map((item, index) => (
+ <Option
+ key={index}
+ selected={item.value === selectedVisualization}
+ {...item}
+ />
+ ))}
+ </Combobox.Options>
+ </Combobox.Dropdown>
+ </Combobox>
);
};
+
+interface OptionProps {
+ value: CardDisplayType;
+ label: ReturnType<Visualization["getUiName"]>;
+ iconName: IconName;
+ selected: boolean;
+}
+
+function Option(props: OptionProps) {
+ const { value, selected, iconName, label } = props;
+
+ return (
+ <Combobox.Option px="sm" py="xs" value={value} selected={selected}>
+ <Flex align="center" gap="sm">
+ {iconName ? <Icon name={iconName} flex="0 0 1rem" /> : null}
+ <Text c="inherit" style={{ whiteSpace: "nowrap" }}>
+ {label}
+ </Text>
+ </Flex>
+ </Combobox.Option>
+ );
+}
diff --git a/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.unit.spec.tsx b/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.unit.spec.tsx
index c6a00d71e89..03ec6d950de 100644
--- a/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.unit.spec.tsx
+++ b/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.unit.spec.tsx
@@ -289,9 +289,9 @@ describe("InteractiveQuestion", () => {
for (const visType of VISUALIZATION_TYPES) {
await userEvent.click(screen.getByTestId("chart-type-selector-button"));
await userEvent.click(
- await within(screen.getByRole("menu")).findByText(visType),
+ await within(screen.getByRole("listbox")).findByText(visType),
);
- expect(screen.queryByRole("menu")).not.toBeInTheDocument();
+ expect(screen.queryByRole("listbox")).not.toBeInTheDocument();
expect(
within(screen.getByTestId("chart-type-selector-button")).getByText(
visType,
diff --git a/frontend/src/metabase/ui/components/inputs/Combobox/Combobox.module.css b/frontend/src/metabase/ui/components/inputs/Combobox/Combobox.module.css
index 87bde232c3b..78fac268242 100644
--- a/frontend/src/metabase/ui/components/inputs/Combobox/Combobox.module.css
+++ b/frontend/src/metabase/ui/components/inputs/Combobox/Combobox.module.css
@@ -6,7 +6,8 @@
font-size: 0.875rem;
padding: 0.75rem 0.5rem;
- &:hover {
+ &:hover,
+ &[data-combobox-selected="true"] {
color: var(--mb-color-brand);
background-color: var(--mb-color-background-hover);
}