Function MetabaseProvider

Parameters

• props: MetabaseProviderProps

  • OptionalallowConsoleLog?: boolean

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

  • OptionalallowedCustomVisualizations?: `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.

  • OptionalclassName?: string

    A custom class name to be added to the root element.

    Deprecated

    This prop is not used anymore.

  • OptionalerrorComponent?: SdkErrorComponent

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

  • OptionaleventHandlers?: SdkEventHandlersConfig

    See Global event handlers.

  • OptionalloaderComponent?: 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.

  • Optionallocale?: string

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

  • OptionalpluginsConfig?: MetabaseGlobalPluginsConfig

    See Plugins.

  • Optionaltheme?: MetabaseEmbeddingTheme

    See Appearance.

  • OptionaluseLegacyMonolithicBundle?: 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).