Embedded analytics SDK - questions

There are different ways you can embed questions:

• Static question. Embeds a chart. Clicking on the chart doesn’t do anything.
• Interactive question. Clicking on the chart gives you the drill-through menu.
• Query builder. Embeds the graphical query builder without a pre-defined query.

Embedding a static question

You can embed a static question using the StaticQuestion component.

The component has a default height, which can be customized by using the height prop. To inherit the height from the parent container, you can pass 100% to the height prop.

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

const authConfig = {...}

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

    return (
        <MetabaseProvider authConfig={authConfig}>
            <StaticQuestion questionId={questionId} withChartTypeSelector={false}/>
        </MetabaseProvider>
    );
}

Embedding an interactive question

You can embed an interactive question using the InteractiveQuestion component.

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

const authConfig = {...}

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

    return (
        <MetabaseProvider authConfig={authConfig}>
            <InteractiveQuestion questionId={questionId}/>
        </MetabaseProvider>
    );
}

Question props

Passing SQL parameters to questions

You can pass parameter values to questions defined with SQL via the initialSqlParameters prop, in the format of {parameter_name: parameter_value}. Learn more about SQL parameters.

<StaticQuestion questionId={questionId} initialSqlParameters={{ product_id: 50 }} />

Customizing interactive questions

By default, the Embedded analytics SDK provides a default layout for interactive questions that allows you to view your questions, apply filters and aggregations, and access functionality within the query builder.

Here’s an example of using the InteractiveQuestion component with its default layout:

<InteractiveQuestion questionId={95} />

To customize the layout, use namespaced components within the InteractiveQuestion component. For example:

<InteractiveQuestion questionId={95}>
  <div
    style={{
      display: "flex",
      flexDirection: "column",
      alignItems: "center",
      justifyContent: "center",
    }}
  >
    <div style={{ display: "grid", placeItems: "center" }}>
      <InteractiveQuestion.Title />
      <InteractiveQuestion.ResetButton />
    </div>
    <div
      style={{
        display: "flex",
        alignItems: "center",
        justifyContent: "flex-start",
        overflow: "hidden",
      }}
    >
      <div style={{ width: "100%" }}>
        <InteractiveQuestion.QuestionVisualization />
      </div>
      <div style={{ display: "flex", flex: 1, overflow: "scroll" }}>
        <InteractiveQuestion.Summarize />
      </div>
    </div>
    <div style={{ display: "flex", flexDirection: "column" }}>
      <InteractiveQuestion.Filter />
    </div>
  </div>
</InteractiveQuestion>

Interactive question components

These components are available via the InteractiveQuestion namespace (e.g., <InteractiveQuestion.Filter />).

* signifies a required prop

InteractiveQuestion.BackButton

A navigation button that returns to the previous view. Only renders when onNavigateBack prop from InteractiveQuestion is available.

Uses Mantine ActionIcon props under the hood, as well as: | Prop | Type | Description | |——|——|————-| | className | string | Custom CSS class name for styling the component | | style | React.CSSProperties | Inline styles to apply to the component |

InteractiveQuestion.Filter

A set of interactive filter badges that allow adding, editing, and removing filters. Displays current filters as badges with an “Add another filter” option.

InteractiveQuestion.FilterDropdown

A dropdown button for the Filter component.

InteractiveQuestion.ResetButton

Button to reset question modifications. Only appears when there are unsaved changes to the question.

Uses Mantine Button props under the hood, as well as: | Prop | Type | Description | |——|——|————-| | className | string | Custom CSS class name for styling the component | | style | React.CSSProperties | Inline styles to apply to the component |

InteractiveQuestion.Title

Displays a title based on the question’s state. Shows:

• The question’s display name if it’s saved
• An auto-generated description for ad-hoc questions (non-native queries)
• “New question” as fallback or for new/native queries

InteractiveQuestion.SaveButton

Button for saving question changes. Only enabled when there are unsaved modifications to the question.

Note: Currently, in custom layouts, the SaveButton must have an onClick handler or the button will not do anything when clicked.

Uses Mantine Button props under the hood, as well as: | Prop | Type | Description | |——|——|————-| | className | string | Custom CSS class name for styling the component | | style | React.CSSProperties | Inline styles to apply to the component |

InteractiveQuestion.Breakout

A set of badges for managing data groupings (breakouts).

No props. Uses question context for breakout functionality.

InteractiveQuestion.BreakoutDropdown

