These are the docs for the Metabase master branch. Some features documented here may not yet be available in the latest release. Check out the docs for the latest version, Metabase v0.51.
Embedded analytics SDK - plugins
⚠️ This feature is in beta. Feel free to play around with it, but be aware that things might change (and may not work as expected).
Embedded analytics SDK is only available on Pro and Enterprise plans (both self-hosted and on Metabase Cloud). You can, however, play around with the SDK on your local machine without a license by using API keys to authenticate your embeds.
The Metabase Embedding SDK supports plugins to customize the behavior of components. These plugins can be used in a global context or on a per-component basis.
Global plugins
To use a plugin globally, add the plugin to the MetabaseProvider’s pluginsConfig prop:
<MetabaseProvider
config={config}
theme={theme}
pluginsConfig={{
mapQuestionClickActions: [...] // Add your custom actions here
}}
>
{children}
</MetabaseProvider>
Component plugins
To use a plugin on a per-component basis, pass the plugin as a prop to the component:
<InteractiveQuestion
questionId={1}
plugins={{
mapQuestionClickActions: [...],
}}
/>
Further reading
Read docs for other versions of Metabase.