Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

58.8 KB
Raw Blame

CollectionBrowser

Name Description
CollectionBrowser A component that allows you to browse collections and their items.
CollectionBrowserProps -

CreateDashboardModal

Name Description
CreateDashboardModal Creates a dashboard
CreateDashboardModalProps -

CreateQuestion

Name Description
CreateQuestion -
CreateQuestionProps -

Dashboard

Name Description
EditableDashboard A dashboard component with the features available in the InteractiveDashboard component, as well as the ability to add and update questions, layout, and content within your dashboard.
InteractiveDashboard A dashboard component with drill downs, click behaviors, and the ability to view and click into questions.
StaticDashboard A lightweight dashboard component.
EditableDashboardProps -
InteractiveDashboardProps -
StaticDashboardProps -
NavigatedEntityParameterChangePayload Payload passed to onNavigatedEntityParametersChange callback. The root payload of the same entity type, plus entityType, entityId, navigationId and clickParameters.
NavigatedEntityParameters Parameter values for entities the user reaches through entity navigation, keyed by NavigationId.
NavigationId Opaque ID of one visit to an entity the user reached through entity navigation.
ParameterChangePayload Payload passed to onParametersChange callback
ParameterChangeSource Source of a parameter-change event: - initial-state - first applied snapshot, fired once per dashboard load. - manual-change - user edited parameters in UI. - auto-change - in the case of auto-updates, e.g. to pass normalized values back to parent.

InteractiveQuestion

Name Description
InteractiveQuestion A component that renders an interactive question.
DrillThroughQuestionProps Props for the drill-through question
InteractiveQuestionChartTypeDropdownProps -
InteractiveQuestionEditorButtonProps -
InteractiveQuestionEditorProps -
InteractiveQuestionProps -
InteractiveQuestionQuestionSettingsDropdownProps -
InteractiveQuestionQuestionVisualizationProps -
InteractiveQuestionRefreshButtonProps -
InteractiveQuestionResetButtonProps -
InteractiveQuestionSaveQuestionFormProps -
InteractiveQuestionTitleProps -
SdkQuestionProps -
InteractiveQuestionBackButtonProps -
InteractiveQuestionBreakoutDropdownProps -
InteractiveQuestionChartTypeSelectorProps -
InteractiveQuestionDownloadWidgetDropdownProps -
InteractiveQuestionDownloadWidgetProps -
InteractiveQuestionFilterDropdownProps -
InteractiveQuestionFilterProps -
InteractiveQuestionQuestionSettingsProps -
InteractiveQuestionSaveButtonProps -
InteractiveQuestionSummarizeDropdownProps -
SqlParameterChangePayload Payload passed to onSqlParametersChange callback
SqlParameterChangeSource Source of a sql-parameter-change event: - initial-state - first applied state, fired once per question load. - manual-change - user edited parameters in UI. - auto-change - in the case of auto-updates, e.g. to pass normalized values back to parent.

MetabaseProvider

Name Description
defineMetabaseAuthConfig Defines a Metabase auth config.
MetabaseProvider A component that provides the Metabase SDK context and theme.
MetabaseProviderProps -
MetabaseAuthConfig -
MetabaseAuthConfigWithApiKey -
MetabaseAuthConfigWithJwt -
MetabaseAuthConfigWithSaml -
MetabaseIsGuestAuthConfig -

MetabotQuestion

Name Description
MetabotQuestion A component that renders a metabot question.
MetabotQuestionProps Props for the MetabotQuestion component.

StaticQuestion

Name Description
StaticQuestion A component that renders a static question.
StaticQuestionProps -

Theming

Name Description
MetabaseEmbeddingThemeV2 Version 2 theme configuration for embedded Metabase components.
ChartColorV2 Chart color definition for V2 themes.
MetabaseColorKey All color keys available in Metabase themes.
MetabaseEmbeddingTheme Theme configuration for embedded Metabase components.

other

