Skip to content

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

docs - note about z-index (#72892)

Jeff Bruemmer29c59aa9887c
diff --git a/docs/embedding/appearance.md b/docs/embedding/appearance.md
index a2874eede29..17e1ddc9b18 100644
--- a/docs/embedding/appearance.md
+++ b/docs/embedding/appearance.md
@@ -265,13 +265,45 @@ For advanced theme configuration options, you can configure the `theme` object i
// Popover are used in components such as click actions in interactive questions.
"popover": {
- // z-index of the popover. Useful for embedding components in a modal. defaults to 4.
- "zIndex": 4
+ // z-index of the popover. Defaults to 200.
+ "zIndex": 200
}
}
}
```
+## Can't see a modal? Bump the z-index
+
+If your app renders its own modal, drawer, or backdrop at a high z-index, SDK-internal overlays (like a save dialog) may be hidden behind your overlay.
+
+The SDK defaults popovers to `zIndex: 200`, which may be lower than your app's overlay settings. All you need to do in this case is raise the SDK popover z-index above your overlay via `defineMetabaseTheme`:
+
+```tsx
+import {
+ MetabaseProvider,
+ defineMetabaseTheme,
+} from "@metabase/embedding-sdk-react";
+
+const theme = defineMetabaseTheme({
+ components: {
+ //... Other theme settings
+ popover: {
+ // Set above your overlay's z-index.
+ // For example, if your modal is at 1000, use 1001.
+ zIndex: 1001,
+ },
+ },
+});
+
+export function App() {
+ return (
+ <MetabaseProvider authConfig={authConfig} theme={theme}>
+ {/* your app */}
+ </MetabaseProvider>
+ );
+}
+```
+
## Limitations
- CSS variables aren't yet supported. If you'd like Metabase to support CSS variables, please upvote this [feature request](https://github.com/metabase/metabase/issues/59237).