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
Add card level filters new UI (#84803)
Denis Berezin4f8857630341
diff --git a/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_scalar_card_filters_Number_Card_Filter_List_Expanded.png b/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_scalar_card_filters_Number_Card_Filter_List_Expanded.pngnew file mode 100644index 00000000000..25d53106289Binary files /dev/null and b/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_scalar_card_filters_Number_Card_Filter_List_Expanded.png differdiff --git a/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_scalar_card_filters_Number_Card_Filter_Widget_Expanded.png b/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_scalar_card_filters_Number_Card_Filter_Widget_Expanded.pngnew file mode 100644index 00000000000..70ca526f2adBinary files /dev/null and b/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_scalar_card_filters_Number_Card_Filter_Widget_Expanded.png differdiff --git a/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_scalar_card_filters_Number_Cards.png b/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_scalar_card_filters_Number_Cards.pngnew file mode 100644index 00000000000..5f92574b032Binary files /dev/null and b/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_scalar_card_filters_Number_Cards.png differdiff --git a/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_scalar_card_filters_Trend_Cards.png b/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_scalar_card_filters_Trend_Cards.pngnew file mode 100644index 00000000000..c7df6132b63Binary files /dev/null and b/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_scalar_card_filters_Trend_Cards.png differdiff --git a/frontend/src/metabase/dashboard/components/CollapsibleDashboardParameterList/CollapsibleDashboardParameterList.tsx b/frontend/src/metabase/dashboard/components/CollapsibleDashboardParameterList/CollapsibleDashboardParameterList.tsxindex fe4d921cafe..c4a0e533d95 100644--- a/frontend/src/metabase/dashboard/components/CollapsibleDashboardParameterList/CollapsibleDashboardParameterList.tsx+++ b/frontend/src/metabase/dashboard/components/CollapsibleDashboardParameterList/CollapsibleDashboardParameterList.tsx@@ -5,8 +5,10 @@ import { t } from "ttag";import { ToolbarButton } from "metabase/common/components/ToolbarButton";import CS from "metabase/css/core/index.css";+import { preventDragOrInputFocus } from "metabase/dashboard/components/DashCard/utils";import { DashboardParameterList } from "metabase/dashboard/components/DashboardParameterList";import { useDashboardContext } from "metabase/dashboard/context";+import { getParametersWithValues } from "metabase/parameters/utils/ui";import { Icon, Menu } from "metabase/ui";interface CollapsibleDashboardParameterListProps extends ComponentProps<@@ -27,7 +29,7 @@ export const CollapsibleDashboardParameterList = forwardRef<const { parameters } = listProps;const parametersWithValues = useMemo(- () => parameters.filter((p) => p.value != null),+ () => getParametersWithValues(parameters),[parameters],);@@ -108,7 +110,3 @@ export const CollapsibleDashboardParameterList = forwardRef<</>);});--function preventDragOrInputFocus(e: React.MouseEvent) {- e.stopPropagation();-}diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardFilterMenu/DashCardFilterMenu.module.css b/frontend/src/metabase/dashboard/components/DashCard/DashCardFilterMenu/DashCardFilterMenu.module.cssnew file mode 100644index 00000000000..53b71c6dec1--- /dev/null+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardFilterMenu/DashCardFilterMenu.module.css@@ -0,0 +1,48 @@+.trigger {+ display: inline-flex;+ align-items: center;+ gap: 0.25rem;+ height: 1rem;+ padding: 0 0.375rem;+ border-radius: 0.5rem;+ color: var(--mb-color-text-secondary);+ background: var(--mb-color-background_surface-secondary);+ /* stays clickable while the dashboard layout is being edited */+ pointer-events: all;++ &:hover {+ background: var(--mb-color-background_surface-secondary-hover);+ }++ &:focus-visible {+ outline: 2px solid var(--mb-color-core-brand);+ outline-offset: 2px;+ }++ &[data-active] {+ color: var(--mb-color-core-filter-strong);+ background: var(--mb-color-button-light-filter-default);++ &:hover {+ background: var(--mb-color-button-light-filter-hover);+ }+ }+}++.dropdown {+ &&[data-menu-dropdown] {+ overflow: auto;+ }+}++.backButton {+ display: flex;+ align-items: center;+ gap: 0.25rem;+ color: var(--mb-color-text-brand);+ font-weight: 700;++ &:hover {+ color: var(--mb-color-text-brand-hover);+ }+}diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardFilterMenu/DashCardFilterMenu.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardFilterMenu/DashCardFilterMenu.tsxnew file mode 100644index 00000000000..1017f7f6e13--- /dev/null+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardFilterMenu/DashCardFilterMenu.tsx@@ -0,0 +1,231 @@+import cx from "classnames";+import { useState } from "react";+import { t } from "ttag";++import { useTranslateContent } from "metabase/content-translation/hooks";+import {+ setEditingParameter,+ setParameterValue,+ setParameterValueToDefault,+} from "metabase/dashboard/actions";+import { useDashboardContext } from "metabase/dashboard/context";+import { useLinkedFilterParameters } from "metabase/dashboard/hooks";+import { ParameterDropdownWidget } from "metabase/parameters/components/ParameterDropdownWidget";+import { WidgetStatus } from "metabase/parameters/components/WidgetStatus";+import {+ getParameterIconName,+ getParametersWithValues,+ getVisibleParameters,+} from "metabase/parameters/utils/ui";+import { useDispatch } from "metabase/redux";+import {+ Box,+ Flex,+ Icon,+ Menu,+ Text,+ Tooltip,+ UnstyledButton,+} from "metabase/ui";+import { SAVING_DOM_IMAGE_HIDDEN_CLASS } from "metabase/visualizations/lib/save-chart-image";+import type { UiParameter } from "metabase-lib/v1/parameters/types";+import { isDateParameter } from "metabase-lib/v1/parameters/utils/parameter-type";+import {+ areParameterValuesIdentical,+ parameterHasNoDisplayValue,+} from "metabase-lib/v1/parameters/utils/parameter-values";+import type { ParameterId } from "metabase-types/api";++import { preventDragOrInputFocus } from "../utils";++import S from "./DashCardFilterMenu.module.css";++const LIST_WIDTH = 256;+const WIDGET_MIN_WIDTH = 380;++interface DashCardFilterMenuProps {+ parameters: UiParameter[];+}++export function DashCardFilterMenu({+ parameters: allParameters,+}: DashCardFilterMenuProps) {+ const dispatch = useDispatch();+ const tc = useTranslateContent();+ const { isEditing, hideParameters } = useDashboardContext();+ const parameters = getVisibleParameters(allParameters, hideParameters);+ const [isOpen, setIsOpen] = useState(false);+ const [selectedParameterId, setSelectedParameterId] =+ useState<ParameterId | null>(null);++ const selectedParameter = parameters.find(+ (parameter) => parameter.id === selectedParameterId,+ );+ const activeCount = getParametersWithValues(parameters).length;++ const handleOpenChange = (nextIsOpen: boolean) => {+ setIsOpen(nextIsOpen);+ if (!nextIsOpen) {+ setSelectedParameterId(null);+ }+ };++ // While editing the dashboard, a filter opens its settings sidebar instead+ // of its value picker, like the filter widgets elsewhere on the dashboard.+ const handleSelectParameter = (parameterId: ParameterId) => {+ if (isEditing) {+ dispatch(setEditingParameter(parameterId));+ handleOpenChange(false);+ } else {+ setSelectedParameterId(parameterId);+ }+ };++ if (parameters.length === 0) {+ return null;+ }++ return (+ <Menu+ opened={isOpen}+ onChange={handleOpenChange}+ position="bottom-start"+ closeOnItemClick={false}+ >+ <Menu.Target>+ <Tooltip label={t`Show filters`}>+ <UnstyledButton+ className={cx(S.trigger, SAVING_DOM_IMAGE_HIDDEN_CLASS)}+ aria-label={t`Show filters`}+ data-active={activeCount > 0 || undefined}+ data-testid="show-filter-parameter-button"+ onMouseDown={preventDragOrInputFocus}+ >+ <Icon name="filter" size={12} />+ {activeCount > 0 && (+ <Text+ component="span"+ fz={11}+ lh={1}+ fw={700}+ c="inherit"+ data-testid="show-filter-parameter-count"+ >+ {activeCount}+ </Text>+ )}+ </UnstyledButton>+ </Tooltip>+ </Menu.Target>+ <Menu.Dropdown+ // Remount on content swap so the dropdown is positioned for the widget's+ // own size: a tall date list can then flip above the card.+ key={selectedParameterId ?? "list"}+ className={S.dropdown}+ // The dropdown keeps the max-width measured for the filter list, which+ // would clip a double calendar (metabase#52918).+ maw={+ selectedParameter && isDateParameter(selectedParameter)+ ? "100vw !important"+ : undefined+ }+ data-testid="show-filter-parameter-dropdown"+ onMouseDown={preventDragOrInputFocus}+ >+ {selectedParameter ? (+ <FilterWidget+ parameter={selectedParameter}+ onBack={() => setSelectedParameterId(null)}+ onClose={() => handleOpenChange(false)}+ />+ ) : (+ <Box miw={LIST_WIDTH}>+ {parameters.map((parameter) => (+ <Menu.Item+ key={parameter.id}+ leftSection={<Icon name={getParameterIconName(parameter)} />}+ rightSection={<Icon name="chevronright" />}+ onClick={() => handleSelectParameter(parameter.id)}+ >+ {tc(parameter.name)}+ </Menu.Item>+ ))}+ </Box>+ )}+ </Menu.Dropdown>+ </Menu>+ );+}++interface FilterWidgetProps {+ parameter: UiParameter;+ onBack: () => void;+ onClose: () => void;+}++function FilterWidget({ parameter, onBack, onClose }: FilterWidgetProps) {+ const dispatch = useDispatch();+ const tc = useTranslateContent();+ const { dashboard } = useDashboardContext();+ const linkedFilterParameters = useLinkedFilterParameters();++ const status = getValueStatus(parameter);++ return (+ <Box miw={WIDGET_MIN_WIDTH}>+ <Flex align="center" pr="md">+ <UnstyledButton className={S.backButton} p="md" onClick={onBack}>+ <Icon name="chevronleft" size={12} />+ <Text component="span" fw={700} c="inherit">+ {tc(parameter.name)}+ </Text>+ </UnstyledButton>+ {status && (+ <WidgetStatus+ status={status}+ highlighted+ onClick={() => {+ if (status === "reset") {+ dispatch(setParameterValueToDefault(parameter.id));+ } else {+ dispatch(setParameterValue(parameter.id, null));+ }+ onClose();+ }}+ />+ )}+ </Flex>+ <ParameterDropdownWidget+ parameter={parameter}+ parameters={linkedFilterParameters}+ value={parameter.value}+ dashboardId={dashboard?.id}+ enableRequiredBehavior+ setValue={(value) => {+ dispatch(setParameterValue(parameter.id, value));+ onClose();+ }}+ onFocusChanged={() => undefined}+ onPopoverClose={onClose}+ />+ </Box>+ );+}++// Same rules as the pill widget's action icon, with required behavior on.+function getValueStatus(parameter: UiParameter): "reset" | "clear" | null {+ const hasValue = !parameterHasNoDisplayValue(parameter.value);+ const hasDefault = !parameterHasNoDisplayValue(parameter.default);+ const wrap = (value: unknown) => (Array.isArray(value) ? value : [value]);++ if (+ hasDefault &&+ !areParameterValuesIdentical(wrap(parameter.value), wrap(parameter.default))+ ) {+ return "reset";+ }+ if (hasValue && !(parameter.required && hasDefault)) {+ return "clear";+ }+ return null;+}diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardFilterMenu/DashCardFilterMenu.unit.spec.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardFilterMenu/DashCardFilterMenu.unit.spec.tsxnew file mode 100644index 00000000000..2a9b1fe7694--- /dev/null+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardFilterMenu/DashCardFilterMenu.unit.spec.tsx@@ -0,0 +1,272 @@+import userEvent from "@testing-library/user-event";++import { createMockDashboardState } from "__support__/state";+import { renderWithProviders, screen, within } from "__support__/ui";+import * as dashboardActions from "metabase/dashboard/actions";+import { MockDashboardContext } from "metabase/dashboard/context/mock-context";+import type { UiParameter } from "metabase-lib/v1/parameters/types";+import {+ createMockDashboard,+ createMockParameter,+} from "metabase-types/api/mocks";++import { DashCardFilterMenu } from "./DashCardFilterMenu";++const CATEGORY = createMockParameter({+ id: "category",+ name: "Category",+ slug: "category",+ type: "string/=",+});++const VENDOR = createMockParameter({+ id: "vendor",+ name: "Vendor",+ slug: "vendor",+ type: "string/=",+});++interface SetupOpts {+ parameters: UiParameter[];+ isEditing?: boolean;+ hideParameters?: string;+}++const setup = ({+ parameters,+ isEditing = false,+ hideParameters,+}: SetupOpts) => {+ const dashboard = createMockDashboard({ parameters });+ const parameterValues = Object.fromEntries(+ parameters.map((parameter) => [parameter.id, parameter.value ?? null]),+ );++ renderWithProviders(+ <MockDashboardContext+ dashboardId={dashboard.id}+ dashboard={dashboard}+ parameters={parameters}+ parameterValues={parameterValues}+ isEditing={isEditing}+ hideParameters={hideParameters}+ >+ <DashCardFilterMenu parameters={parameters} />+ </MockDashboardContext>,+ {+ storeInitialState: {+ dashboard: createMockDashboardState({+ dashboardId: dashboard.id,+ dashboards: { [dashboard.id]: { ...dashboard, dashcards: [] } },+ parameterValues,+ }),+ },+ },+ );+};++const getTrigger = () => screen.getByTestId("show-filter-parameter-button");++describe("DashCardFilterMenu", () => {+ afterEach(() => {+ jest.restoreAllMocks();+ });++ it("should show a plain filter button when no filter has a value", () => {+ setup({ parameters: [CATEGORY, VENDOR] });++ expect(getTrigger()).toHaveAccessibleName("Show filters");+ expect(getTrigger()).not.toHaveAttribute("data-active");+ expect(+ screen.queryByTestId("show-filter-parameter-count"),+ ).not.toBeInTheDocument();+ });++ it("should leave hidden filters out of the list and the count", async () => {+ setup({+ parameters: [{ ...CATEGORY, value: ["Gadget"] }, VENDOR],+ hideParameters: "category",+ });++ expect(getTrigger()).not.toHaveAttribute("data-active");+ expect(+ screen.queryByTestId("show-filter-parameter-count"),+ ).not.toBeInTheDocument();++ await userEvent.click(getTrigger());+ const dropdown = within(+ await screen.findByTestId("show-filter-parameter-dropdown"),+ );+ expect(dropdown.getByRole("menuitem", { name: /Vendor/ })).toBeVisible();+ expect(+ dropdown.queryByRole("menuitem", { name: /Category/ }),+ ).not.toBeInTheDocument();+ });++ it("should render nothing when every filter is hidden", () => {+ setup({ parameters: [CATEGORY], hideParameters: "category" });++ expect(+ screen.queryByTestId("show-filter-parameter-button"),+ ).not.toBeInTheDocument();+ });++ it("should count the filters that have a value", () => {+ setup({+ parameters: [{ ...CATEGORY, value: ["Gadget"] }, VENDOR],+ });++ expect(getTrigger()).toHaveAttribute("data-active");+ expect(screen.getByTestId("show-filter-parameter-count")).toHaveTextContent(+ "1",+ );+ });++ it("should list the filters and open the picked one, with a way back to the list", async () => {+ setup({ parameters: [CATEGORY, VENDOR] });++ await userEvent.click(getTrigger());+ const dropdown = within(+ await screen.findByTestId("show-filter-parameter-dropdown"),+ );+ expect(dropdown.getByRole("menuitem", { name: /Category/ })).toBeVisible();+ expect(dropdown.getByRole("menuitem", { name: /Vendor/ })).toBeVisible();++ await userEvent.click(dropdown.getByRole("menuitem", { name: /Vendor/ }));+ // the dropdown remounts when its content changes, so query it again+ const widget = within(screen.getByTestId("show-filter-parameter-dropdown"));+ expect(widget.getByRole("button", { name: /Vendor/ })).toBeVisible();+ expect(widget.getByPlaceholderText("Enter some text")).toBeVisible();+ expect(widget.queryByRole("menuitem")).not.toBeInTheDocument();++ await userEvent.click(widget.getByRole("button", { name: /Vendor/ }));+ const list = within(screen.getByTestId("show-filter-parameter-dropdown"));+ expect(list.getByRole("menuitem", { name: /Category/ })).toBeVisible();+ expect(list.getByRole("menuitem", { name: /Vendor/ })).toBeVisible();+ });++ it("should set the filter value and close when a value is applied", async () => {+ const setParameterValue = jest.spyOn(dashboardActions, "setParameterValue");+ setup({ parameters: [CATEGORY] });++ await userEvent.click(getTrigger());+ await userEvent.click(+ await screen.findByRole("menuitem", { name: /Category/ }),+ );+ await userEvent.type(+ screen.getByPlaceholderText("Enter some text"),+ "Gadget{enter}",+ );+ await userEvent.click(screen.getByRole("button", { name: "Add filter" }));++ expect(setParameterValue).toHaveBeenCalledWith("category", ["Gadget"]);+ expect(+ screen.queryByTestId("show-filter-parameter-dropdown"),+ ).not.toBeInTheDocument();+ });++ it("should set a text variable's value and close when it is committed", async () => {+ const setParameterValue = jest.spyOn(dashboardActions, "setParameterValue");+ setup({+ parameters: [+ {+ ...CATEGORY,+ hasVariableTemplateTagTarget: true,+ values_query_type: "none",+ },+ ],+ });++ await userEvent.click(getTrigger());+ await userEvent.click(+ await screen.findByRole("menuitem", { name: /Category/ }),+ );+ await userEvent.type(+ screen.getByPlaceholderText("Enter a value..."),+ "Gadget{enter}",+ );++ expect(setParameterValue).toHaveBeenCalledWith("category", "Gadget");+ expect(+ screen.queryByTestId("show-filter-parameter-dropdown"),+ ).not.toBeInTheDocument();+ });++ it("should clear the value and close from the filter's header", async () => {+ const setParameterValue = jest.spyOn(dashboardActions, "setParameterValue");+ setup({ parameters: [{ ...CATEGORY, value: ["Gadget"] }] });++ await userEvent.click(getTrigger());+ await userEvent.click(+ await screen.findByRole("menuitem", { name: /Category/ }),+ );+ await userEvent.click(screen.getByRole("button", { name: "Clear" }));++ expect(setParameterValue).toHaveBeenCalledWith("category", null);+ expect(+ screen.queryByTestId("show-filter-parameter-dropdown"),+ ).not.toBeInTheDocument();+ });++ it("should offer a reset instead of a clear when the value differs from the default", async () => {+ const setParameterValueToDefault = jest.spyOn(+ dashboardActions,+ "setParameterValueToDefault",+ );+ setup({+ parameters: [+ { ...CATEGORY, value: ["Gadget"], default: ["Widget"], required: true },+ ],+ });++ await userEvent.click(getTrigger());+ await userEvent.click(+ await screen.findByRole("menuitem", { name: /Category/ }),+ );+ expect(+ screen.queryByRole("button", { name: "Clear" }),+ ).not.toBeInTheDocument();+ await userEvent.click(+ screen.getByRole("button", { name: "Reset filter to default state" }),+ );++ expect(setParameterValueToDefault).toHaveBeenCalledWith("category");+ expect(+ screen.queryByTestId("show-filter-parameter-dropdown"),+ ).not.toBeInTheDocument();+ });++ it("should offer neither clear nor reset when the filter has no value", async () => {+ setup({ parameters: [CATEGORY] });++ await userEvent.click(getTrigger());+ await userEvent.click(+ await screen.findByRole("menuitem", { name: /Category/ }),+ );++ expect(+ screen.queryByRole("button", { name: "Clear" }),+ ).not.toBeInTheDocument();+ expect(+ screen.queryByRole("button", { name: "Reset filter to default state" }),+ ).not.toBeInTheDocument();+ });++ it("should open the filter settings instead of the value picker while editing the dashboard", async () => {+ const setEditingParameter = jest.spyOn(+ dashboardActions,+ "setEditingParameter",+ );+ setup({ parameters: [CATEGORY, VENDOR], isEditing: true });++ await userEvent.click(getTrigger());+ await userEvent.click(+ await screen.findByRole("menuitem", { name: /Vendor/ }),+ );++ expect(setEditingParameter).toHaveBeenCalledWith("vendor");+ expect(+ screen.queryByTestId("show-filter-parameter-dropdown"),+ ).not.toBeInTheDocument();+ });+});diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsxindex 7b56bebbc26..f130d216a9a 100644--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx@@ -90,6 +90,7 @@ import {import { CollapsibleDashboardParameterList } from "../CollapsibleDashboardParameterList";import { ClickBehaviorSidebarOverlay } from "./ClickBehaviorSidebarOverlay/ClickBehaviorSidebarOverlay";+import { DashCardFilterMenu } from "./DashCardFilterMenu/DashCardFilterMenu";import { DashCardMenu } from "./DashCardMenu/DashCardMenu";import { DashCardParameterMapper } from "./DashCardParameterMapper/DashCardParameterMapper";import S from "./DashCardVisualization.module.css";@@ -169,6 +170,8 @@ interface DashCardVisualizationProps {// This is done to add the `getExtraDataForClick` prop.// We need that to pass relevant data along with the clicked object.+const SCALAR_DISPLAYS = new Set<string>(["scalar", "smartscalar"]);+export function DashCardVisualization({dashcard,series: rawSeries,@@ -496,6 +499,9 @@ export function DashCardVisualization({return settings["card.title"] ?? series?.[0].card.name ?? "";}, [series]);+ const display = series?.[0]?.card.display;+ const isScalarCard = display != null && SCALAR_DISPLAYS.has(display);+const fontFamily = useSelector((state) =>getSetting(state, "application-font"),);@@ -530,6 +536,17 @@ export function DashCardVisualization({const withTimelineEvents =isTimelineEventsEnabled && isChartTimelineEventsEnabled;+ // A 403 means the viewer may not see the card's data, so its filters stay hidden too.+ const hasViewAccess = useMemo(() => {+ const cardId = dashcard.card_id ?? dashcard.card?.id;+ const cardResult = cardId ? datasets?.[cardId] : undefined;+ const errorStatus =+ cardResult?.error && typeof cardResult.error === "object"+ ? cardResult.error.status+ : undefined;+ return !cardResult || errorStatus !== 403;+ }, [dashcard, datasets]);+const actionButtons = useMemo(() => {const cardId = dashcard.card_id ?? dashcard.card?.id;const cardResult = cardId ? datasets?.[cardId] : undefined;@@ -551,13 +568,10 @@ export function DashCardVisualization({withTimelineEvents,});- const errorStatus =- cardResult?.error && typeof cardResult.error === "object"- ? cardResult.error.status- : undefined;- const hasViewAccess = !cardResult || errorStatus !== 403;-- const showInlineParams = inlineParameters.length > 0 && hasViewAccess;+ // Number and Trend cards have no header row, so their filters render in+ // the leading slot instead of here.+ const showInlineParams =+ inlineParameters.length > 0 && hasViewAccess && !isScalarCard;if (!showMenu && !showInlineParams) {return null;@@ -607,8 +621,18 @@ export function DashCardVisualization({titleMenuItems,shouldCollapseList,parameterListRef,+ isScalarCard,+ hasViewAccess,]);+ const cardLevelFilters = useMemo(() => {+ if (!isScalarCard || inlineParameters.length === 0 || !hasViewAccess) {+ return null;+ }++ return <DashCardFilterMenu parameters={inlineParameters} />;+ }, [hasViewAccess, inlineParameters, isScalarCard]);+const { getExtraDataForClick } = useClickBehaviorData({dashcardId: dashcard.id,});@@ -683,6 +707,7 @@ export function DashCardVisualization({isEditingParameter={isEditingParameter}isMobile={isMobile}actionButtons={actionButtons}+ cardLevelFilters={cardLevelFilters}replacementContent={visualizationOverlay}getExtraDataForClick={getExtraDataForClick}transformClickObject={transformClickObject}diff --git a/frontend/src/metabase/dashboard/components/DashCard/Dashcard.unit.spec.tsx b/frontend/src/metabase/dashboard/components/DashCard/Dashcard.unit.spec.tsxindex 41e659ef567..b7d13c161e8 100644--- a/frontend/src/metabase/dashboard/components/DashCard/Dashcard.unit.spec.tsx+++ b/frontend/src/metabase/dashboard/components/DashCard/Dashcard.unit.spec.tsx@@ -33,6 +33,7 @@ import { registerDashboardVisualizations } from "metabase/dashboard/visualizatioimport { reinitialize } from "metabase/plugins";import { SERVER_ERROR_TYPES } from "metabase/utils/errors";import { registerVisualizations } from "metabase/visualizations/register";+import { loadVisualizationComponents } from "metabase/viz-core";import * as Lib from "metabase-lib";import Question from "metabase-lib/v1/Question";import {@@ -133,6 +134,7 @@ function setup({dashcard = tableDashcard,dashcardData = tableDashcardData,isEditing,+ isEditingParameter = false,withMetadata = false,databases,parameterValues = {},@@ -142,7 +144,7 @@ function setup({}: Partial<DashCardProps> &Pick<MockDashboardContextProps,- "dashcardMenu" | "isEditing" | "withTimelineEvents"+ "dashcardMenu" | "isEditing" | "isEditingParameter" | "withTimelineEvents"> & {dashboard?: NonNullable<MockDashboardContextProps["dashboard"]>;dashcardData?: DashCardDataMap;@@ -198,7 +200,7 @@ function setup({downloadsEnabled={{ results: true }}slowCards={{}}isEditing={isEditing}- isEditingParameter={false}+ isEditingParameter={isEditingParameter}dashcardMenu={dashcardMenu}withTimelineEvents={withTimelineEvents}reportAutoScrolledToDashcard={jest.fn()}@@ -1350,5 +1352,80 @@ describe("DashCard", () => {// a filter for data the user can't access.expect(screen.queryByText("State")).not.toBeInTheDocument();});++ describe("Number cards", () => {+ // The Number chart loads on demand; load it up front so the render does not suspend mid-test.+ beforeAll(() => loadVisualizationComponents(["scalar"]));++ const parameter = createMockParameter({+ id: "param-1",+ name: "Category",+ type: "string/=",+ slug: "category",+ });+ const numberCard = createMockCard({+ name: "Sum of Total",+ display: "scalar",+ });+ // tall enough for the parameter mapper to show the card title header+ const dashcard = createMockDashboardCard({+ card: numberCard,+ inline_parameters: [parameter.id],+ size_y: 2,+ });+ const dashboard = createMockDashboard({+ parameters: [parameter],+ dashcards: [dashcard],+ });+ const dashcardData: DashCardDataMap = {+ [dashcard.id]: {+ [numberCard.id]: createMockDataset({+ data: createMockDatasetData({+ rows: [[100]],+ cols: [createMockNumericColumn({ name: "sum" })],+ }),+ database_id: 1,+ context: "dashboard",+ status: "completed",+ }),+ },+ };++ beforeEach(() => {+ jest+ .spyOn(+ dashboardSelectors,+ "getDashCardInlineValuePopulatedParameters",+ )+ .mockReturnValue([{ ...parameter, value: ["Gadget"] }]);+ });++ it("should show the card-level filters as a compact menu instead of the header list", () => {+ setup({ dashboard, dashcard, dashcardData });++ expect(+ screen.getByTestId("show-filter-parameter-button"),+ ).toBeInTheDocument();+ expect(+ screen.getByTestId("show-filter-parameter-count"),+ ).toHaveTextContent("1");+ expect(screen.queryByText("Category")).not.toBeInTheDocument();+ });++ it("should hide the card-level filters while a parameter is being edited, when the mapper shows the title", () => {+ setup({+ dashboard,+ dashcard,+ dashcardData,+ isEditing: true,+ isEditingParameter: true,+ });++ expect(+ screen.queryByTestId("show-filter-parameter-button"),+ ).not.toBeInTheDocument();+ expect(screen.getByText("Sum of Total")).toBeInTheDocument();+ });+ });});});diff --git a/frontend/src/metabase/dashboard/components/DashCard/utils.ts b/frontend/src/metabase/dashboard/components/DashCard/utils.tsindex e98fa80f4e4..da83629ad1d 100644--- a/frontend/src/metabase/dashboard/components/DashCard/utils.ts+++ b/frontend/src/metabase/dashboard/components/DashCard/utils.ts@@ -1,3 +1,5 @@+import type { MouseEvent } from "react";+import { getVirtualCardType } from "metabase/dashboard/utils";import type {BaseDashboardCard,@@ -16,6 +18,11 @@ import {const VIZ_WITH_CUSTOM_MAPPING_UI = ["heading", "placeholder"];+/** Keeps a click on an interactive element inside a dashcard from starting a grid drag. */+export function preventDragOrInputFocus(event: MouseEvent) {+ event.stopPropagation();+}+export function shouldShowParameterMapper({dashcard,isEditingParameter,diff --git a/frontend/src/metabase/dashboard/components/DashboardParameterList/DashboardParameterList.tsx b/frontend/src/metabase/dashboard/components/DashboardParameterList/DashboardParameterList.tsxindex c9b6b475158..730cc178e1c 100644--- a/frontend/src/metabase/dashboard/components/DashboardParameterList/DashboardParameterList.tsx+++ b/frontend/src/metabase/dashboard/components/DashboardParameterList/DashboardParameterList.tsx@@ -1,4 +1,4 @@-import { type ComponentProps, forwardRef, useMemo } from "react";+import { type ComponentProps, forwardRef } from "react";import {setEditingParameter,@@ -7,10 +7,10 @@ import {setParameterValueToDefault,} from "metabase/dashboard/actions";import { useDashboardContext } from "metabase/dashboard/context";+import { useLinkedFilterParameters } from "metabase/dashboard/hooks";import { ParametersList } from "metabase/parameters/components/ParametersList";import { useDispatch } from "metabase/redux";import type { UiParameter } from "metabase-lib/v1/parameters/types";-import { getValuePopulatedParameters } from "metabase-lib/v1/parameters/utils/parameter-values";export interface DashboardParameterListProps extends Pick<ComponentProps<typeof ParametersList>,@@ -47,18 +47,8 @@ export const DashboardParameterList = forwardRef<isEditing,dashboard,hideParameters,- parameters: dashboardParameters,- parameterValues,} = useDashboardContext();-- const linkedFilterParameters = useMemo(- () =>- getValuePopulatedParameters({- parameters: dashboardParameters,- values: parameterValues,- }),- [dashboardParameters, parameterValues],- );+ const linkedFilterParameters = useLinkedFilterParameters();return (<ParametersListdiff --git a/frontend/src/metabase/dashboard/hooks/index.ts b/frontend/src/metabase/dashboard/hooks/index.tsindex 70dd4b49274..7b611cc457c 100644--- a/frontend/src/metabase/dashboard/hooks/index.ts+++ b/frontend/src/metabase/dashboard/hooks/index.ts@@ -5,3 +5,4 @@ export * from "./use-dashboard-url-query";export * from "./use-refresh-dashboard";export * from "./use-location-sync";export * from "./use-can-manage-dashboard-subscriptions";+export * from "./use-linked-filter-parameters";diff --git a/frontend/src/metabase/dashboard/hooks/use-linked-filter-parameters.ts b/frontend/src/metabase/dashboard/hooks/use-linked-filter-parameters.tsnew file mode 100644index 00000000000..db779aadc2a--- /dev/null+++ b/frontend/src/metabase/dashboard/hooks/use-linked-filter-parameters.ts@@ -0,0 +1,13 @@+import { useMemo } from "react";++import { useDashboardContext } from "metabase/dashboard/context";+import { getValuePopulatedParameters } from "metabase-lib/v1/parameters/utils/parameter-values";++export function useLinkedFilterParameters() {+ const { parameters, parameterValues } = useDashboardContext();++ return useMemo(+ () => getValuePopulatedParameters({ parameters, values: parameterValues }),+ [parameters, parameterValues],+ );+}diff --git a/frontend/src/metabase/parameters/utils/ui.ts b/frontend/src/metabase/parameters/utils/ui.tsindex 8ad1f4c21fc..2e374574daa 100644--- a/frontend/src/metabase/parameters/utils/ui.ts+++ b/frontend/src/metabase/parameters/utils/ui.ts@@ -50,6 +50,10 @@ export function getVisibleParameters();}+export function getParametersWithValues(parameters: UiParameter[]) {+ return parameters.filter((p) => p.value != null);+}+export function getParameterWidgetTitle(parameter: UiParameter) {const operator = deriveFieldOperatorFromParameter(parameter);const { verboseName } = operator || {};diff --git a/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView-scalar-card-filters.stories.tsx b/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView-scalar-card-filters.stories.tsxnew file mode 100644index 00000000000..b1344de1c14--- /dev/null+++ b/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView-scalar-card-filters.stories.tsx@@ -0,0 +1,374 @@+import type { StoryContext, StoryFn } from "@storybook/react";+import { screen, userEvent, within } from "@storybook/test";+import { HttpResponse, http } from "msw";+import type { ComponentType } from "react";+import _ from "underscore";++import { getPublicStore } from "__support__/entities-store";+import {+ createMockDashboardState,+ createMockSettingsState,+ createMockState,+} from "__support__/state";+import { getNextId } from "__support__/utils";+import { DateTimeColumn, NumberColumn } from "__support__/visualizations";+import {+ MockDashboardContext,+ type MockDashboardContextProps,+} from "metabase/dashboard/context/mock-context";+import { MetabaseReduxProvider } from "metabase/redux";+import { Scalar } from "metabase/visualizations/visualizations/Scalar/Scalar";+import { SmartScalar } from "metabase/visualizations/visualizations/SmartScalar/SmartScalar";+import { registerVisualization } from "metabase/viz-core";+import type {+ CardDisplayType,+ DashCardDataMap,+ Dashboard,+ DashboardCard,+ Parameter,+ ParameterValuesMap,+} from "metabase-types/api";+import {+ createMockCard,+ createMockColumn,+ createMockDashboard,+ createMockDashboardCard,+ createMockDatabase,+ createMockDataset,+ createMockDatasetData,+ createMockInsight,+ createMockParameter,+} from "metabase-types/api/mocks";+import { PRODUCTS } from "metabase-types/api/mocks/presets";++import { PublicOrEmbeddedDashboardView } from "./PublicOrEmbeddedDashboardView";++registerVisualization(Scalar);+registerVisualization(SmartScalar);++export default {+ title: "App/Embed/PublicOrEmbeddedDashboardView/scalar-card-filters",+ component: PublicOrEmbeddedDashboardView,+ decorators: [ReduxDecorator],+ parameters: {+ layout: "fullscreen",+ msw: {+ handlers: [+ http.get("*/api/database", () =>+ HttpResponse.json(createMockDatabase()),+ ),+ ],+ },+ },+};++type Args = MockDashboardContextProps & {+ dashboard: Dashboard;+ dashcardData: DashCardDataMap;+ parameterValues: ParameterValuesMap;+};++function ReduxDecorator(Story: ComponentType, context: StoryContext) {+ // Unjustified type cast. FIXME+ const { dashboard, dashcardData, parameterValues } = context.args as Args;+ const initialState = createMockState({+ settings: createMockSettingsState({+ "hide-embed-branding?": false,+ }),+ dashboard: createMockDashboardState({+ dashboardId: dashboard.id,+ dashboards: {+ [dashboard.id]: {+ ...dashboard,+ dashcards: dashboard.dashcards.map((dashcard) => dashcard.id),+ },+ },+ dashcards: _.indexBy(dashboard.dashcards, "id"),+ dashcardData,+ parameterValues,+ }),+ });++ const store = getPublicStore(initialState);+ return (+ <MetabaseReduxProvider store={store}>+ <Story />+ </MetabaseReduxProvider>+ );+}++const DASHBOARD_ID = getNextId();+const TAB_ID = getNextId();++const NUMBER_DATASET = createMockDataset({+ data: createMockDatasetData({+ cols: [createMockColumn(NumberColumn({ name: "Count" }))],+ rows: [[18760]],+ }),+});++const TREND_DATASET = createMockDataset({+ data: createMockDatasetData({+ cols: [+ createMockColumn(DateTimeColumn({ name: "Created At", unit: "month" })),+ createMockColumn(NumberColumn({ name: "Count" })),+ ],+ rows: [+ ["2019-10-01T00:00:00", 100],+ ["2019-11-01T00:00:00", 120],+ ],+ insights: [createMockInsight({ unit: "month", col: "Count" })],+ }),+});++interface CardSpec {+ display: Extract<CardDisplayType, "scalar" | "smartscalar">;+ col: number;+ row?: number;+ size_x: number;+ size_y: number;+ /** One entry per card-level filter; `null` leaves the filter without a value. */+ filterValues: (string | null)[];+ name?: string;+}++interface StoryDashboard {+ dashboard: Dashboard;+ dashcardData: DashCardDataMap;+ parameterValues: ParameterValuesMap;+}++const CARD_NAMES = {+ scalar: "Sum of Total",+ smartscalar: "Sum of Total by month",+};+const FILTER_NAMES = ["Category", "Vendor", "Source"];++function createStoryDashboard(cards: CardSpec[]): StoryDashboard {+ const parameters: Parameter[] = [];+ const parameterValues: ParameterValuesMap = {};+ const dashcardData: DashCardDataMap = {};++ const dashcards: DashboardCard[] = cards.map((spec, cardIndex) => {+ const cardId = getNextId();+ const dashcardId = getNextId();+ const cardParameters = spec.filterValues.map((value, index) => {+ const parameter = createMockParameter({+ id: `card-${cardIndex}-filter-${index}`,+ name: FILTER_NAMES[index],+ slug: `card_${cardIndex}_filter_${index}`,+ type: "string/=",+ });+ parameters.push(parameter);+ parameterValues[parameter.id] = value == null ? null : [value];+ return parameter;+ });++ dashcardData[dashcardId] = {+ [cardId]: spec.display === "scalar" ? NUMBER_DATASET : TREND_DATASET,+ };++ return createMockDashboardCard({+ id: dashcardId,+ dashboard_tab_id: TAB_ID,+ card: createMockCard({+ id: cardId,+ name: spec.name ?? CARD_NAMES[spec.display],+ display: spec.display,+ }),+ inline_parameters: cardParameters.map((parameter) => parameter.id),+ row: spec.row ?? 0,+ col: spec.col,+ size_x: spec.size_x,+ size_y: spec.size_y,+ parameter_mappings: cardParameters.map((parameter) => ({+ card_id: cardId,+ parameter_id: parameter.id,+ target: [+ "dimension",+ ["field", PRODUCTS.CATEGORY, { "base-type": "type/Text" }],+ ],+ })),+ });+ });++ return {+ dashboard: createMockDashboard({+ id: DASHBOARD_ID,+ name: "Card-level filters",+ width: "fixed",+ parameters,+ dashcards,+ }),+ dashcardData,+ parameterValues,+ };+}++const Template: StoryFn<Args> = ({ dashboard, ...args }) => (+ <MockDashboardContext+ {...args}+ dashboard={dashboard}+ dashboardId={dashboard.id}+ >+ <PublicOrEmbeddedDashboardView />+ </MockDashboardContext>+);++const createArgs = (storyDashboard: StoryDashboard): Args => ({+ ...storyDashboard,+ dashboardId: storyDashboard.dashboard.id,+ navigateToNewCardFromDashboard: null,+ titled: true,+ bordered: true,+ background: true,+ slowCards: {},+ selectedTabId: TAB_ID,+ downloadsEnabled: { pdf: true, results: false },+});++// Number cards: an applied filter, an empty filter, two applied filters, and the+// smallest sizes with a filter.+export const NumberCards = {+ render: Template,+ args: createArgs(+ createStoryDashboard([+ {+ display: "scalar",+ col: 0,+ size_x: 5,+ size_y: 2,+ filterValues: ["Gadget"],+ },+ { display: "scalar", col: 5, size_x: 5, size_y: 2, filterValues: [null] },+ {+ display: "scalar",+ col: 10,+ size_x: 6,+ size_y: 3,+ filterValues: ["Gadget", "Acme"],+ },+ {+ display: "scalar",+ col: 16,+ size_x: 2,+ size_y: 2,+ filterValues: ["Gadget"],+ },+ {+ display: "scalar",+ col: 18,+ size_x: 3,+ size_y: 2,+ filterValues: ["Gadget"],+ },+ {+ display: "scalar",+ col: 21,+ size_x: 3,+ size_y: 2,+ filterValues: [null],+ },+ ]),+ ),+};++// Trend cards: the pill shares the top edge with the trend symbol and comparison.+export const TrendCards = {+ render: Template,+ args: createArgs(+ createStoryDashboard([+ {+ display: "smartscalar",+ col: 0,+ size_x: 6,+ size_y: 3,+ filterValues: ["Gadget"],+ },+ {+ display: "smartscalar",+ col: 6,+ size_x: 6,+ size_y: 3,+ filterValues: ["Gadget", null],+ },+ {+ display: "smartscalar",+ col: 12,+ size_x: 2,+ size_y: 2,+ filterValues: ["Gadget"],+ },+ {+ display: "smartscalar",+ col: 14,+ size_x: 3,+ size_y: 2,+ filterValues: ["Gadget"],+ },+ {+ display: "smartscalar",+ col: 17,+ size_x: 4,+ size_y: 2,+ filterValues: [null],+ },+ {+ display: "smartscalar",+ col: 21,+ size_x: 3,+ size_y: 3,+ filterValues: [null, null],+ },+ ]),+ ),+};++// Clicking the pill lists the card's filters.+export const NumberCardFilterListExpanded = {+ render: Template,+ args: createArgs(+ createStoryDashboard([+ {+ display: "scalar",+ col: 0,+ size_x: 6,+ size_y: 3,+ filterValues: ["Gadget", null, "Email"],+ },+ ]),+ ),+ play: async ({ canvasElement }: { canvasElement: HTMLElement }) => {+ const canvas = within(canvasElement);+ await userEvent.click(+ await canvas.findByTestId("show-filter-parameter-button"),+ );+ await screen.findByRole("menuitem", { name: /Vendor/ });+ },+};++// Picking a filter swaps the list for that filter's widget, with a way back.+export const NumberCardFilterWidgetExpanded = {+ render: Template,+ args: createArgs(+ createStoryDashboard([+ {+ display: "scalar",+ col: 0,+ size_x: 6,+ size_y: 3,+ filterValues: ["Gadget", null],+ },+ ]),+ ),+ play: async ({ canvasElement }: { canvasElement: HTMLElement }) => {+ const canvas = within(canvasElement);+ await userEvent.click(+ await canvas.findByTestId("show-filter-parameter-button"),+ );+ await userEvent.click(+ await screen.findByRole("menuitem", { name: /Vendor/ }),+ );+ await screen.findByPlaceholderText("Enter some text");+ },+};diff --git a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsxindex be9849103fe..fa51f293432 100644--- a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx+++ b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx@@ -37,6 +37,7 @@ import { getVisualizationComponent } from "metabase/visualizations";import ChartCaption from "metabase/visualizations/components/ChartCaption";import ChartTooltip from "metabase/visualizations/components/ChartTooltip";import { ConnectedClickActionsPopover } from "metabase/visualizations/components/ClickActions";+import { getScalarSizeTier } from "metabase/visualizations/components/ScalarValue/sizing";import { performDefaultAction } from "metabase/visualizations/lib/action";import { hasNoResults } from "metabase/visualizations/lib/no-results";import {@@ -121,6 +122,7 @@ type VisualizationRawSeries = (type VisualizationOwnProps = {actionButtons?: ReactNode | null;+ cardLevelFilters?: ReactNode | null;className?: string;dashboard?: Dashboard;dashcard?: DashboardCard;@@ -633,6 +635,7 @@ class Visualization extends PureComponent<render() {const {actionButtons,+ cardLevelFilters,canToggleSeriesVisibility,className,dashboard,@@ -796,6 +799,7 @@ class Visualization extends PureComponent<{actionButtons}</Flex>);+ const cardLevelFiltersOffset = getScalarSizeTier(width, height).menuOffset;let { gridSize, gridUnit } = this.props;if (@@ -853,6 +857,19 @@ class Visualization extends PureComponent<data-viz-ui-name={visualization?.getUiName?.()}ref={this.props.forwardedRef}>+ {cardLevelFilters && !replacementContent && (+ <Box pos="relative" h={0} flex="0 0 auto">+ <Box+ pos="absolute"+ top={cardLevelFiltersOffset.top}+ left={cardLevelFiltersOffset.right}+ style={{ zIndex: 1 }}+ data-testid="card-level-filters"+ >+ {cardLevelFilters}+ </Box>+ </Box>+ )}{!!hasHeader && (<Box pt="0.625rem" px="sm" pb="xs" flex="0 0 auto"><ChartCaption