@metabase/embedding-sdk-react

Metabase embedded analytics SDK

This SDK is in public beta and actively being developed. You can expect some changes to the API, especially during the beta. The SDK currently only works with a Metabase 1.51 or higher.

With Metabase's Embedded analytics SDK, you can embed individual Metabase components with React (like standalone charts, dashboards, the query builder, and more). You can manage access and interactivity per component, and you have advanced customization for seamless styling.

Learn more.

Docs for the Embedded analytics SDK

For how to use the SDK with your app, check out our docs for the Embedded analytics SDK.

Quickstart

Just some commands to get you started. For more on how to set up the SDK with your app, see the SDK docs.

Installing Metabase

Start a free trial of Metabase Pro.

Or run it locally. Here's a docker one-liner:

docker run -d -p 3000:3000 --name metabase metabase/metabase-enterprise:latest

You can also download the JAR, and run it like so:

java --add-opens java.base/java.nio=ALL-UNNAMED -jar metabase.jar

By default, Metabase will run at http://localhost:3000.

If you get stuck, check out our installation docs.

Installing the SDK

You can install Metabase Embedded analytics SDK for React via npm:

npm install @metabase/embedding-sdk-react

or using yarn:

yarn add @metabase/embedding-sdk-react

For more on the SDK, check out the SDK docs.

Development docs

For developing the SDK, see the dev docs.