Skip to content

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

Discard pending slice name edits when pressing Escape (#78690)

Andersonea64c1e6f69a
diff --git a/frontend/src/metabase/visualizations/components/ChartSettingsWidgetPopover.tsx b/frontend/src/metabase/visualizations/components/ChartSettingsWidgetPopover.tsx
index 3c65c7c3356..9efba86d509 100644
--- a/frontend/src/metabase/visualizations/components/ChartSettingsWidgetPopover.tsx
+++ b/frontend/src/metabase/visualizations/components/ChartSettingsWidgetPopover.tsx
@@ -70,6 +70,7 @@ export const ChartSettingsWidgetPopover = ({
anchorEl={anchor}
opened={!!anchor && widgets.length > 0}
onDismiss={onClose}
+ closeOnEscape={false}
position="right"
offset={{ mainAxis: 10, crossAxis: 10 }}
middlewares={{
@@ -89,6 +90,14 @@ export const ChartSettingsWidgetPopover = ({
pt={hasMultipleSections ? 0 : undefined}
ref={setContentRef}
data-testid="chart-settings-widget-popover-content"
+ onKeyDown={(event) => {
+ if (event.key === "Escape") {
+ // Escape bubbles here after a focused *BlurChange input has
+ // discarded its pending value via flushSync; Mantine's document-level
+ // closeOnEscape would unmount the widget before the input could react.
+ onClose();
+ }
+ }}
mah="40rem"
miw="336px"
className={CS.overflowYAuto}
diff --git a/frontend/src/metabase/visualizations/components/ChartSettingsWidgetPopover.unit.spec.tsx b/frontend/src/metabase/visualizations/components/ChartSettingsWidgetPopover.unit.spec.tsx
index 7c77f179734..bc5b4bff9ec 100644
--- a/frontend/src/metabase/visualizations/components/ChartSettingsWidgetPopover.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/components/ChartSettingsWidgetPopover.unit.spec.tsx
@@ -9,6 +9,7 @@ import {
within,
} from "__support__/ui";
import { ChartSettingsWidgetPopover } from "metabase/visualizations/components/ChartSettingsWidgetPopover";
+import { SliceNameWidget } from "metabase/visualizations/visualizations/PieChart/SliceNameWidget";
import type { Widget } from "../types";
@@ -16,10 +17,6 @@ import { ChartSettingSelect } from "./settings/ChartSettingSelect";
type PopoverProps = ComponentProps<typeof ChartSettingsWidgetPopover>;
-const DEFAULT_PROPS: Pick<PopoverProps, "handleEndShowWidget"> = {
- handleEndShowWidget: jest.fn(),
-};
-
const FORMATTING_WIDGET: Widget = {
id: "column_settings",
section: "Formatting",
@@ -41,8 +38,11 @@ const STYLE_WIDGET: Widget = {
type SetupProps = Omit<PopoverProps, "anchor" | "handleEndShowWidget">;
const setup = (props: SetupProps) => {
+ const handleEndShowWidget = jest.fn();
+
const Container = () => {
const [anchor, setAnchor] = useState<HTMLElement>(document.body);
+ const [isOpen, setIsOpen] = useState(true);
return (
<>
@@ -55,15 +55,24 @@ const setup = (props: SetupProps) => {
>
Anchor
</p>
- <ChartSettingsWidgetPopover
- anchor={anchor}
- {...DEFAULT_PROPS}
- {...props}
- />
+ {isOpen && (
+ <ChartSettingsWidgetPopover
+ anchor={anchor}
+ handleEndShowWidget={() => {
+ handleEndShowWidget();
+ setIsOpen(false);
+ }}
+ {...props}
+ />
+ )}
</>
);
};
- return renderWithProviders(<Container />);
+
+ return {
+ ...renderWithProviders(<Container />),
+ handleEndShowWidget,
+ };
};
it("should display when an anchor is passed", async () => {
@@ -176,3 +185,35 @@ describe("Select widgets", () => {
).toBeInTheDocument();
});
});
+
+it("should discard pending slice name changes when Escape is pressed (#75868)", async () => {
+ const updateRowName = jest.fn();
+ const sliceNameWidget: Widget = {
+ id: "pieSliceName",
+ section: "Data",
+ widget: SliceNameWidget,
+ props: {
+ initialKey: "Widget",
+ pieRows: [
+ {
+ key: "Widget",
+ name: "Widget",
+ originalName: "Widget",
+ },
+ ],
+ updateRowName,
+ },
+ };
+ const { handleEndShowWidget } = setup({ widgets: [sliceNameWidget] });
+
+ const input = await screen.findByDisplayValue("Widget");
+ await userEvent.clear(input);
+ await userEvent.type(input, "MyNewName");
+ await userEvent.keyboard("{Escape}");
+
+ await waitFor(() => expect(handleEndShowWidget).toHaveBeenCalledTimes(1));
+ expect(updateRowName).not.toHaveBeenCalled();
+ expect(
+ screen.queryByTestId("chart-settings-widget-popover-content"),
+ ).not.toBeInTheDocument();
+});
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesMultiple.tsx b/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesMultiple.tsx
index dfbfdf8b82b..cacb0f3c3ca 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesMultiple.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesMultiple.tsx
@@ -75,6 +75,7 @@ export const ChartNestedSettingSeriesMultiple = ({
className={cx(CS.flexFull, CS.ml1, CS.alignSelfStretch)}
// set vertical padding to 0 and use align-self-stretch to match siblings
style={{ paddingTop: 0, paddingBottom: 0 }}
+ resetOnEsc
value={settings.title}
description={
seriesCardName === settings.title ? "" : seriesCardName
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesSingle.tsx b/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesSingle.tsx
index fcaf6efdf31..d796ea8605b 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesSingle.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesSingle.tsx
@@ -47,6 +47,7 @@ const ChartNestedSettingsSeriesSingle = ({
/>
<SeriesNameInput
className={cx(CS.flexFull, CS.ml1, CS.alignSelfStretch)}
+ resetOnEsc
value={computedSettings.title}
description={
seriesCardName === computedSettings.title ? "" : seriesCardName
diff --git a/frontend/src/metabase/visualizations/visualizations/PieChart/SliceNameWidget.tsx b/frontend/src/metabase/visualizations/visualizations/PieChart/SliceNameWidget.tsx
index 8f9d32fbfcf..ce59b8bb31b 100644
--- a/frontend/src/metabase/visualizations/visualizations/PieChart/SliceNameWidget.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/PieChart/SliceNameWidget.tsx
@@ -32,6 +32,7 @@ export function SliceNameWidget({
// only 1rem bottom padding
<Box w="100%" pb="0.5rem">
<SliceNameInput
+ resetOnEsc
value={row.name}
description={
row.name !== row.originalName ? row.originalName : undefined