Embedded analytics SDK API
    Preparing search index...

    Interface MetabaseProviderProps

    interface MetabaseProviderProps {
        allowConsoleLog?: boolean;
        authConfig: MetabaseAuthConfig;
        children: ReactNode;
        className?: string;
        errorComponent?: SdkErrorComponent;
        eventHandlers?: SdkEventHandlersConfig;
        loaderComponent?: () => Element;
        locale?: string;
        pluginsConfig?: MetabasePluginsConfig;
        theme?: MetabaseTheme;
    }

    Hierarchy

    Index

    Properties

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

    Properties

    allowConsoleLog?: boolean

    Whether to allow logging to the DevTools console. Defaults to true.

    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.

    errorComponent?: SdkErrorComponent

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

    eventHandlers?: SdkEventHandlersConfig

    See Global event handlers.

    loaderComponent?: () => Element

    A custom loader component to display while the SDK is loading.

    locale?: string

    Defines the display language. Accepts an ISO language code such as en or de. Defaults to the instance locale.

    pluginsConfig?: MetabasePluginsConfig

    See Plugins.

    theme?: MetabaseTheme

    See Appearance.

    Settings

    On This Page

    Properties