Dropdown button for the Breakout component.

Uses Popover props except onClose, children, and opened under the hood, as well as: | Prop | Type | Description | |——|——|————-| | className | string | Custom CSS class name for styling the component | | style | React.CSSProperties | Inline styles to apply to the component |

InteractiveQuestion.Summarize

Interface for adding and managing data summaries (like counts, sums, averages). Displays as a set of badges.

No props. Uses question context for summarization functionality.

InteractiveQuestion.SummarizeDropdown

Dropdown button for the Summarize component.

Uses Popover props except onClose, children, and opened under the hood, as well as: | Prop | Type | Description | |——|——|————-| | className | string | Custom CSS class name for styling the component | | style | React.CSSProperties | Inline styles to apply to the component |

InteractiveQuestion.Editor

Advanced query editor that provides full access to question configuration. Includes filtering, aggregation, custom expressions, and joins.

Replaces deprecated InteractiveQuestion.Notebook

InteractiveQuestion.EditorButton

Toggle button for showing/hiding the Editor interface.

Replaces deprecated InteractiveQuestion.NotebookButton

Note: Currently, in custom layouts, the EditorButton must have an onClick handler or the button will not do anything when clicked.

Uses Mantine ActionIcon props under the hood, as well as: | Prop | Type | Description | |——|——|————-| | isOpen | boolean | Whether the editor is currently open | | className | string | Custom CSS class name for styling the component | | style | React.CSSProperties | Inline styles to apply to the component |

InteractiveQuestion.QuestionVisualization

The main visualization component that renders the question results as a chart, table, or other visualization type.

InteractiveQuestion.QuestionSettings

Settings panel for configuring visualization options like axes, colors, and formatting.

No props. Uses question context for settings.

InteractiveQuestion.QuestionSettingsDropdown

Dropdown button that contains the QuestionSettings component.

Uses Popover props except onClose and opened under the hood, as well as: | Prop | Type | Description | |——|——|————-| | height | React.CSSProperties[“height”] | Height for the dropdown menu | | className | string | Custom CSS class name for styling the component | | style | React.CSSProperties | Inline styles to apply to the component |

InteractiveQuestion.ChartTypeSelector

Detailed chart type selection interface with recommended visualization options.

Uses Mantine Stack props under the hood, as well as: | Prop | Type | Description | |——|——|————-| | className | string | Custom CSS class name for styling the component | | style | React.CSSProperties | Inline styles to apply to the component |

InteractiveQuestion.ChartTypeDropdown

Dropdown for selecting the visualization type (bar chart, line chart, table, etc.). Automatically updates to show recommended visualization types for the current data.

Uses Mantine Menu props under the hood, as well as: | Prop | Type | Description | |——|——|————-| | className | string | Custom CSS class name for styling the component | | style | React.CSSProperties | Inline styles to apply to the component |

InteractiveQuestion.SaveQuestionForm

Form for saving a question, including title and description. When saved:

• For new questions: Calls onCreate prop from InteractiveQuestion
• For existing questions: Calls onSave prop from InteractiveQuestion
• Both callbacks receive the updated question object
• Form can be cancelled via the onCancel prop

Interactive question plugins

You can use plugins to add custom functionality to your questions.

mapQuestionClickActions

This plugin allows you to add custom actions to the click-through menu of an interactive question. You can add and customize the appearance and behavior of the custom actions.

// 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 renders 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 authConfig={authConfig} pluginsConfig={plugins}>
    <InteractiveQuestion questionId={questionId} />
  </MetabaseProvider>
);

Embedding an editable interactive question

You can edit an existing question using the query builder by passing the isSaveEnabled prop on the InteractiveQuestion component.

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

const authConfig = {...}

export default function App() {
    return (
        <MetabaseProvider authConfig={authConfig}>
            <InteractiveQuestion questionId={1} isSaveEnabled />
        </MetabaseProvider>
    );
}

Embedding the query builder

With the CreateQuestion component, you can embed the query builder without a pre-defined question.

This component is built on top of the InteractiveQuestion component with namespaced components. It shares the same props as InteractiveQuestion, except it lacks the questionId prop and the ability to pass custom children.

To customize the question editor’s layout, use the InteractiveQuestion component directly with a custom children prop.

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

const authConfig = {...}

export default function App() {
    return (
        <MetabaseProvider authConfig={authConfig}>
            <CreateQuestion />
        </MetabaseProvider>
    );
}