The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
title: Modular embedding components summary: "A map of the modular embedding docs: dashboards, charts, the query builder, a collection browser, and AI chat."
Modular embedding components
Modular embedding gives you a handful of components you can drop into your app, with either web components or the React SDK. This page maps out the docs for each one.
While you can use attributes and props to show or hide parts of an embedded component, they're not a substitute for permissions. Even if you hide stuff, people could still grab their token from the frontend and use it to query the Metabase API.
Dashboard
Embed a dashboard view-only, interactive, or editable, and let people create dashboards from your app.
- Embed a dashboard
- Dashboard component reference, for
<metabase-dashboard>attributes and SDK props
Question
Embed a single chart, or the query builder and SQL editor so people can build questions from scratch.
- Embed a chart
- Embed the query builder
- Question component reference, for
<metabase-question>attributes and SDK props
Browser
{% include plans-blockquote.html feature="Browser component" convert_pro_link_to_embedding=true%}
Embed a browsable collection, so people can find and open dashboards and questions themselves.
- Embed a collection browser
- Browser component reference, for
<metabase-browser>attributes and SDK props
AI chat
{% include plans-blockquote.html feature="AI chat component" convert_pro_link_to_embedding=true%}
Embed an AI chat, so people can ask questions of their data in natural language.
- Embed an AI chat, for the
<metabase-metabot>attributes, theMetabotQuestionprops, and theuseMetabothook
Things you can only do with the React SDK
Web components cover the components above. A few features are React-only, because they take React components or hooks that an HTML attribute can't carry. For those, use the Modular embedding SDK.
- Plugins, to customize component menus and click actions
- Actions, to run Metabase actions from your app with the
useActionhook - Custom question layouts, to lay out a question yourself with namespaced
InteractiveQuestioncomponents - Customize loading, error, and empty states, to swap in your own loading and error components, and your own no-results image
Further reading
- Appearance
- Configure your embeds
- Config reference, for
defineMetabaseConfig()settings andMetabaseProviderprops - Embedding parameters
- Parameters reference
- Custom visualizations in embeds
- Translating embeds
- Authentication
- Modular embedding SDK