Skip to content

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

Reset colors when passing undefined to theme (#63957)

Mahatthana (Kelvin) Nomsawadica66414190ea
diff --git a/e2e/test-component/scenarios/embedding-sdk/styles-tests.cy.spec.tsx b/e2e/test-component/scenarios/embedding-sdk/styles-tests.cy.spec.tsx
index b35b89345a0..05dd1566d60 100644
--- a/e2e/test-component/scenarios/embedding-sdk/styles-tests.cy.spec.tsx
+++ b/e2e/test-component/scenarios/embedding-sdk/styles-tests.cy.spec.tsx
@@ -4,9 +4,11 @@ import {
InteractiveDashboard,
InteractiveQuestion,
MetabaseProvider,
+ type MetabaseTheme,
StaticQuestion,
defineMetabaseTheme,
} from "@metabase/embedding-sdk-react";
+import { useState } from "react";
import { SAMPLE_DATABASE } from "e2e/support/cypress_sample_database";
import { ORDERS_QUESTION_ID } from "e2e/support/cypress_sample_instance_data";
@@ -132,6 +134,42 @@ describe("scenarios > embedding-sdk > styles", () => {
.invoke("css", "color")
.should("equal", "rgb(255, 0, 0)");
});
+
+ it('should be able to reset theme colors by setting it to "undefined" (EMB-696)', () => {
+ const THEME = defineMetabaseTheme({
+ colors: {
+ "text-primary": "#0000ff",
+ },
+ });
+ function TestComponent() {
+ const [theme, setTheme] = useState<MetabaseTheme | undefined>(
+ undefined,
+ );
+ return (
+ <MetabaseProvider
+ authConfig={DEFAULT_SDK_AUTH_PROVIDER_CONFIG}
+ theme={theme}
+ >
+ <button onClick={() => setTheme(THEME)}>Set theme</button>
+ <button onClick={() => setTheme(undefined)}>Remove theme</button>
+ <InteractiveQuestion questionId={ORDERS_QUESTION_ID} />
+ </MetabaseProvider>
+ );
+ }
+ cy.mount(<TestComponent />);
+
+ getSdkRoot().within(() => {
+ cy.findByRole("button", { name: "Set theme" }).click();
+ cy.findByText("Orders")
+ .invoke("css", "color")
+ .should("equal", "rgb(0, 0, 255)");
+ cy.findByRole("button", { name: "Remove theme" }).click();
+ cy.findByText("Orders")
+ .invoke("css", "color")
+ // --mb-color-text-primary
+ .should("equal", "rgb(76, 87, 115)");
+ });
+ });
});
describe("style leaking", () => {
diff --git a/frontend/src/metabase/embedding-sdk/theme/embedding-color-palette.ts b/frontend/src/metabase/embedding-sdk/theme/embedding-color-palette.ts
index fdc24da21da..326775ed5f3 100644
--- a/frontend/src/metabase/embedding-sdk/theme/embedding-color-palette.ts
+++ b/frontend/src/metabase/embedding-sdk/theme/embedding-color-palette.ts
@@ -110,4 +110,15 @@ export function setGlobalEmbeddingColors(
Object.entries(combinedThemeColors).forEach(([key, value]) => {
colors[key as ColorName] = value;
});
+
+ /**
+ * (EMB-696)
+ * Reset colors set previously that's now not passed in `sdkColors`.
+ * Otherwise, previously modified colors will persist, and won't be reset to default values.
+ */
+ Object.keys(colors).forEach((key) => {
+ if (!combinedThemeColors[key as ColorName]) {
+ delete colors[key as ColorName];
+ }
+ });
}