Skip to content

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

Closes EMB-1055 static embedding without a theme defaults to dark mode or system settings (#66320)

Sébastien68fb66830285
diff --git a/e2e/support/helpers/e2e-embedding-helpers.js b/e2e/support/helpers/e2e-embedding-helpers.js
index 731f8d49eb5..912c28b4bb7 100644
--- a/e2e/support/helpers/e2e-embedding-helpers.js
+++ b/e2e/support/helpers/e2e-embedding-helpers.js
@@ -85,7 +85,7 @@ export function getEmbeddedPageUrl(
payload,
{
setFilters = {},
- additionalHashOptions: { hideFilters = [], locale, font } = {},
+ additionalHashOptions: { hideFilters = [], locale, font, theme } = {},
pageStyle = {},
onBeforeLoad,
qs,
@@ -110,6 +110,7 @@ export function getEmbeddedPageUrl(
...pageStyle,
...(locale && { locale }),
...(font && { font }),
+ ...(theme && { theme }),
},
hiddenFilters,
);
diff --git a/e2e/test/scenarios/embedding/embedding-dashboard.cy.spec.js b/e2e/test/scenarios/embedding/embedding-dashboard.cy.spec.js
index 53fb87eb1ac..03c72fb1333 100644
--- a/e2e/test/scenarios/embedding/embedding-dashboard.cy.spec.js
+++ b/e2e/test/scenarios/embedding/embedding-dashboard.cy.spec.js
@@ -1229,6 +1229,73 @@ describe("scenarios > embedding > dashboard appearance", () => {
);
});
+ it("should apply theme hash parameter to static dashboard embed (metabase#66253)", () => {
+ const visit = (theme) => {
+ cy.clearLocalStorage();
+
+ H.visitEmbeddedPage(
+ {
+ resource: { dashboard: ORDERS_DASHBOARD_ID },
+ params: {},
+ },
+ {
+ additionalHashOptions: {
+ theme,
+ },
+ onBeforeLoad: (win) => {
+ // a bit gross but other stub techniques don't reliably work in Cypress
+ cy.stub(win, "matchMedia").callsFake((query) => {
+ return {
+ matches: query === "(prefers-color-scheme: dark)",
+ media: query,
+ addEventListener: cy.stub(),
+ removeEventListener: cy.stub(),
+ addListener: cy.stub(), // deprecated but sometimes needed
+ removeListener: cy.stub(),
+ dispatchEvent: cy.stub(),
+ };
+ });
+ },
+ },
+ );
+ };
+
+ cy.request("PUT", `/api/dashboard/${ORDERS_DASHBOARD_ID}`, {
+ enable_embedding: true,
+ });
+ cy.signOut();
+
+ cy.log("Test default light theme behavior");
+ visit();
+
+ // Test core functionality works with default theme
+ cy.get("[data-testid=embed-frame]").should("be.visible");
+ cy.get('html[data-mantine-color-scheme="light"]').should("exist");
+ cy.get('html[data-metabase-theme="light"]').should("exist");
+
+ cy.log("Test explicit light theme via hash parameter");
+ visit("light");
+
+ // Test functionality still works with theme parameter
+ cy.get("[data-testid=embed-frame]").should("be.visible");
+ cy.get('html[data-mantine-color-scheme="light"]').should("exist");
+ cy.get('html[data-metabase-theme="light"]').should("exist");
+
+ // Verify theme parameter is in URL hash
+ cy.location("hash").should("include", "theme=light");
+
+ cy.log("Test explicit dark theme via hash parameter");
+ visit("dark");
+
+ // Test functionality still works with theme parameter
+ cy.get("[data-testid=embed-frame]").should("be.visible");
+ cy.get('html[data-mantine-color-scheme="dark"]').should("exist");
+ cy.get('html[data-metabase-theme="dark"]').should("exist");
+
+ // Verify theme parameter is in URL hash
+ cy.location("hash").should("include", "theme=dark");
+ });
+
it("should use transparent pivot table cells in static embedding's dark mode (metabase#61741)", () => {
const testQuery = {
type: "query",
diff --git a/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx b/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx
index c398e092a62..6333a9f7b57 100644
--- a/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx
+++ b/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx
@@ -124,6 +124,7 @@ const getColorSchemeFromDisplayTheme = (
switch (displayTheme) {
case "light":
case "transparent":
+ case undefined:
return "light";
case "night":
case "dark":