@metabase/embedding-sdk-react v0.1.3

NOTE: This SDK is actively being developed. We don't recommend using it in production yet!

Metabase Embedding SDK for React

The Metabase Embedding SDK for React offers a way to integrate Metabase into your application more seamlessly and with greater flexibility than using the current interactive embedding offering based on iframes.

Features currently supported:

• embedding questions - static
• embedding questions - w/drill-down
• plugins for custom actions

Features planned:

• embedding dashboards - static
• embedding dashboards - w/ drill-down
• styling/theming via CSS
• subscribing to events

Prerequisites

• You have an application using React 17 or higher
• You have a Pro or Enterprise subscription or free trial of Metabase
• You have a running Metabase instance using a compatible version of the enterprise binary. For now, we supply specific compatible versions as Jar files and Docker images. Note these are not considered stable.

Getting started

Start Metabase

Currently, the SDK only works with specific versions of Metabase. You have the following options:

1. Running on Docker

Start the Metabase container:

docker run -d -p 3000:3000 --name metabase metabase/metabase-dev:embedding-sdk-0.1.0

2. Running the Jar file

1. Download the Jar file from http://downloads.metabase.com/sdk/v0.1.0/metabase.jar
2. Create a new directory and move the Metabase JAR into it.
3. Change into your new Metabase directory and run the JAR.

java -jar metabase.jar

Configure Metabase

1. Go to Admin settings > Authentication > JWT
   1. Set JWT Identity Provider URI to your JWT endpoint
   2. Generate JWT signing key and take note of this value. You will need it later.
2. Go to Admin settings > Embedding
   1. Enable embedding if not already enabled
   2. Inside interactive embedding, set Authorized Origins to your application URL

Authenticate users from your back-end

Note: Metabase Embedding SDK for React only supports JWT authentication.

The SDK requires an endpoint in the backend that signs a user into Metabase and returns a token that the SDK will use to make authenticated calls to Metabase.

The SDK will call this endpoint if it doesn't have a token or to refresh the token when it's about to expire.

Example:

const express = require("express")

const jwt = require("jsonwebtoken")
const fetch = require("node-fetch")

async function metabaseAuthHandler(req, res) {
  const { user } = req.session

  if (!user) {
    return res.status(401).json({
      status: 'error',
      message: 'not authenticated',
    })
  }

  const token = jwt.sign(
    {
      email: user.email,
      first_name: user.firstName,
      last_name: user.lastName,
      groups: [user.group],
      exp: Math.round(Date.now() / 1000) + 60 * 10, // 10 minutes expiration
    },
    // This is the JWT signing secret in your Metabase JWT authentication setting
    METABASE_JWT_SHARED_SECRET
  )
  const ssoUrl = `${METABASE_INSTANCE_URL}/auth/sso?token=true&jwt=${token}`

  try {
    const response = await fetch(ssoUrl, { method: 'GET' })
    const token = await response.json()

    return res.status(200).json(token)
  } catch (error) {
    if (error instanceof Error) {
      res.status(401).json({
        status: 'error',
        message: 'authentication failed',
        error: error.message,
      })
    }
  }
}

const app = express()

// Middleware

// If your FE application is on a different domain from your BE, you need to enable CORS
// by setting Access-Control-Allow-Credentials to true and Access-Control-Allow-Origin
// to your FE application URL.
app.use(cors({
  credentials: true,
}))

app.use(
  session({
    secret: SESSION_SECRET,
    resave: false,
    saveUninitialized: true,
    cookie: { secure: false },
  }),
)
app.use(express.json())

// routes
app.get("/sso/metabase", metabaseAuthHandler)
app.listen(PORT, () => {
  console.log(`API running at http://localhost:${PORT}`)
})

Installation

You can install Metabase Embedding SDK for React via npm:

npm install @metabase/embedding-sdk-react --force

or using yarn:

yarn add @metabase/embedding-sdk-react

Using the SDK

Initializing the SDK

Once installed, you need to import MetabaseProvider and provide it with a config object.

import React from "react";
import { MetabaseProvider } from "@metabase/embedding-sdk-react";

// Configuration
const config = {
  metabaseInstanceUrl: "https://metabase.example.com", // Required: Your Metabase instance URL
  jwtProviderUri: "https://app.example.com/sso/metabase", // Required: An endpoint in your app that returns signs the user in and delivers a token
}

