Skip to content

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

refactor(sdk): Export SdkThemeProvider from the SDK bundle (#78247)

Timofey Kachalov7519d07ec535
diff --git a/enterprise/frontend/src/embedding-sdk-package/components/private/SdkThemeProvider/SdkThemeProvider.tsx b/enterprise/frontend/src/embedding-sdk-package/components/private/SdkThemeProvider/SdkThemeProvider.tsx
new file mode 100644
index 00000000000..c31d9f21fb2
--- /dev/null
+++ b/enterprise/frontend/src/embedding-sdk-package/components/private/SdkThemeProvider/SdkThemeProvider.tsx
@@ -0,0 +1,28 @@
+import type { PropsWithChildren } from "react";
+
+import { getWindow } from "embedding-sdk-shared/lib/get-window";
+import type { MetabaseEmbeddingTheme } from "metabase/embedding-sdk/theme";
+
+/**
+ * The bundle's theme provider, reached through the bundle global rather than
+ * imported: the package and the bundle are separate builds, so a static import
+ * would inline a second copy along with its React context.
+ *
+ * Renders children untouched until the bundle has loaded, so a consumer never
+ * waits on the theme to see its own markup.
+ */
+export const SdkThemeProvider = ({
+ theme,
+ children,
+}: PropsWithChildren<{ theme?: MetabaseEmbeddingTheme }>) => {
+ const BundleSdkThemeProvider =
+ getWindow()?.METABASE_EMBEDDING_SDK_BUNDLE?.SdkThemeProvider;
+
+ if (!BundleSdkThemeProvider) {
+ return <>{children}</>;
+ }
+
+ return (
+ <BundleSdkThemeProvider theme={theme}>{children}</BundleSdkThemeProvider>
+ );
+};
diff --git a/enterprise/frontend/src/embedding-sdk-package/data-app-dev/components/DataAppDevProvider/DataAppDevProvider.tsx b/enterprise/frontend/src/embedding-sdk-package/data-app-dev/components/DataAppDevProvider/DataAppDevProvider.tsx
index c5257a857c9..2a371240446 100644
--- a/enterprise/frontend/src/embedding-sdk-package/data-app-dev/components/DataAppDevProvider/DataAppDevProvider.tsx
+++ b/enterprise/frontend/src/embedding-sdk-package/data-app-dev/components/DataAppDevProvider/DataAppDevProvider.tsx
@@ -1,6 +1,7 @@
import { once } from "underscore";
import type { MetabaseProviderProps } from "embedding-sdk-bundle/types/metabase-provider";
+import { SdkThemeProvider } from "embedding-sdk-package/components/private/SdkThemeProvider/SdkThemeProvider";
import { MetabaseProvider } from "embedding-sdk-package/components/public/MetabaseProvider/MetabaseProvider";
import { ensureMetabaseProviderPropsStore } from "embedding-sdk-shared/lib/ensure-metabase-provider-props-store";
@@ -14,14 +15,6 @@ export type DataAppDevProviderProps = MetabaseProviderProps & {
appSlug: string;
};
-/**
- * Provider for the data-app local dev preview (`npm run dev`). Wraps
- * `MetabaseProvider` and reports the page's traffic as the data app, so query
- * executions are attributed to the app (as "data-app-preview") instead of the
- * React SDK.
- *
- * Intended only for the local Vite dev server.
- */
export const DataAppDevProvider = ({
appSlug,
children,
@@ -29,5 +22,9 @@ export const DataAppDevProvider = ({
}: DataAppDevProviderProps) => {
registerDataAppDevContext(appSlug);
- return <MetabaseProvider {...props}>{children}</MetabaseProvider>;
+ return (
+ <MetabaseProvider {...props}>
+ <SdkThemeProvider theme={props.theme}>{children}</SdkThemeProvider>
+ </MetabaseProvider>
+ );
};
diff --git a/frontend/src/embedding-sdk-bundle/sdk-bundle-exports.ts b/frontend/src/embedding-sdk-bundle/sdk-bundle-exports.ts
index ae31edc6eb0..37d29911b85 100644
--- a/frontend/src/embedding-sdk-bundle/sdk-bundle-exports.ts
+++ b/frontend/src/embedding-sdk-bundle/sdk-bundle-exports.ts
@@ -3,6 +3,7 @@
import type { MetabaseEmbeddingSdkBundleExports } from "./types/sdk-bundle";
import { MetabotSubscriber } from "./components/private/MetabotSubscriber/MetabotSubscriber";
+import { SdkThemeProvider } from "./components/private/SdkThemeProvider";
import { CollectionBrowser } from "./components/public/CollectionBrowser";
import { CreateDashboardModal } from "./components/public/CreateDashboardModal";
import { CreateQuestion } from "./components/public/CreateQuestion";
@@ -67,6 +68,7 @@ export const sdkBundleExports: MetabaseEmbeddingSdkBundleExports = {
useLogVersionInfo,
validateFunctionSchema,
MetabotSubscriber,
+ SdkThemeProvider,
queryDataset,
queryQuestion,
dataAppRouting,
diff --git a/frontend/src/embedding-sdk-bundle/types/sdk-bundle.ts b/frontend/src/embedding-sdk-bundle/types/sdk-bundle.ts
index a68b68a844b..a0243c96b80 100644
--- a/frontend/src/embedding-sdk-bundle/types/sdk-bundle.ts
+++ b/frontend/src/embedding-sdk-bundle/types/sdk-bundle.ts
@@ -1,6 +1,7 @@
import type { JSXElementConstructor } from "react";
import type { MetabotSubscriber } from "embedding-sdk-bundle/components/private/MetabotSubscriber/MetabotSubscriber";
+import type { SdkThemeProvider } from "embedding-sdk-bundle/components/private/SdkThemeProvider";
import type { CollectionBrowser } from "embedding-sdk-bundle/components/public/CollectionBrowser";
import type { ComponentProvider } from "embedding-sdk-bundle/components/public/ComponentProvider";
import type { CreateDashboardModal } from "embedding-sdk-bundle/components/public/CreateDashboardModal";
@@ -127,4 +128,5 @@ type SchemaValidationUtils = {
type InternalComponentExports = {
MetabotSubscriber: typeof MetabotSubscriber;
+ SdkThemeProvider: typeof SdkThemeProvider;
};