Skip to content

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

7.7 KB
Raw Blame

Expand

Properties

Property Type Description
allowConsoleLog? boolean Whether to allow logging to the DevTools console. Defaults to true.
allowedCustomVisualizations? `custom:${string}`[] Opt-in support for EE custom visualization plugins inside the SDK. Pass an allowlist of custom:-prefixed plugin identifiers (manifest name), e.g. ["custom:Thumbs", "custom:Calendar"]. Only listed plugins are loaded. Omit or pass [] to disable. Requires the custom-viz premium feature.
authConfig MetabaseAuthConfig Defines how to authenticate with Metabase.
children ReactNode The children of the MetabaseProvider component.
className? string A custom class name to be added to the root element. Deprecated This prop is not used anymore.
customVisualizationsSandboxUrl? string URL of an empty HTML page that custom visualizations run in. Use it when your page's Content Security Policy does not allow 'unsafe-eval'. The page must be served from the same origin as your app, with its own Content-Security-Policy: default-src 'none'; script-src 'unsafe-eval'.
errorComponent? SdkErrorComponent A custom error component to display when the SDK encounters an error.
eventHandlers? SdkEventHandlersConfig See Handle embed events.
loaderComponent? ComponentType<{ label?: string; }> A custom loader component to display while the SDK is loading. The component receives an optional label prop that can be used to display a loading message.
locale? string Defines the display language. Accepts an ISO language code such as en or de. Defaults to the instance locale.
pluginsConfig? MetabaseGlobalPluginsConfig See Plugins.
theme? MetabaseEmbeddingTheme See Appearance.
useLegacyMonolithicBundle? boolean Whether to load the full SDK bundle directly as a single file (legacy behavior), instead of the optimized bootstrap that loads chunks in parallel and starts authentication early. Defaults to false (uses the optimized bootstrap loader).