Skip to content

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

Fix chart color settings not applying in the query builder sidebar (#82140)

Anderson6431bc412b22
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingColorPicker/ChartSettingColorPicker.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingColorPicker/ChartSettingColorPicker.tsx
index ac8f7fd4f1e..f94a56fac16 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingColorPicker/ChartSettingColorPicker.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingColorPicker/ChartSettingColorPicker.tsx
@@ -13,6 +13,12 @@ interface ChartSettingColorPickerProps {
value: string;
title?: string;
pillSize?: PillSize;
+ /**
+ * Reports the palette color name of the picked color to onChange. Off by
+ * default because the settings widget framework treats the second onChange
+ * argument as a Question override.
+ */
+ forwardColorName?: boolean;
onChange?: (hexValue: string, colorName?: string) => void;
accentColorOptions?: AccentColorOptions;
}
@@ -22,6 +28,7 @@ export const ChartSettingColorPicker = ({
value,
title,
pillSize,
+ forwardColorName,
onChange,
accentColorOptions = {
main: true,
@@ -41,7 +48,9 @@ export const ChartSettingColorPicker = ({
value={value}
colors={getNamedAccentColors(accentColorOptions)}
withinPortal={withinPortal}
- onChange={onChange}
+ onChange={(hexValue, colorName) =>
+ onChange?.(hexValue, forwardColorName ? colorName : undefined)
+ }
pillSize={pillSize}
/>
{title && <h4 className={CS.ml1}>{title}</h4>}
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingColorPicker/ChartSettingColorPicker.unit.spec.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingColorPicker/ChartSettingColorPicker.unit.spec.tsx
new file mode 100644
index 00000000000..265ae913c78
--- /dev/null
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingColorPicker/ChartSettingColorPicker.unit.spec.tsx
@@ -0,0 +1,43 @@
+import userEvent from "@testing-library/user-event";
+
+import { render, screen, within } from "__support__/ui";
+import { color } from "metabase/ui/colors";
+
+import { ChartSettingColorPicker } from "./ChartSettingColorPicker";
+
+const pickAccent1 = async () => {
+ await userEvent.click(screen.getByLabelText(color("brand")));
+ const popover = await screen.findByRole("dialog");
+ await userEvent.click(within(popover).getByLabelText(color("accent1")));
+};
+
+describe("ChartSettingColorPicker", () => {
+ it("should not report the palette color name by default", async () => {
+ const onChange = jest.fn();
+
+ render(
+ <ChartSettingColorPicker value={color("brand")} onChange={onChange} />,
+ );
+
+ await pickAccent1();
+
+ expect(onChange).toHaveBeenCalledTimes(1);
+ expect(onChange).toHaveBeenCalledWith(color("accent1"), undefined);
+ });
+
+ it("should report the palette color name with forwardColorName", async () => {
+ const onChange = jest.fn();
+
+ render(
+ <ChartSettingColorPicker
+ value={color("brand")}
+ forwardColorName
+ onChange={onChange}
+ />,
+ );
+
+ await pickAccent1();
+
+ expect(onChange).toHaveBeenCalledWith(color("accent1"), "accent1");
+ });
+});
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldPicker/ChartSettingFieldPicker.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldPicker/ChartSettingFieldPicker.tsx
index 800f5298cc4..ba23a3231a7 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldPicker/ChartSettingFieldPicker.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldPicker/ChartSettingFieldPicker.tsx
@@ -163,6 +163,7 @@ export const ChartSettingFieldPicker = ({
<ChartSettingColorPicker
pillSize="small"
value={colors[seriesKey]}
+ forwardColorName
onChange={(hexValue, colorName) => {
onChangeSeriesColor?.(seriesKey, hexValue, colorName);
}}
diff --git a/frontend/src/metabase/visualizations/components/settings/ColumnItem/ColumnItem.tsx b/frontend/src/metabase/visualizations/components/settings/ColumnItem/ColumnItem.tsx
index e1a13037f93..0618b638111 100644
--- a/frontend/src/metabase/visualizations/components/settings/ColumnItem/ColumnItem.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ColumnItem/ColumnItem.tsx
@@ -87,6 +87,7 @@ export const ColumnItem = ({
{onColorChange && color && (
<ChartSettingColorPicker
value={color}
+ forwardColorName
onChange={onColorChange}
pillSize="small"
accentColorOptions={accentColorOptions}