// Theme Options
const theme = {
  fontFamily: "Lato", // Optional: Specify a font to use from the set of fonts supported by Metabase
  colors: { brand: "#9b59b6" }
}

export default function App() {
  return (
    <MetabaseProvider config={config} theme={theme}>
      Hello World!
    </MetabaseProvider>
  );
}

Embedding a static question

After the SDK is configured, you can use embed your question using the StaticQuestion component.

You can optionally pass in height to change the height of the component.

import React from "react";
import { MetabaseProvider, StaticQuestion } from "@metabase/embedding-sdk-react";

const config = {...}

export default function App() {
  const questionId = 1; // This is the question ID you want to embed

  return (
    <MetabaseProvider config={config}>
        <StaticQuestion questionId={questionId} showVisualizationSelector={false} />
    </MetabaseProvider>
  );
}

Embedding an interactive question (drill-down)

import React from "react";
import { MetabaseProvider, InteractiveQuestion } from "@metabase/embedding-sdk-react";

const config = {...}

export default function App() {
  const questionId = 1; // This is the question ID you want to embed

  return (
    <MetabaseProvider config={config}>
      <InteractiveQuestion questionId={questionId}  />
    </MetabaseProvider>
  );
}
const questionId = 1; // This is the question ID you want to embed

Implementing custom actions

MetabaseProvider also supports pluginsConfig. You can use pluginsConfig to customize the SDK behavior. Currently we only allow configuring mapQuestionClickActions which lets you add custom actions or remove Metabase default actions in InteractiveQuestion component.

We'll support more plugins in next releases.

// You can provide a custom action with your own `onClick` logic.
const createCustomAction = clicked => ({
  buttonType: "horizontal",
  name: "client-custom-action",
  section: "custom",
  type: "custom",
  icon: "chevronright",
  title: "Hello from the click app!!!",
  onClick: ({ closePopover }) => {
    alert(`Clicked ${clicked.column?.name}: ${clicked.value}`);
    closePopover();
  },
});

// Or customize the appearance of the custom action to suit your need.
const createCustomActionWithView = clicked => ({
  name: "client-custom-action-2",
  section: "custom",
  type: "custom",
  view: ({ closePopover }) => (
    <button
      className="tw-text-base tw-text-yellow-900 tw-bg-slate-400 tw-rounded-lg"
      onClick={() => {
        alert(`Clicked ${clicked.column?.name}: ${clicked.value}`);
        closePopover();
      }}
    >
      Custom element
    </button>
  ),
});

const plugins = {
  /**
   * You will have access to default `clickActions` that Metabase render by default.
   * So you could decide if you want to add custom actions, remove certain actions, etc.
   */
  mapQuestionClickActions: (clickActions, clicked) => {
    return [
      ...clickActions,
      createCustomAction(clicked),
      createCustomActionWithView(clicked),
    ]
  }
}

const questionId = 1; // This is the question ID you want to embed

return (
  <MetabaseProvider config={config} pluginsConfig={plugins}>
    <InteractiveQuestion questionId={questionId}  />
  </MetabaseProvider>
);

Known limitations

The Metabase Embedding SDK only supports React on SPA Webpack applications. Applications built with Vite aren't currently supported. We aim to add support for other platforms in the near future.

Feedback

For issues and feedback, there are two options:

• Chat with the team directly on Slack: If you don't have access, please reach out to us at sdk-feedback@metabase.com and we'll get you setup.
• Email the team at sdk-feedback@metabase.com. This will reach the development team directly.

For security issues, please follow the instructions for responsible disclosure here.

Development

Building locally

First you need to build the Metabase Embedding SDK for React locally:

yarn build-release:cljs

And then run:

yarn build-embedding-sdk:watch

Using the local build

After that you need to add this built SDK package location to your package.json. In this example we assume that your application is located in the same directory as Metabase directory:

"dependencies": {
  "@metabase/embedding-sdk-react": "file:../metabase/resources/embedding-sdk"
}

And then you can install the package using npm or yarn:

npm install
# or
yarn

Releases

Embedding SDK package build happens with Github actions if embedding-sdk-build label has been set on the PR.

Published package will use a version from package.template.json + current date and commit short hash.