Name Description
DataAppLink Internal-only navigation link inside a data app.
DataAppRouter Wrap your data-app tree once. Inside, use <DataAppLink to="…"> for navigation and useDataAppLocation() to read the current path.
useAction -
useDataAppLocation The current data-app sub-path and a navigate function.
DataAppLinkProps -
DataAppRouterProps -
InteractiveQuestionComponents -
MetabaseColors -
MetabaseQuestion -
MetabaseTheme Theme configuration for embedded Metabase components.
StaticQuestionComponents -
ButtonProps -
ChartColor -
CollectionBrowserListColumns -
CustomDashboardCardMenuItem -
DashboardCardCustomMenuItem -
DashboardCardMenu -
DashboardCardMenuCustomElement -
DashCardMenuItem -
EmbeddingDataPicker -
EmbeddingEntityType -
EntityTypeFilterKeys -
FieldSchema Metadata for a generated table field.
IconName -
InitializationStatus -
LoginStatus -
MetabaseCard Ad-hoc card definition for SDK-rendered questions. Pass only query when Metabase should infer a display from the query result. Add visualization when the user or design asks for a specific chart type. Add visualizationSettings only for explicit setting-level presentation changes.
MetabaseClickAction -
MetabaseClickActionPluginsConfig -
MetabaseCollection The Collection entity
MetabaseCollectionItem The CollectionItem entity
MetabaseComponentTheme Theme options for customizing specific Metabase components and visualizations.
MetabaseDashboard The Dashboard entity
MetabaseDashboardPluginsConfig -
MetabaseDataPointObject -
MetabaseEmbeddingColorKeyV2 Color keys available for theming in modular embedding.
MetabaseFetchRequestTokenFn -
MetabaseFontFamily -
MetabaseGlobalPluginsConfig -
MetabasePluginsConfig -
MetabaseQueryObject Public structural type for ad-hoc SDK queries created by useMetabaseQueryObject.
MetabaseThemePreset -
MetabaseUser The User entity
MetabotAgentChartMessage -
MetabotAgentMessage -
MetabotAgentTextMessage -
MetabotUserTextMessage -
ParameterValues -
ProtectedColorKey Color keys that are protected and should not be exposed to embedding.
QueryData -
QueryQuestionResult -
RowValue A single value returned by Metabase query results or action responses.
SchemaColumn -
SchemaJavaScriptType -
SchemaRow -
SdkActionDefinition How a data app names an action: a defineAction definition of an implicit action on a table. The dev preview runs it without saving it, and a production build runs the action entityId names.
SdkActionId How the raw SDK names an action: the id it was given.
SdkActionInput -
SdkBrowserCollectionId SdkCollectionId plus "all", a virtual read-only top level showing everything the current user can access.
SdkCollectionId -
SdkDashboardEntityPublicProps -
SdkDashboardId -
SdkDashboardLoadEvent -
SdkEntityId -
SdkEntityToken -
SdkErrorComponent -
SdkErrorComponentProps -
SdkEventHandlersConfig -
SdkLegacyActionDefinition How a data app built against an older SDK names an action: the saved action action.id names, by its entity ID or numeric id.
SdkQuestionEntityPublicProps -
SdkQuestionId Represents the identifier for a question in the Metabase SDK.
SdkQuestionTitleProps -
SdkUserId -
SqlParameterValues -
UseDataAppLocationResult -
UserBackendJwtResponse -

useAction

| Name | Description | | :------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | | UseActionResult | - | | ActionExecuteError | Shape of the thrown error captured into the hook's error state on a non-2xx response. The hook types error as ActionExecuteError | null, so consumers read its fields directly — no cast needed: | | ActionKind | Flat public kind union. Maps onto the backend's namespaced row/* implicitKind and the query type value, but exposes a simpler four-value surface to callers: create / update / delete always refer to a single row, and sql covers custom SQL actions (the backend's query-type action). | | ActionResultForCreate | Response from a single-row create — the inserted row. | | ActionResultForDelete | Response from a single-row delete — the number of rows deleted. | | ActionResultForKind | Maps an ActionKind literal to the discriminated result shape. Omit TKind (undefined) to fall back to the AnyActionResult union. | | ActionResultForSql | Response from a custom SQL action — the affected row count. | | ActionResultForUpdate | Response from a single-row update — the number of rows updated. | | AnyActionResult | Union of every possible response body. Used as the result default when TKind is omitted, so authors who don't know the action's kind upfront still get TS-narrowable shapes (via "<key>" in result) instead of a permissive Record<string, unknown> that swallows mistyped reads. |

useApplicationName

Function Description
useApplicationName Returns application name. Returns null until the SDK is fully loaded and initialized.

useAvailableFonts

Function Description
useAvailableFonts Returns available fonts. Returns null until the SDK is fully loaded and initialized.

useCreateDashboardApi

Name Description
useCreateDashboardApi Creates a dashboard. Returns null until the SDK is fully loaded and initialized.
CreateDashboardValues -

useCurrentUser

Function Description
useCurrentUser Returns the current user. Returns null until the SDK is fully loaded and initialized.

useMetabaseAuthStatus

Function Description
useMetabaseAuthStatus Returns the authentication status of the current user in the Metabase embedding SDK. Returns null until the SDK is fully loaded and initialized.

useMetabot

Name Description
useMetabot Returns the Metabot conversation API.
MetabotChartProps -
MetabotErrorMessage -
MetabotIncompleteResponse -
MetabotMessage -
UseMetabotResult -