Embedded analytics SDK API
    Preparing search index...

    Interface MetabaseProviderProps

    interface MetabaseProviderProps {
        allowConsoleLog?: boolean;
        allowedCustomVisualizations?: `custom:${string}`[];
        authConfig: MetabaseAuthConfig;
        children: ReactNode;
        className?: string;
        errorComponent?: SdkErrorComponent;
        eventHandlers?: SdkEventHandlersConfig;
        loaderComponent?: ComponentType<{ label?: string }>;
        locale?: string;
        pluginsConfig?: MetabaseGlobalPluginsConfig;
        theme?: MetabaseEmbeddingTheme;
        useLegacyMonolithicBundle?: boolean;
    }
    Index

    Properties

    allowConsoleLog? allowedCustomVisualizations? authConfig children className? errorComponent? eventHandlers? loaderComponent? locale? pluginsConfig? theme? useLegacyMonolithicBundle?

    Properties

    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. When set, the SDK loads custom-viz bundles into an about:blank sandbox (no hosted-sandbox endpoint required).

    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.

    This prop is not used anymore.

    errorComponent?: SdkErrorComponent

    A custom error component to display when the SDK encounters an error.

    eventHandlers?: SdkEventHandlersConfig

    See Global event handlers.

    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).

    Settings

    On This Page

    Properties