Skip to content

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

Clean ui theming violations (#71629)

Fraser113f90840898
diff --git a/.storybook/preview.tsx b/.storybook/preview.tsx
index 5b149aa5074..5f2899fc3c3 100644
--- a/.storybook/preview.tsx
+++ b/.storybook/preview.tsx
@@ -14,7 +14,7 @@ require("metabase/lib/dayjs");
import "@mantine/core/styles.css";
import "@mantine/dates/styles.css";
-import { EmotionCacheProvider } from "metabase/styled-components/components/EmotionCacheProvider";
+import { EmotionCacheProvider } from "metabase/ui/components/theme/EmotionCacheProvider";
import { getMetabaseCssVariables } from "metabase/styled-components/theme/css-variables";
import { Global, css, useTheme } from "@emotion/react";
@@ -85,15 +85,31 @@ const globalStyles = css`
${baseStyle}
`;
+const getResolvedColorScheme = (
+ displayTheme: string | undefined,
+): "light" | "dark" => {
+ switch (displayTheme) {
+ case "night":
+ case "dark":
+ return "dark";
+ default:
+ return "light";
+ }
+};
+
const decorators = [
(Story, { args = {}, globals }) => {
if (!document.body.classList.contains("mb-wrapper")) {
document.body.classList.add("mb-wrapper");
}
+ const resolvedColorScheme = getResolvedColorScheme(
+ args.theme ?? globals.theme,
+ );
+
return (
<EmotionCacheProvider>
- <ThemeProvider displayTheme={args.theme ?? globals.theme}>
+ <ThemeProvider resolvedColorScheme={resolvedColorScheme}>
<Global styles={globalStyles} />
<CssVariables />
<Story />
diff --git a/frontend/lint/module-boundaries.mjs b/frontend/lint/module-boundaries.mjs
index 75308d93da2..a6c0cd04a28 100644
--- a/frontend/lint/module-boundaries.mjs
+++ b/frontend/lint/module-boundaries.mjs
@@ -22,6 +22,8 @@ const appMiscFilePaths = [
"frontend/src/metabase/routes.jsx",
"frontend/src/metabase/routes-embed.tsx",
"frontend/src/metabase/routes-public.tsx",
+ "frontend/src/metabase/AppThemeProvider.tsx",
+ "frontend/src/metabase/AppColorSchemeProvider.tsx",
];
const elements = [
@@ -41,6 +43,11 @@ const elements = [
pattern: "enterprise/frontend/src/metabase-enterprise/**",
mode: "full", // matches the entire path, because enterprise is in a different directory
},
+ {
+ type: "lib/env",
+ pattern: "frontend/src/metabase/env.ts",
+ mode: "full",
+ },
...appMiscFilePaths.map((path) => ({
type: "app/misc",
pattern: path,
diff --git a/frontend/src/embedding-sdk-bundle/components/public/ComponentProvider/ComponentProvider.tsx b/frontend/src/embedding-sdk-bundle/components/public/ComponentProvider/ComponentProvider.tsx
index 83feae6ae46..881ec09822a 100644
--- a/frontend/src/embedding-sdk-bundle/components/public/ComponentProvider/ComponentProvider.tsx
+++ b/frontend/src/embedding-sdk-bundle/components/public/ComponentProvider/ComponentProvider.tsx
@@ -24,7 +24,7 @@ import { isEmbeddingThemeV1 } from "metabase/embedding-sdk/theme";
import { MetabaseReduxProvider, useSelector } from "metabase/lib/redux";
import { LocaleProvider } from "metabase/public/LocaleProvider";
import { setOptions } from "metabase/redux/embed";
-import { EmotionCacheProvider } from "metabase/styled-components/components/EmotionCacheProvider";
+import { EmotionCacheProvider } from "metabase/ui/components/theme/EmotionCacheProvider";
import { initializePlugins } from "sdk-ee-plugins";
import { SCOPED_CSS_RESET } from "../../private/PublicComponentStylesWrapper";
diff --git a/frontend/src/embedding-sdk-bundle/types/theme.ts b/frontend/src/embedding-sdk-bundle/types/theme.ts
index c1b115d2ed2..d4c35ca392a 100644
--- a/frontend/src/embedding-sdk-bundle/types/theme.ts
+++ b/frontend/src/embedding-sdk-bundle/types/theme.ts
@@ -1,8 +1,8 @@
export type {
MetabaseEmbeddingColorKeyV2,
- MetabaseEmbeddingTheme,
MetabaseEmbeddingThemeV2,
-} from "metabase/embedding-sdk/theme";
+} from "metabase/ui/colors/types";
+export type { MetabaseEmbeddingTheme } from "metabase/embedding-sdk/theme";
export type {
ChartColorV2,
diff --git a/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/ColorSchemeProvider.tsx b/frontend/src/metabase/AppColorSchemeProvider.tsx
similarity index 65%
rename from frontend/src/metabase/ui/components/theme/ColorSchemeProvider/ColorSchemeProvider.tsx
rename to frontend/src/metabase/AppColorSchemeProvider.tsx
index c0fd3f9e4ce..82681465065 100644
--- a/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/ColorSchemeProvider.tsx
+++ b/frontend/src/metabase/AppColorSchemeProvider.tsx
@@ -1,56 +1,37 @@
import {
type ReactNode,
- createContext,
useCallback,
- useContext,
useEffect,
useMemo,
useState,
} from "react";
import { useMedia } from "react-use";
-import { noop } from "underscore";
import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
-import type {
- ColorScheme,
- ResolvedColorScheme,
-} from "metabase/lib/color-scheme";
+import type { ColorScheme } from "metabase/lib/color-scheme";
import { getIsEmbeddingIframe } from "metabase/selectors/embed";
+import {
+ ColorSchemeContext,
+ type ColorSchemeContextType,
+ colorSchemeContextDefaultValue,
+} from "metabase/ui/components/theme/ColorSchemeProvider";
-interface ColorSchemeContextType {
- colorScheme: ColorScheme;
- resolvedColorScheme: ResolvedColorScheme;
- systemColorScheme: ResolvedColorScheme;
- setColorScheme: (scheme: ColorScheme) => void;
- toggleColorScheme: () => void;
-}
-
-const defaultValue: ColorSchemeContextType = {
- colorScheme: "light",
- resolvedColorScheme: "light",
- systemColorScheme: "light",
- setColorScheme: noop,
- toggleColorScheme: noop,
-};
-
-const ColorSchemeContext = createContext<ColorSchemeContextType>(defaultValue);
-
-interface ColorSchemeProviderProps {
+interface AppColorSchemeProviderProps {
children: ReactNode;
defaultColorScheme?: ColorScheme;
- forceColorScheme?: ResolvedColorScheme | null;
+ forceColorScheme?: "light" | "dark" | null;
onUpdateColorScheme?: (scheme: ColorScheme) => void;
}
-const getNextScheme = (scheme: ResolvedColorScheme) =>
+const getNextScheme = (scheme: "light" | "dark") =>
scheme === "dark" ? "light" : "dark";
-export function ColorSchemeProvider({
+export function AppColorSchemeProvider({
children,
defaultColorScheme = "auto",
forceColorScheme,
onUpdateColorScheme,
-}: ColorSchemeProviderProps) {
+}: AppColorSchemeProviderProps) {
const systemColorScheme = useMedia("(prefers-color-scheme: dark)")
? "dark"
: "light";
@@ -67,8 +48,6 @@ export function ColorSchemeProvider({
//
// If such new preferences specify a different color scheme, we then
// react to those changes.
- //
- // See: `ThemeProvider.tsx:181`
setColorScheme(defaultColorScheme);
}, [defaultColorScheme]);
@@ -91,7 +70,7 @@ export function ColorSchemeProvider({
);
const value: ColorSchemeContextType = isEmbeddingSdk()
- ? defaultValue
+ ? colorSchemeContextDefaultValue
: {
colorScheme,
resolvedColorScheme,
@@ -111,11 +90,3 @@ export function ColorSchemeProvider({
</ColorSchemeContext.Provider>
);
}
-
-export function useColorScheme(): ColorSchemeContextType {
- const context = useContext(ColorSchemeContext);
- if (!context) {
- throw new Error("useColorScheme must be used within a ColorSchemeProvider");
- }
- return context;
-}
diff --git a/frontend/src/metabase/AppThemeProvider.tsx b/frontend/src/metabase/AppThemeProvider.tsx
new file mode 100644
index 00000000000..70f8cfc3067
--- /dev/null
+++ b/frontend/src/metabase/AppThemeProvider.tsx
@@ -0,0 +1,143 @@
+import { type ReactNode, useCallback, useEffect, useState } from "react";
+
+import {
+ isPublicEmbedding,
+ isStaticEmbedding,
+} from "metabase/embedding/config";
+import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
+import { PUT } from "metabase/lib/api";
+import { parseHashOptions } from "metabase/lib/browser";
+import type {
+ ColorScheme,
+ ResolvedColorScheme,
+} from "metabase/lib/color-scheme";
+import {
+ getUserColorScheme,
+ isValidColorScheme,
+ setUserColorSchemeAfterUpdate,
+} from "metabase/lib/color-scheme";
+import MetabaseSettings from "metabase/lib/settings";
+import type { DisplayTheme } from "metabase/public/lib/types";
+import type { MantineThemeOverride } from "metabase/ui";
+import { mutateColors } from "metabase/ui/colors/colors";
+import { ThemeProvider } from "metabase/ui/components/theme/ThemeProvider";
+import type { ColorSettings } from "metabase-types/api";
+
+import { AppColorSchemeProvider } from "./AppColorSchemeProvider";
+
+interface AppThemeProviderProps {
+ children: ReactNode;
+
+ /**
+ * Extend Metabase's theme overrides.
+ */
+ theme?: MantineThemeOverride;
+
+ displayTheme?: DisplayTheme | string;
+
+ initialColorScheme?: ColorScheme | undefined;
+}
+
+const getColorSchemeFromDisplayTheme = (
+ displayTheme: DisplayTheme | string | boolean | string[] | undefined,
+): ResolvedColorScheme | null => {
+ switch (displayTheme) {
+ case "light":
+ case "transparent":
+ case undefined:
+ return "light";
+ case "night":
+ case "dark":
+ return "dark";
+ }
+ return null;
+};
+
+const getColorSchemeOverride = ({ hash }: Location) => {
+ return getColorSchemeFromDisplayTheme(parseHashOptions(hash).theme);
+};
+
+const useColorSchemeFromHash = ({
+ enabled = true,
+}: {
+ enabled?: boolean;
+}): ResolvedColorScheme | null => {
+ const [hashScheme, setHashScheme] = useState<ResolvedColorScheme | null>(() =>
+ getColorSchemeOverride(location),
+ );
+ useEffect(() => {
+ if (!enabled) {
+ return;
+ }
+ const onHashChange = () => setHashScheme(getColorSchemeOverride(location));
+ window.addEventListener("hashchange", onHashChange);
+ return () => window.removeEventListener("hashchange", onHashChange);
+ }, [enabled]);
+ return enabled ? hashScheme : null;
+};
+
+export const AppThemeProvider = (props: AppThemeProviderProps) => {
+ const schemeFromHash = useColorSchemeFromHash({
+ enabled: isStaticEmbedding() || isPublicEmbedding(),
+ });
+ const forceColorScheme = props.displayTheme
+ ? getColorSchemeFromDisplayTheme(props.displayTheme)
+ : schemeFromHash;
+
+ const [colorSchemeFromSettings, setColorSchemeFromSettings] =
+ useState<ColorScheme>(() => getUserColorScheme() ?? "auto");
+
+ // FIXME: Not only does this use a deprecated API, it also adds a complementary
+ // method to the already deprecated method to remove the listener. This is just
+ // done provisionally for CI testing purposes.
+ useEffect(() => {
+ const updateSetting = (value: ColorScheme) => {
+ if (value && isValidColorScheme(value)) {
+ setColorSchemeFromSettings(value);
+ }
+ };
+
+ MetabaseSettings.on("color-scheme", updateSetting);
+
+ return () => MetabaseSettings.off("color-scheme", updateSetting);
+ }, [setColorSchemeFromSettings]);
+
+ const handleUpdateColorScheme = useCallback(async (value: ColorScheme) => {
+ await PUT("/api/setting/:key")({
+ key: "color-scheme",
+ value: value,
+ });
+
+ setUserColorSchemeAfterUpdate(value);
+ }, []);
+
+ // Whitelabel colors management
+ const [whitelabelColors, setWhitelabelColors] = useState<
+ ColorSettings | undefined
+ >(() => MetabaseSettings.applicationColors());
+
+ const handleUpdateWhitelabelColors = useCallback(
+ (nextColors: ColorSettings) => {
+ mutateColors(nextColors);
+ setWhitelabelColors(nextColors);
+ },
+ [],
+ );
+
+ return (
+ <AppColorSchemeProvider
+ defaultColorScheme={colorSchemeFromSettings ?? getUserColorScheme()}
+ forceColorScheme={forceColorScheme}
+ onUpdateColorScheme={handleUpdateColorScheme}
+ >
+ <ThemeProvider
+ theme={props.theme}
+ whitelabelColors={whitelabelColors}
+ onUpdateWhitelabelColors={handleUpdateWhitelabelColors}
+ cssVariablesSelector={isEmbeddingSdk() ? ".mb-wrapper" : undefined}
+ >
+ {props.children}
+ </ThemeProvider>
+ </AppColorSchemeProvider>
+ );
+};
diff --git a/frontend/src/metabase/app.js b/frontend/src/metabase/app.js
index b04f7f759a7..3ba7380e7cd 100644
--- a/frontend/src/metabase/app.js
+++ b/frontend/src/metabase/app.js
@@ -34,6 +34,7 @@ import { useRouterHistory } from "react-router";
import { syncHistoryWithStore } from "react-router-redux";
import { initializePlugins } from "ee-plugins";
+import { AppThemeProvider } from "metabase/AppThemeProvider";
import { ModifiedBackend } from "metabase/common/components/dnd/ModifiedBackend";
import registerDashboardVisualizations from "metabase/dashboard/visualizations/register";
import { createTracker } from "metabase/lib/analytics";
@@ -46,9 +47,8 @@ import MetabaseSettings from "metabase/lib/settings";
import { MetabotProvider } from "metabase/metabot/context";
import { PLUGIN_APP_INIT_FUNCTIONS } from "metabase/plugins";
import { refreshSiteSettings } from "metabase/redux/settings";
-import { EmotionCacheProvider } from "metabase/styled-components/components/EmotionCacheProvider";
import { GlobalStyles } from "metabase/styled-components/containers/GlobalStyles";
-import { ThemeProvider } from "metabase/ui";
+import { EmotionCacheProvider } from "metabase/ui/components/theme/EmotionCacheProvider";
import registerVisualizations from "metabase/visualizations/register";
import { HistoryProvider } from "./history";
@@ -91,14 +91,14 @@ function _init(reducers, getRoutes, callback) {
<MetabaseReduxProvider store={store}>
<EmotionCacheProvider>
<DragDropContextProvider backend={ModifiedBackend} context={{ window }}>
- <ThemeProvider>
+ <AppThemeProvider>
<GlobalStyles />
<MetabotProvider>
<HistoryProvider history={syncedHistory}>
<RouterProvider>{routes}</RouterProvider>
</HistoryProvider>
</MetabotProvider>
- </ThemeProvider>
+ </AppThemeProvider>
</DragDropContextProvider>
</EmotionCacheProvider>
</MetabaseReduxProvider>,
diff --git a/frontend/src/metabase/data-grid/hooks/use-measure-column-widths.tsx b/frontend/src/metabase/data-grid/hooks/use-measure-column-widths.tsx
index a48f1ace620..65a5eeb141a 100644
--- a/frontend/src/metabase/data-grid/hooks/use-measure-column-widths.tsx
+++ b/frontend/src/metabase/data-grid/hooks/use-measure-column-widths.tsx
@@ -8,12 +8,10 @@ import type { Root } from "react-dom/client";
import type { ColumnOptions, DataGridTheme } from "metabase/data-grid/types";
import { pickRowsToMeasure } from "metabase/data-grid/utils/column-sizing";
-import {
- MeasurementProviders,
- createMeasurementContainer,
-} from "metabase/data-grid/utils/measure-utils";
+import { createMeasurementContainer } from "metabase/lib/measure-container";
import { renderRoot, unmountRoot } from "metabase/lib/react-compat";
import { isNotNull } from "metabase/lib/types";
+import { MeasurementProviders } from "metabase/ui/components/theme/MeasurementProviders";
import { DataGridThemeProvider } from "./use-table-theme";
diff --git a/frontend/src/metabase/embedding-sdk/theme/MetabaseThemeV2.ts b/frontend/src/metabase/embedding-sdk/theme/MetabaseThemeV2.ts
deleted file mode 100644
index 5ea41bd67e7..00000000000
--- a/frontend/src/metabase/embedding-sdk/theme/MetabaseThemeV2.ts
+++ /dev/null
@@ -1,36 +0,0 @@
-import type {
- ChartColorV2,
- MetabaseColorKey,
- ProtectedColorKey,
-} from "metabase/ui/colors";
-
-/**
- * Color keys available for theming in modular embedding.
- *
- * Excludes protected colors such as admin colors that should not be exposed.
- *
- * @inline
- */
-export type MetabaseEmbeddingColorKeyV2 = Exclude<
- MetabaseColorKey,
- ProtectedColorKey
->;
-
-/**
- * Version 2 theme configuration for embedded Metabase components.
- *
- * @category Theming
- */
-export interface MetabaseEmbeddingThemeV2 {
- /** Theme version must be 2 for version 2 themes. */
- version: 2;
-
- /** Color overrides. */
- colors?: Partial<Record<MetabaseEmbeddingColorKeyV2, string>>;
-
- /**
- * Chart colors overrides.
- * Each color can be a string or an object with base/tint/shade.
- */
- chartColors?: ChartColorV2[];
-}
diff --git a/frontend/src/metabase/embedding-sdk/theme/index.ts b/frontend/src/metabase/embedding-sdk/theme/index.ts
index 6279295aefa..43cabd1a836 100644
--- a/frontend/src/metabase/embedding-sdk/theme/index.ts
+++ b/frontend/src/metabase/embedding-sdk/theme/index.ts
@@ -1,6 +1,5 @@
export * from "./default-component-theme";
export * from "./MetabaseTheme";
-export * from "./MetabaseThemeV2";
export * from "./theme-version";
export * from "./define-metabase-theme";
diff --git a/frontend/src/metabase/embedding-sdk/theme/theme-version.ts b/frontend/src/metabase/embedding-sdk/theme/theme-version.ts
index 8bbaf5c7e71..4e6f7f39891 100644
--- a/frontend/src/metabase/embedding-sdk/theme/theme-version.ts
+++ b/frontend/src/metabase/embedding-sdk/theme/theme-version.ts
@@ -1,5 +1,6 @@
+import type { MetabaseEmbeddingThemeV2 } from "metabase/ui/colors/types";
+
import type { MetabaseTheme } from "./MetabaseTheme";
-import type { MetabaseEmbeddingThemeV2 } from "./MetabaseThemeV2";
/**
* Theme configuration for embedded Metabase components.
diff --git a/frontend/src/metabase/data-grid/utils/measure-utils.tsx b/frontend/src/metabase/lib/measure-container.ts
similarity index 65%
rename from frontend/src/metabase/data-grid/utils/measure-utils.tsx
rename to frontend/src/metabase/lib/measure-container.ts
index e00eeacb442..194f5ca048d 100644
--- a/frontend/src/metabase/data-grid/utils/measure-utils.tsx
+++ b/frontend/src/metabase/lib/measure-container.ts
@@ -1,16 +1,13 @@
-import type { ReactNode } from "react";
import type { Root } from "react-dom/client";
import { unmountRoot } from "metabase/lib/react-compat";
-import { EmotionCacheProvider } from "metabase/styled-components/components/EmotionCacheProvider";
-import { ThemeProvider } from "metabase/ui";
-
-import { DEFAULT_FONT_SIZE } from "../constants";
interface MeasurementContainerOptions {
fontSize?: string;
}
+const DEFAULT_FONT_SIZE = "12.5px";
+
export function createMeasurementContainer(
options: MeasurementContainerOptions = {},
): HTMLDivElement {
@@ -39,15 +36,3 @@ export function removeMeasurementContainer(
document.body.removeChild(container);
}, 0);
}
-
-interface MeasurementProvidersProps {
- children: ReactNode;
-}
-
-export function MeasurementProviders({ children }: MeasurementProvidersProps) {
- return (
- <EmotionCacheProvider>
- <ThemeProvider>{children}</ThemeProvider>
- </EmotionCacheProvider>
- );
-}
diff --git a/frontend/src/metabase/styled-components/components/EmotionCacheProvider/index.ts b/frontend/src/metabase/styled-components/components/EmotionCacheProvider/index.ts
deleted file mode 100644
index a59cafb3495..00000000000
--- a/frontend/src/metabase/styled-components/components/EmotionCacheProvider/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export * from "./EmotionCacheProvider";
diff --git a/frontend/src/metabase/ui/colors/derive-theme.ts b/frontend/src/metabase/ui/colors/derive-theme.ts
index 7c69697b9e4..d6e62949cf0 100644
--- a/frontend/src/metabase/ui/colors/derive-theme.ts
+++ b/frontend/src/metabase/ui/colors/derive-theme.ts
@@ -1,13 +1,16 @@
import _ from "underscore";
-import type { MetabaseEmbeddingThemeV2 } from "metabase/embedding-sdk/theme";
import type { ResolvedColorScheme } from "metabase/lib/color-scheme";
import type { ColorSettings } from "metabase-types/api";
import { deriveAllAccentColors, mapChartColorsToAccents } from "./accents";
import { PROTECTED_COLORS } from "./constants/protected-colors";
import { getThemeFromColorScheme } from "./theme-from-color-scheme";
-import type { MetabaseColorKey, MetabaseDerivedThemeV2 } from "./types";
+import type {
+ MetabaseColorKey,
+ MetabaseDerivedThemeV2,
+ MetabaseEmbeddingThemeV2,
+} from "./types";
/**
* Derives the _full_ metabase themes given a theme configuration.
diff --git a/frontend/src/metabase/ui/colors/types/index.ts b/frontend/src/metabase/ui/colors/types/index.ts
index c20ead9ddfb..ca5280852f9 100644
--- a/frontend/src/metabase/ui/colors/types/index.ts
+++ b/frontend/src/metabase/ui/colors/types/index.ts
@@ -4,11 +4,43 @@ export type {
MetabaseDerivedThemeV2,
} from "./theme";
-import type { MetabaseColorKey } from "./color-keys";
+import type { MetabaseColorKey, ProtectedColorKey } from "./color-keys";
+import type { ChartColorV2 } from "./theme";
export type ColorPalette = Partial<Record<MetabaseColorKey, string>>;
export type ColorName = MetabaseColorKey;
export type ColorGetter = (colorName: string) => string;
+/**
+ * Color keys available for theming in modular embedding.
+ *
+ * Excludes protected colors such as admin colors that should not be exposed.
+ *
+ * @inline
+ */
+export type MetabaseEmbeddingColorKeyV2 = Exclude<
+ MetabaseColorKey,
+ ProtectedColorKey
+>;
+
+/**
+ * Version 2 theme configuration for embedded Metabase components.
+ *
+ * @category Theming
+ */
+export interface MetabaseEmbeddingThemeV2 {
+ /** Theme version must be 2 for version 2 themes. */
+ version: 2;
+
+ /** Color overrides. */
+ colors?: Partial<Record<MetabaseEmbeddingColorKeyV2, string>>;
+
+ /**
+ * Chart colors overrides.
+ * Each color can be a string or an object with base/tint/shade.
+ */
+ chartColors?: ChartColorV2[];
+}
+
export type * from "./color-keys";
export type * from "./accent-color-options";
diff --git a/frontend/src/metabase/ui/components/data-display/TreeTable/hooks/useColumnSizing.tsx b/frontend/src/metabase/ui/components/data-display/TreeTable/hooks/useColumnSizing.tsx
index 67e49cd0f86..88a23abeca6 100644
--- a/frontend/src/metabase/ui/components/data-display/TreeTable/hooks/useColumnSizing.tsx
+++ b/frontend/src/metabase/ui/components/data-display/TreeTable/hooks/useColumnSizing.tsx
@@ -3,12 +3,12 @@ import { useCallback, useLayoutEffect, useMemo, useRef, useState } from "react";
import type { Root } from "react-dom/client";
import {
- MeasurementProviders,
createMeasurementContainer,
removeMeasurementContainer,
-} from "metabase/data-grid/utils/measure-utils";
+} from "metabase/lib/measure-container";
import { renderRoot } from "metabase/lib/react-compat";
import { SortableHeaderPill } from "metabase/ui";
+import { MeasurementProviders } from "metabase/ui/components/theme/MeasurementProviders";
import {
CELL_HORIZONTAL_PADDING,
diff --git a/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/ColorSchemeContext.tsx b/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/ColorSchemeContext.tsx
new file mode 100644
index 00000000000..7034a4a6f14
--- /dev/null
+++ b/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/ColorSchemeContext.tsx
@@ -0,0 +1,35 @@
+import { createContext, useContext } from "react";
+import { noop } from "underscore";
+
+import type {
+ ColorScheme,
+ ResolvedColorScheme,
+} from "metabase/lib/color-scheme";
+
+export interface ColorSchemeContextType {
+ colorScheme: ColorScheme;
+ resolvedColorScheme: ResolvedColorScheme;
+ systemColorScheme: ResolvedColorScheme;
+ setColorScheme: (scheme: ColorScheme) => void;
+ toggleColorScheme: () => void;
+}
+
+export const colorSchemeContextDefaultValue: ColorSchemeContextType = {
+ colorScheme: "light",
+ resolvedColorScheme: "light",
+ systemColorScheme: "light",
+ setColorScheme: noop,
+ toggleColorScheme: noop,
+};
+
+export const ColorSchemeContext = createContext<ColorSchemeContextType>(
+ colorSchemeContextDefaultValue,
+);
+
+export function useColorScheme(): ColorSchemeContextType {
+ const context = useContext(ColorSchemeContext);
+ if (!context) {
+ throw new Error("useColorScheme must be used within a ColorSchemeProvider");
+ }
+ return context;
+}
diff --git a/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/index.ts b/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/index.ts
index a9ac8057c12..3ee15db271e 100644
--- a/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/index.ts
+++ b/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/index.ts
@@ -1 +1,6 @@
-export { ColorSchemeProvider, useColorScheme } from "./ColorSchemeProvider";
+export {
+ ColorSchemeContext,
+ useColorScheme,
+ colorSchemeContextDefaultValue,
+ type ColorSchemeContextType,
+} from "./ColorSchemeContext";
diff --git a/frontend/src/metabase/styled-components/components/EmotionCacheProvider/EmotionCacheProvider.tsx b/frontend/src/metabase/ui/components/theme/EmotionCacheProvider/EmotionCacheProvider.tsx
similarity index 100%
rename from frontend/src/metabase/styled-components/components/EmotionCacheProvider/EmotionCacheProvider.tsx
rename to frontend/src/metabase/ui/components/theme/EmotionCacheProvider/EmotionCacheProvider.tsx
diff --git a/frontend/src/metabase/ui/components/theme/EmotionCacheProvider/index.ts b/frontend/src/metabase/ui/components/theme/EmotionCacheProvider/index.ts
new file mode 100644
index 00000000000..c4589813813
--- /dev/null
+++ b/frontend/src/metabase/ui/components/theme/EmotionCacheProvider/index.ts
@@ -0,0 +1 @@
+export { EmotionCacheProvider } from "./EmotionCacheProvider";
diff --git a/frontend/src/metabase/ui/components/theme/MeasurementProviders.tsx b/frontend/src/metabase/ui/components/theme/MeasurementProviders.tsx
new file mode 100644
index 00000000000..e535858db03
--- /dev/null
+++ b/frontend/src/metabase/ui/components/theme/MeasurementProviders.tsx
@@ -0,0 +1,16 @@
+import type { ReactNode } from "react";
+
+import { EmotionCacheProvider } from "./EmotionCacheProvider";
+import { ThemeProvider } from "./ThemeProvider";
+
+interface MeasurementProvidersProps {
+ children: ReactNode;
+}
+
+export function MeasurementProviders({ children }: MeasurementProvidersProps) {
+ return (
+ <EmotionCacheProvider>
+ <ThemeProvider>{children}</ThemeProvider>
+ </EmotionCacheProvider>
+ );
+}
diff --git a/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx b/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx
index 280be40415f..e3d833191ad 100644
--- a/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx
+++ b/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx
@@ -3,43 +3,19 @@ import { ThemeProvider as _CompatibilityEmotionThemeProvider } from "@emotion/re
import type { MantineTheme, MantineThemeOverride } from "@mantine/core";
import { MantineProvider } from "@mantine/core";
import { merge } from "icepick";
-import {
- type ReactNode,
- useCallback,
- useContext,
- useEffect,
- useMemo,
- useState,
-} from "react";
+import { type ReactNode, useContext, useMemo } from "react";
-import {
- isPublicEmbedding,
- isStaticEmbedding,
-} from "metabase/embedding/config";
-import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
-import { PUT } from "metabase/lib/api";
-import { parseHashOptions } from "metabase/lib/browser";
-import type {
- ColorScheme,
- ResolvedColorScheme,
-} from "metabase/lib/color-scheme";
-import {
- getUserColorScheme,
- isValidColorScheme,
- setUserColorSchemeAfterUpdate,
-} from "metabase/lib/color-scheme";
-import MetabaseSettings from "metabase/lib/settings";
-import type { DisplayTheme } from "metabase/public/lib/types";
-import { mutateColors } from "metabase/ui/colors/colors";
+import type { ResolvedColorScheme } from "metabase/lib/color-scheme";
import type { ColorName } from "metabase/ui/colors/types";
+import type { ColorSettings } from "metabase-types/api";
import { getThemeOverrides } from "../../../theme";
-import { ColorSchemeProvider, useColorScheme } from "../ColorSchemeProvider";
+import { useColorScheme } from "../ColorSchemeProvider";
import { DatesProvider } from "../DatesProvider";
import { ThemeProviderContext } from "./context";
-interface ThemeProviderProps {
+export interface ThemeProviderProps {
children: ReactNode;
/**
@@ -49,47 +25,71 @@ interface ThemeProviderProps {
*/
theme?: MantineThemeOverride;
- displayTheme?: DisplayTheme | string;
+ /**
+ * Resolved color scheme to use. If not provided, reads from ColorSchemeContext.
+ */
+ resolvedColorScheme?: ResolvedColorScheme;
- initialColorScheme?: ColorScheme | undefined;
-}
+ /**
+ * Whitelabel color settings. If not provided, defaults to undefined (no whitelabel).
+ */
+ whitelabelColors?: ColorSettings | null;
-const ThemeProviderInner = (props: ThemeProviderProps) => {
- const { resolvedColorScheme } = useColorScheme();
+ /**
+ * Callback invoked when whitelabel colors should be updated.
+ */
+ onUpdateWhitelabelColors?: (colors: ColorSettings) => void;
- // We cannot use `useSetting` here due to circular dependencies,
- // and `useSelector` throws as the redux provider is not always wrapped
- const [whitelabelColors, setWhitelabelColors] = useState(
- MetabaseSettings.applicationColors(),
- );
+ /**
+ * CSS selector for Mantine CSS variables injection.
+ */
+ cssVariablesSelector?: string;
+}
+
+export const ThemeProvider = ({
+ children,
+ theme: themeOverride,
+ resolvedColorScheme: resolvedColorSchemeProp,
+ whitelabelColors,
+ onUpdateWhitelabelColors,
+ cssVariablesSelector,
+}: ThemeProviderProps) => {
+ const colorSchemeContext = useColorScheme();
+ const resolvedColorScheme =
+ resolvedColorSchemeProp ?? colorSchemeContext.resolvedColorScheme;
- // Merge default theme overrides with user-provided theme overrides
const theme = useMemo(() => {
- const theme = merge(
+ const baseTheme = merge(
getThemeOverrides(resolvedColorScheme, whitelabelColors),
- props.theme,
+ themeOverride,
) as MantineTheme;
return {
- ...theme,
+ ...baseTheme,
other: {
- ...theme.other,
- updateColorSettings: (nextWhitelabeledColors) => {
- mutateColors(nextWhitelabeledColors);
- setWhitelabelColors(nextWhitelabeledColors);
- },
+ ...baseTheme.other,
+ ...(onUpdateWhitelabelColors && {
+ updateColorSettings: onUpdateWhitelabelColors,
+ }),
},
fn: {
themeColor: (color: ColorName): string => {
- const { primaryShade, primaryColor } = theme;
+ const { primaryShade, primaryColor } = baseTheme;
- return color in theme.colors
- ? theme.colors[color][primaryShade as number]
- : theme.colors[primaryColor as ColorName][primaryShade as number];
+ return color in baseTheme.colors
+ ? baseTheme.colors[color][primaryShade as number]
+ : baseTheme.colors[primaryColor as ColorName][
+ primaryShade as number
+ ];
},
},
} as MantineTheme;
- }, [props.theme, resolvedColorScheme, whitelabelColors]);
+ }, [
+ themeOverride,
+ resolvedColorScheme,
+ whitelabelColors,
+ onUpdateWhitelabelColors,
+ ]);
const { withCssVariables, withGlobalClasses } =
useContext(ThemeProviderContext);
@@ -100,98 +100,13 @@ const ThemeProviderInner = (props: ThemeProviderProps) => {
forceColorScheme={resolvedColorScheme}
getStyleNonce={() => window.MetabaseNonce ?? "metabase"}
classNamesPrefix="mb-mantine"
- cssVariablesSelector={isEmbeddingSdk() ? ".mb-wrapper" : undefined}
- // This slows down unit tests like crazy
+ cssVariablesSelector={cssVariablesSelector}
withCssVariables={withCssVariables}
withGlobalClasses={withGlobalClasses}
>
<_CompatibilityEmotionThemeProvider theme={theme}>
- <DatesProvider>{props.children}</DatesProvider>
+ <DatesProvider>{children}</DatesProvider>
</_CompatibilityEmotionThemeProvider>
</MantineProvider>
);
};
-
-const getColorSchemeFromDisplayTheme = (
- displayTheme: DisplayTheme | string | boolean | string[] | undefined,
-): ResolvedColorScheme | null => {
- switch (displayTheme) {
- case "light":
- case "transparent":
- case undefined:
- return "light";
- case "night":
- case "dark":
- return "dark";
- }
- return null;
-};
-
-const getColorSchemeOverride = ({ hash }: Location) => {
- return getColorSchemeFromDisplayTheme(parseHashOptions(hash).theme);
-};
-
-const useColorSchemeFromHash = ({
- enabled = true,
-}: {
- enabled?: boolean;
-}): ResolvedColorScheme | null => {
- const [hashScheme, setHashScheme] = useState<ResolvedColorScheme | null>(() =>
- getColorSchemeOverride(location),
- );
- useEffect(() => {
- if (!enabled) {
- return;
- }
- const onHashChange = () => setHashScheme(getColorSchemeOverride(location));
- window.addEventListener("hashchange", onHashChange);
- return () => window.removeEventListener("hashchange", onHashChange);
- }, [enabled]);
- return enabled ? hashScheme : null;
-};
-
-export const ThemeProvider = (props: ThemeProviderProps) => {
- const schemeFromHash = useColorSchemeFromHash({
- enabled: isStaticEmbedding() || isPublicEmbedding(),
- });
- const forceColorScheme = props.displayTheme
- ? getColorSchemeFromDisplayTheme(props.displayTheme)
- : schemeFromHash;
-
- const [colorSchemeFromSettings, setColorSchemeFromSettings] =
- useState<ColorScheme>(() => getUserColorScheme() ?? "auto");
-
- // FIXME: Not only does this use a deprecated API, it also adds a complementary
- // method to the already deprecated method to remove the listener. This is just
- // done provisionally for CI testing purposes.
- useEffect(() => {
- const updateSetting = (value: ColorScheme) => {
- if (value && isValidColorScheme(value)) {
- setColorSchemeFromSettings(value);
- }
- };
-
- MetabaseSettings.on("color-scheme", updateSetting);
-
- return () => MetabaseSettings.off("color-scheme", updateSetting);
- }, [setColorSchemeFromSettings]);
-
- const handleUpdateColorScheme = useCallback(async (value: ColorScheme) => {
- await PUT("/api/setting/:key")({
- key: "color-scheme",
- value: value,
- });
-
- setUserColorSchemeAfterUpdate(value);
- }, []);
-
- return (
- <ColorSchemeProvider
- defaultColorScheme={colorSchemeFromSettings ?? getUserColorScheme()}
- forceColorScheme={forceColorScheme}
- onUpdateColorScheme={handleUpdateColorScheme}
- >
- <ThemeProviderInner {...props} />
- </ColorSchemeProvider>
- );
-};
diff --git a/frontend/test/__support__/ui.tsx b/frontend/test/__support__/ui.tsx
index 8d3572b59e1..eda7fd6e61c 100644
--- a/frontend/test/__support__/ui.tsx
+++ b/frontend/test/__support__/ui.tsx
@@ -11,24 +11,28 @@ import {
import type { History } from "history";
import { createMemoryHistory } from "history";
import { KBarProvider } from "kbar";
-import { useMemo } from "react";
+import { useCallback, useMemo, useState } from "react";
import { DragDropContextProvider } from "react-dnd";
import HTML5Backend from "react-dnd-html5-backend";
import { Route, useRouterHistory } from "react-router";
import { routerMiddleware, routerReducer } from "react-router-redux";
import _ from "underscore";
+import { AppColorSchemeProvider } from "metabase/AppColorSchemeProvider";
import { Api } from "metabase/api";
import { UndoListing } from "metabase/common/components/UndoListing";
import { baseStyle } from "metabase/css/core/base.styled";
import { HistoryProvider } from "metabase/history";
+import { PUT } from "metabase/lib/api";
import { MetabaseReduxProvider } from "metabase/lib/redux";
+import MetabaseSettings from "metabase/lib/settings";
import { makeMainReducers } from "metabase/reducers-main";
import { publicReducers } from "metabase/reducers-public";
import { RouterProvider } from "metabase/router";
import { getMetabaseCssVariables } from "metabase/styled-components/theme/css-variables";
import type { MantineThemeOverride } from "metabase/ui";
import { ThemeProvider, useMantineTheme } from "metabase/ui";
+import { mutateColors } from "metabase/ui/colors/colors";
import { ThemeProviderContext } from "metabase/ui/components/theme/ThemeProvider/context";
import type { State } from "metabase-types/store";
import { createMockState } from "metabase-types/store/mocks";
@@ -258,21 +262,41 @@ export function TestWrapper({
displayTheme?: "light" | "dark";
withCssVariables?: boolean;
}): JSX.Element {
+ const handleUpdateColorScheme = useCallback(async (value: any) => {
+ await PUT("/api/setting/:key")({ key: "color-scheme", value });
+ }, []);
+
+ const [whitelabelColors, setWhitelabelColors] = useState(() =>
+ MetabaseSettings.applicationColors(),
+ );
+
+ const handleUpdateWhitelabelColors = useCallback((nextColors: any) => {
+ mutateColors(nextColors);
+ setWhitelabelColors(nextColors);
+ }, []);
+
return (
<MetabaseReduxProvider store={store}>
<MaybeDNDProvider hasDND={withDND}>
- <ThemeProviderContext.Provider value={{ withCssVariables }}>
- <ThemeProvider theme={theme} displayTheme={displayTheme}>
- <GlobalStylesForTest />
-
- <MaybeKBar hasKBar={withKBar}>
- <MaybeRouter hasRouter={withRouter} history={history}>
- {children}
- </MaybeRouter>
- </MaybeKBar>
- {withUndos && <UndoListing />}
- </ThemeProvider>
- </ThemeProviderContext.Provider>
+ <AppColorSchemeProvider onUpdateColorScheme={handleUpdateColorScheme}>
+ <ThemeProviderContext.Provider value={{ withCssVariables }}>
+ <ThemeProvider
+ theme={theme}
+ resolvedColorScheme={displayTheme ?? "light"}
+ whitelabelColors={whitelabelColors}
+ onUpdateWhitelabelColors={handleUpdateWhitelabelColors}
+ >
+ <GlobalStylesForTest />
+
+ <MaybeKBar hasKBar={withKBar}>
+ <MaybeRouter hasRouter={withRouter} history={history}>
+ {children}
+ </MaybeRouter>
+ </MaybeKBar>
+ {withUndos && <UndoListing />}
+ </ThemeProvider>
+ </ThemeProviderContext.Provider>
+ </AppColorSchemeProvider>
</MaybeDNDProvider>
</MetabaseReduxProvider>
);