The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Fix SDK snippet links on embedding reference pages (GRO-1116) (#85335)
Timur Mashara1618db2d8d6e
diff --git a/.typedoc/typedoc-plugin-frontmatter.js b/.typedoc/typedoc-plugin-frontmatter.jsindex 3d6982c76ff..c193bb9f119 100644--- a/.typedoc/typedoc-plugin-frontmatter.js+++ b/.typedoc/typedoc-plugin-frontmatter.js@@ -28,11 +28,7 @@ export function load(app) {.map(([key, value]) => `${key}: ${value}`).join("\n");- // Generate a redirect_from for the parallel `embedding/api/<Name>` path.- // Snippets in `sdk/api/snippets/*.md` link with relative `./api/X.md`; when- // included into a doc outside `sdk/` (e.g. `embedding/parameters.md`),- // that resolves to `embedding/api/X` instead of `embedding/sdk/api/X`.- // The redirect makes those URLs resolve via 301 instead of 404'ing.+ // Generate a redirect_from for the old `embedding/api/<Name>` path, which inbound links still use.const pageName = page.url.replace(/\.html$/, "");const redirectBlock =pageName && pageName !== "index"diff --git a/.typedoc/typedoc-plugin-markdown-prepare-for-embedding.js b/.typedoc/typedoc-plugin-markdown-prepare-for-embedding.jsindex abefee675c0..f93e40b57c8 100644--- a/.typedoc/typedoc-plugin-markdown-prepare-for-embedding.js+++ b/.typedoc/typedoc-plugin-markdown-prepare-for-embedding.js@@ -13,6 +13,9 @@ const convertSectionNameToSnippetName = (sectionName) =>/*** A typedoc plugin that prepares `.md` files for embedding+ * - it makes links to other API pages absolute, so they resolve the same from every page that+ * includes a snippet. It's done here rather than with `publicPath`, because typedoc-plugin-markdown+ * counts the link urls when deciding to break a union over several lines.* - it wraps content of all sections into `jekyll_include_plugin` snippet comments,* so such snippets can be included into other `.md` files.* See: https://github.com/flant/jekyll_include_plugin/tree/master@@ -22,6 +25,13 @@ export function load(app) {const isMarkdownPage = page.url.endsWith(".md");const isIndexFile = page.url.endsWith("index.md");+ if (isMarkdownPage) {+ page.contents = page.contents.replaceAll(+ "](./api/",+ "](/docs/latest/embedding/sdk/api/",+ );+ }+if (!isMarkdownPage || isIndexFile) {return;}diff --git a/docs/embedding/sdk/api/snippets/ActionResultForCreate.md b/docs/embedding/sdk/api/snippets/ActionResultForCreate.mdindex f24a917fc42..63a77521d21 100644--- a/docs/embedding/sdk/api/snippets/ActionResultForCreate.md+++ b/docs/embedding/sdk/api/snippets/ActionResultForCreate.md@@ -10,8 +10,8 @@ Response from a single-row create — the inserted row.<!-- [<snippet properties>] -->-| Property | Type |-| :------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- |-| <a id="created-row"></a> `created-row` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`RowValue`](./api/RowValue.md)\> |+| Property | Type |+| :------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| <a id="created-row"></a> `created-row` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`RowValue`](/docs/latest/embedding/sdk/api/RowValue.md)\> |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/ActionResultForDelete.md b/docs/embedding/sdk/api/snippets/ActionResultForDelete.mdindex 4eb257e7abb..97867d1ab6d 100644--- a/docs/embedding/sdk/api/snippets/ActionResultForDelete.md+++ b/docs/embedding/sdk/api/snippets/ActionResultForDelete.md@@ -10,8 +10,8 @@ Response from a single-row delete — the affected primary keys.<!-- [<snippet properties>] -->-| Property | Type |-| :--------------------------------------- | :----------------------------------------- |-| <a id="rows-deleted"></a> `rows-deleted` | readonly [`RowValue`](./api/RowValue.md)[] |+| Property | Type |+| :--------------------------------------- | :------------------------------------------------------------------ |+| <a id="rows-deleted"></a> `rows-deleted` | readonly [`RowValue`](/docs/latest/embedding/sdk/api/RowValue.md)[] |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/ActionResultForKind.md b/docs/embedding/sdk/api/snippets/ActionResultForKind.mdindex 61b5ee1b94b..b97512d884e 100644--- a/docs/embedding/sdk/api/snippets/ActionResultForKind.md+++ b/docs/embedding/sdk/api/snippets/ActionResultForKind.md@@ -19,8 +19,8 @@ Maps an `ActionKind` literal to the discriminated `result` shape. Omit<!-- [<snippet type-parameters>] -->-| Type Parameter |-| :------------------------------------------------------------------- |-| `TKind` _extends_ [`ActionKind`](./api/ActionKind.md) \| `undefined` |+| Type Parameter |+| :-------------------------------------------------------------------------------------------- |+| `TKind` _extends_ [`ActionKind`](/docs/latest/embedding/sdk/api/ActionKind.md) \| `undefined` |<!-- [<endsnippet type-parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/ActionResultForUpdate.md b/docs/embedding/sdk/api/snippets/ActionResultForUpdate.mdindex 775f8da01b5..26b7e316a8f 100644--- a/docs/embedding/sdk/api/snippets/ActionResultForUpdate.md+++ b/docs/embedding/sdk/api/snippets/ActionResultForUpdate.md@@ -10,8 +10,8 @@ Response from a single-row update — the affected primary keys.<!-- [<snippet properties>] -->-| Property | Type |-| :--------------------------------------- | :----------------------------------------- |-| <a id="rows-updated"></a> `rows-updated` | readonly [`RowValue`](./api/RowValue.md)[] |+| Property | Type |+| :--------------------------------------- | :------------------------------------------------------------------ |+| <a id="rows-updated"></a> `rows-updated` | readonly [`RowValue`](/docs/latest/embedding/sdk/api/RowValue.md)[] |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/CollectionBrowser.md b/docs/embedding/sdk/api/snippets/CollectionBrowser.mdindex a965a688737..21aae690bd6 100644--- a/docs/embedding/sdk/api/snippets/CollectionBrowser.md+++ b/docs/embedding/sdk/api/snippets/CollectionBrowser.md@@ -8,9 +8,9 @@ A component that allows you to browse collections and their items.<!-- [<snippet parameters>] -->-| Parameter | Type |-| :-------- | :---------------------------------------------------------- |-| `props` | [`CollectionBrowserProps`](./api/CollectionBrowserProps.md) |+| Parameter | Type |+| :-------- | :----------------------------------------------------------------------------------- |+| `props` | [`CollectionBrowserProps`](/docs/latest/embedding/sdk/api/CollectionBrowserProps.md) |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/CollectionBrowserProps.md b/docs/embedding/sdk/api/snippets/CollectionBrowserProps.mdindex 0e7ac53a086..ae367fca150 100644--- a/docs/embedding/sdk/api/snippets/CollectionBrowserProps.md+++ b/docs/embedding/sdk/api/snippets/CollectionBrowserProps.md@@ -7,13 +7,13 @@| Property | Type | Description || :------------------------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ || <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |-| <a id="collectionid"></a> `collectionId?` | [`SdkBrowserCollectionId`](./api/SdkBrowserCollectionId.md) | The collection to show: - a number - the collection ID. You can find it in the URL of a collection in your Metabase instance. For `http://localhost:3000/collection/1-my-collection` the ID is `1`. - an entity ID string, e.g. `"nT4gT_MOnU1uJ1zLsGaTV"`. - `"personal"` - the user's personal collection. - `"tenant"` - the user's tenant collection. - `"root"` - the root collection, "Our analytics". - `"all"` - a list that contains the root collection, the tenant collections, and the user's personal collection. Defaults to `"personal"`. |+| <a id="collectionid"></a> `collectionId?` | [`SdkBrowserCollectionId`](/docs/latest/embedding/sdk/api/SdkBrowserCollectionId.md) | The collection to show: - a number - the collection ID. You can find it in the URL of a collection in your Metabase instance. For `http://localhost:3000/collection/1-my-collection` the ID is `1`. - an entity ID string, e.g. `"nT4gT_MOnU1uJ1zLsGaTV"`. - `"personal"` - the user's personal collection. - `"tenant"` - the user's tenant collection. - `"root"` - the root collection, "Our analytics". - `"all"` - a list that contains the root collection, the tenant collections, and the user's personal collection. Defaults to `"personal"`. || <a id="emptycontentcomponent"></a> `EmptyContentComponent?` | \| [`ComponentType`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L104) \| `null` | A component to display when there are no items in the collection. |-| <a id="onclick"></a> `onClick?` | (`item`: [`MetabaseCollectionItem`](./api/MetabaseCollectionItem.md)) => `void` | A function to call when an item is clicked. |+| <a id="onclick"></a> `onClick?` | (`item`: [`MetabaseCollectionItem`](/docs/latest/embedding/sdk/api/MetabaseCollectionItem.md)) => `void` | A function to call when an item is clicked. || <a id="pagesize"></a> `pageSize?` | `number` | The number of items to display per page. The default is 25. || <a id="showdashboardquestions"></a> `showDashboardQuestions?` | `boolean` | Whether to show questions that belong to a dashboard alongside collection saved questions. Set to true to show them. Defaults to false, keeping the list focused on collection content. || <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |-| <a id="visiblecolumns"></a> `visibleColumns?` | [`CollectionBrowserListColumns`](./api/CollectionBrowserListColumns.md)[] | The columns to display in the collection items table. If not provided, all columns will be shown. |+| <a id="visiblecolumns"></a> `visibleColumns?` | [`CollectionBrowserListColumns`](/docs/latest/embedding/sdk/api/CollectionBrowserListColumns.md)[] | The columns to display in the collection items table. If not provided, all columns will be shown. || <a id="visibleentitytypes"></a> `visibleEntityTypes?` | (`"collection"` \| `"dashboard"` \| `"question"` \| `"model"`)[] | The types of entities that should be visible. If not provided, all entities will be shown. |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/CreateDashboardModal.md b/docs/embedding/sdk/api/snippets/CreateDashboardModal.mdindex 0746f0716c1..bf70294ed35 100644--- a/docs/embedding/sdk/api/snippets/CreateDashboardModal.md+++ b/docs/embedding/sdk/api/snippets/CreateDashboardModal.md@@ -8,9 +8,9 @@ Creates a dashboard<!-- [<snippet parameters>] -->-| Parameter | Type |-| :-------- | :---------------------------------------------------------------- |-| `props` | [`CreateDashboardModalProps`](./api/CreateDashboardModalProps.md) |+| Parameter | Type |+| :-------- | :----------------------------------------------------------------------------------------- |+| `props` | [`CreateDashboardModalProps`](/docs/latest/embedding/sdk/api/CreateDashboardModalProps.md) |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/CreateDashboardModalProps.md b/docs/embedding/sdk/api/snippets/CreateDashboardModalProps.mdindex bc61eef7e16..0ac3c035a65 100644--- a/docs/embedding/sdk/api/snippets/CreateDashboardModalProps.md+++ b/docs/embedding/sdk/api/snippets/CreateDashboardModalProps.md@@ -4,12 +4,12 @@<!-- [<snippet properties>] -->-| Property | Type | Description |-| :------------------------------------------------------ | :------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------- |-| <a id="initialcollectionid"></a> `initialCollectionId?` | [`SdkCollectionId`](./api/SdkCollectionId.md) | Initial collection in which to create a dashboard. You can use predefined system values like `root` or `personal`. |-| <a id="isopen"></a> `isOpen?` | `boolean` | Whether the modal is open or not. |-| <a id="onclose"></a> `onClose?` | () => `void` | Handler to close modal component |-| <a id="oncreate"></a> `onCreate` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md)) => `void` | Handler to react on dashboard creation. |-| <a id="targetcollection"></a> `targetCollection?` | [`SdkCollectionId`](./api/SdkCollectionId.md) | The collection to save the dashboard to. This will hide the collection picker from the save modal. |+| Property | Type | Description |+| :------------------------------------------------------ | :-------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------- |+| <a id="initialcollectionid"></a> `initialCollectionId?` | [`SdkCollectionId`](/docs/latest/embedding/sdk/api/SdkCollectionId.md) | Initial collection in which to create a dashboard. You can use predefined system values like `root` or `personal`. |+| <a id="isopen"></a> `isOpen?` | `boolean` | Whether the modal is open or not. |+| <a id="onclose"></a> `onClose?` | () => `void` | Handler to close modal component |+| <a id="oncreate"></a> `onCreate` | (`dashboard`: [`MetabaseDashboard`](/docs/latest/embedding/sdk/api/MetabaseDashboard.md)) => `void` | Handler to react on dashboard creation. |+| <a id="targetcollection"></a> `targetCollection?` | [`SdkCollectionId`](/docs/latest/embedding/sdk/api/SdkCollectionId.md) | The collection to save the dashboard to. This will hide the collection picker from the save modal. |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/CreateDashboardValues.md b/docs/embedding/sdk/api/snippets/CreateDashboardValues.mdindex 55830d0993b..44aa8aec77f 100644--- a/docs/embedding/sdk/api/snippets/CreateDashboardValues.md+++ b/docs/embedding/sdk/api/snippets/CreateDashboardValues.md@@ -2,10 +2,10 @@<!-- [<snippet properties>] -->-| Property | Type | Description |-| :--------------------------------------- | :-------------------------------------------- | :------------------------------------------------------------------------------------------------------------- |-| <a id="collectionid"></a> `collectionId` | [`SdkCollectionId`](./api/SdkCollectionId.md) | Collection in which to create a new dashboard. You can use predefined system values like `root` or `personal`. |-| <a id="description"></a> `description` | `string` \| `null` | Dashboard description |-| <a id="name"></a> `name` | `string` | Dashboard title |+| Property | Type | Description |+| :--------------------------------------- | :--------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- |+| <a id="collectionid"></a> `collectionId` | [`SdkCollectionId`](/docs/latest/embedding/sdk/api/SdkCollectionId.md) | Collection in which to create a new dashboard. You can use predefined system values like `root` or `personal`. |+| <a id="description"></a> `description` | `string` \| `null` | Dashboard description |+| <a id="name"></a> `name` | `string` | Dashboard title |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/CreateQuestion.md b/docs/embedding/sdk/api/snippets/CreateQuestion.mdindex b5be6204349..d084c38a009 100644--- a/docs/embedding/sdk/api/snippets/CreateQuestion.md+++ b/docs/embedding/sdk/api/snippets/CreateQuestion.md@@ -6,9 +6,9 @@ function CreateQuestion(props: CreateQuestionProps | undefined): Element;<!-- [<snippet parameters>] -->-| Parameter | Type |-| :-------- | :------------------------------------------------------------------- |-| `props` | [`CreateQuestionProps`](./api/CreateQuestionProps.md) \| `undefined` |+| Parameter | Type |+| :-------- | :-------------------------------------------------------------------------------------------- |+| `props` | [`CreateQuestionProps`](/docs/latest/embedding/sdk/api/CreateQuestionProps.md) \| `undefined` |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/CreateQuestionProps.md b/docs/embedding/sdk/api/snippets/CreateQuestionProps.mdindex f3892dd7aae..e9f7e2ad7da 100644--- a/docs/embedding/sdk/api/snippets/CreateQuestionProps.md+++ b/docs/embedding/sdk/api/snippets/CreateQuestionProps.md@@ -7,24 +7,24 @@| Property | Type | Description || :---------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- || <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |-| <a id="datapicker"></a> `dataPicker?` | [`EmbeddingDataPicker`](./api/EmbeddingDataPicker.md) | Controls the menu for selecting data sources in questions. You can opt for the full data picker by setting `dataPicker = "staged"`. |-| <a id="entitytypes"></a> `entityTypes?` | [`EmbeddingEntityType`](./api/EmbeddingEntityType.md)[] | An array that specifies which entity types are available in the data picker |+| <a id="datapicker"></a> `dataPicker?` | [`EmbeddingDataPicker`](/docs/latest/embedding/sdk/api/EmbeddingDataPicker.md) | Controls the menu for selecting data sources in questions. You can opt for the full data picker by setting `dataPicker = "staged"`. |+| <a id="entitytypes"></a> `entityTypes?` | [`EmbeddingEntityType`](/docs/latest/embedding/sdk/api/EmbeddingEntityType.md)[] | An array that specifies which entity types are available in the data picker || <a id="height"></a> `height?` | `Height`\<`string` \| `number`\> | A number or string specifying a CSS size value that specifies the height of the component || <a id="hiddenparameters"></a> `hiddenParameters?` | `string`[] | A list of parameters to hide. |-| <a id="initialcollection"></a> `initialCollection?` | [`SdkCollectionId`](./api/SdkCollectionId.md) | The collection to preselect in the save modal's collection picker. Unlike `targetCollection`, the picker remains visible and the user can choose a different collection. Ignored when `targetCollection` is set. |-| <a id="initialsqlparameters"></a> `initialSqlParameters?` | [`SqlParameterValues`](./api/SqlParameterValues.md) | Initial values for SQL parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value: that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). |+| <a id="initialcollection"></a> `initialCollection?` | [`SdkCollectionId`](/docs/latest/embedding/sdk/api/SdkCollectionId.md) | The collection to preselect in the save modal's collection picker. Unlike `targetCollection`, the picker remains visible and the user can choose a different collection. Ignored when `targetCollection` is set. |+| <a id="initialsqlparameters"></a> `initialSqlParameters?` | [`SqlParameterValues`](/docs/latest/embedding/sdk/api/SqlParameterValues.md) | Initial values for SQL parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value: that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). || <a id="issaveenabled"></a> `isSaveEnabled?` | `boolean` | Whether to show the save button. |-| <a id="onbeforesave"></a> `onBeforeSave?` | (`question`: [`MetabaseQuestion`](./api/MetabaseQuestion.md) \| `undefined`, `context`: \{ `isNewQuestion`: `boolean`; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | A callback function that triggers before saving. Only relevant when `isSaveEnabled = true` |+| <a id="onbeforesave"></a> `onBeforeSave?` | (`question`: [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md) \| `undefined`, `context`: \{ `isNewQuestion`: `boolean`; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | A callback function that triggers before saving. Only relevant when `isSaveEnabled = true` || <a id="onnavigateback"></a> `onNavigateBack?` | () => `void` | A callback function that triggers when a user clicks the back button. |-| <a id="onrun"></a> `onRun?` | (`question`: [`MetabaseQuestion`](./api/MetabaseQuestion.md) \| `undefined`) => `void` | A callback function that triggers when a question is updated, including when a user clicks the `Visualize` button in the question editor |-| <a id="onsave"></a> `onSave?` | (`question`: [`MetabaseQuestion`](./api/MetabaseQuestion.md), `context`: \{ `dashboardTabId?`: `number`; `isNewQuestion`: `boolean`; \}) => `void` | A callback function that triggers when a user saves the question. Only relevant when `isSaveEnabled = true` |-| <a id="onsqlparameterschange"></a> `onSqlParametersChange?` | (`payload`: [`SqlParameterChangePayload`](./api/SqlParameterChangePayload.md)) => `void` | Fires on SQL parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |+| <a id="onrun"></a> `onRun?` | (`question`: [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md) \| `undefined`) => `void` | A callback function that triggers when a question is updated, including when a user clicks the `Visualize` button in the question editor |+| <a id="onsave"></a> `onSave?` | (`question`: [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md), `context`: \{ `dashboardTabId?`: `number`; `isNewQuestion`: `boolean`; \}) => `void` | A callback function that triggers when a user saves the question. Only relevant when `isSaveEnabled = true` |+| <a id="onsqlparameterschange"></a> `onSqlParametersChange?` | (`payload`: [`SqlParameterChangePayload`](/docs/latest/embedding/sdk/api/SqlParameterChangePayload.md)) => `void` | Fires on SQL parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). || <a id="onvisualizationchange"></a> `onVisualizationChange?` | (`display`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void` | A callback function that triggers when the visualization type changes. |-| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](./api/MetabasePluginsConfig.md) | - |-| <a id="sqlparameters"></a> `sqlParameters?` | [`SqlParameterValues`](./api/SqlParameterValues.md) | Controlled SQL parameter values, slug-keyed. On every render, this object replaces the question's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with `onSqlParametersChange` to stay in sync with user edits. |+| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](/docs/latest/embedding/sdk/api/MetabasePluginsConfig.md) | - |+| <a id="sqlparameters"></a> `sqlParameters?` | [`SqlParameterValues`](/docs/latest/embedding/sdk/api/SqlParameterValues.md) | Controlled SQL parameter values, slug-keyed. On every render, this object replaces the question's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with `onSqlParametersChange` to stay in sync with user edits. || <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |-| <a id="targetcollection"></a> `targetCollection?` | [`SdkCollectionId`](./api/SdkCollectionId.md) | The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions. |-| <a id="title"></a> `title?` | [`SdkQuestionTitleProps`](./api/SdkQuestionTitleProps.md) | Determines whether the question title is displayed, and allows a custom title to be displayed instead of the default question title. Shown by default. |+| <a id="targetcollection"></a> `targetCollection?` | [`SdkCollectionId`](/docs/latest/embedding/sdk/api/SdkCollectionId.md) | The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions. |+| <a id="title"></a> `title?` | [`SdkQuestionTitleProps`](/docs/latest/embedding/sdk/api/SdkQuestionTitleProps.md) | Determines whether the question title is displayed, and allows a custom title to be displayed instead of the default question title. Shown by default. || <a id="width"></a> `width?` | `Width`\<`string` \| `number`\> | A number or string specifying a CSS size value that specifies the width of the component || <a id="withalerts"></a> `withAlerts?` | `boolean` | Enables the ability to set up alerts on the question. || <a id="withcharttypeselector"></a> `withChartTypeSelector?` | `boolean` | Determines whether the chart type selector and corresponding settings button are shown. Only relevant when using the default layout. |diff --git a/docs/embedding/sdk/api/snippets/CustomDashboardCardMenuItem.md b/docs/embedding/sdk/api/snippets/CustomDashboardCardMenuItem.mdindex 6ede6b62a24..957d7c6a810 100644--- a/docs/embedding/sdk/api/snippets/CustomDashboardCardMenuItem.md+++ b/docs/embedding/sdk/api/snippets/CustomDashboardCardMenuItem.md@@ -10,10 +10,10 @@ type CustomDashboardCardMenuItem = ({<!-- [<snippet parameters>] -->-| Parameter | Type |-| :------------------------ | :------------------------------------------------------------------ |-| `{ question, }` | \{ `question?`: [`MetabaseQuestion`](./api/MetabaseQuestion.md); \} |-| `{ question, }.question?` | [`MetabaseQuestion`](./api/MetabaseQuestion.md) |+| Parameter | Type |+| :------------------------ | :------------------------------------------------------------------------------------------- |+| `{ question, }` | \{ `question?`: [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md); \} |+| `{ question, }.question?` | [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md) |<!-- [<endsnippet parameters>] -->@@ -21,6 +21,6 @@ type CustomDashboardCardMenuItem = ({<!-- [<snippet returns>] -->-[`DashCardMenuItem`](./api/DashCardMenuItem.md)+[`DashCardMenuItem`](/docs/latest/embedding/sdk/api/DashCardMenuItem.md)<!-- [<endsnippet returns>] -->diff --git a/docs/embedding/sdk/api/snippets/DashCardMenuItem.md b/docs/embedding/sdk/api/snippets/DashCardMenuItem.mdindex 1c4b4e032a9..7c01d9abd4f 100644--- a/docs/embedding/sdk/api/snippets/DashCardMenuItem.md+++ b/docs/embedding/sdk/api/snippets/DashCardMenuItem.md@@ -22,7 +22,7 @@ type DashCardMenuItem = {| <a id="closemenuonclick"></a> `closeMenuOnClick?` | `boolean` | Determines whether the menu should be closed when the item is clicked, overrides `closeOnItemClick` prop on the `Menu` component || <a id="color"></a> `color?` | [`MantineColor`](https://v7.mantine.dev/overview) | Key of `theme.colors` or any valid CSS color || <a id="disabled"></a> `disabled?` | `boolean` | Disables item |-| <a id="iconname"></a> `iconName` | [`IconName`](./api/IconName.md) | Icon name |+| <a id="iconname"></a> `iconName` | [`IconName`](/docs/latest/embedding/sdk/api/IconName.md) | Icon name || <a id="label"></a> `label` | `string` | Item label || <a id="leftsection"></a> `leftSection?` | [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478) | Section displayed on the left side of the label || <a id="onclick"></a> `onClick` | () => `void` | Click handler |diff --git a/docs/embedding/sdk/api/snippets/DashboardCardCustomMenuItem.md b/docs/embedding/sdk/api/snippets/DashboardCardCustomMenuItem.mdindex 66b085be1de..a775280166d 100644--- a/docs/embedding/sdk/api/snippets/DashboardCardCustomMenuItem.md+++ b/docs/embedding/sdk/api/snippets/DashboardCardCustomMenuItem.md@@ -10,10 +10,10 @@ type DashboardCardCustomMenuItem = {<!-- [<snippet properties>] -->-| Property | Type | Description |-| :------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------- | :----------- |-| <a id="customitems"></a> `customItems?` | ( \| [`DashCardMenuItem`](./api/DashCardMenuItem.md) \| [`CustomDashboardCardMenuItem`](./api/CustomDashboardCardMenuItem.md))[] | **`Expand`** |-| <a id="withdownloads"></a> `withDownloads?` | `boolean` | - |-| <a id="witheditlink"></a> `withEditLink?` | `boolean` | - |+| Property | Type | Description |+| :------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------- |+| <a id="customitems"></a> `customItems?` | ( \| [`DashCardMenuItem`](/docs/latest/embedding/sdk/api/DashCardMenuItem.md) \| [`CustomDashboardCardMenuItem`](/docs/latest/embedding/sdk/api/CustomDashboardCardMenuItem.md))[] | **`Expand`** |+| <a id="withdownloads"></a> `withDownloads?` | `boolean` | - |+| <a id="witheditlink"></a> `withEditLink?` | `boolean` | - |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/DashboardCardMenuCustomElement.md b/docs/embedding/sdk/api/snippets/DashboardCardMenuCustomElement.mdindex 6bd4a016491..4e95025bd6f 100644--- a/docs/embedding/sdk/api/snippets/DashboardCardMenuCustomElement.md+++ b/docs/embedding/sdk/api/snippets/DashboardCardMenuCustomElement.md@@ -10,10 +10,10 @@ type DashboardCardMenuCustomElement = ({<!-- [<snippet parameters>] -->-| Parameter | Type |-| :----------------------- | :----------------------------------------------------------------- |-| `{ question, }` | \{ `question`: [`MetabaseQuestion`](./api/MetabaseQuestion.md); \} |-| `{ question, }.question` | [`MetabaseQuestion`](./api/MetabaseQuestion.md) |+| Parameter | Type |+| :----------------------- | :------------------------------------------------------------------------------------------ |+| `{ question, }` | \{ `question`: [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md); \} |+| `{ question, }.question` | [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md) |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/DataAppLink.md b/docs/embedding/sdk/api/snippets/DataAppLink.mdindex e97c0c22a74..3dd51b12a6f 100644--- a/docs/embedding/sdk/api/snippets/DataAppLink.md+++ b/docs/embedding/sdk/api/snippets/DataAppLink.md@@ -22,9 +22,9 @@ to load as a top-level page. A plain click navigates inside the app.<!-- [<snippet parameters>] -->-| Parameter | Type |-| :------------------------------------------------ | :---------------------------------------------- |-| `{ to, children, onClick, target, rel, ...rest }` | [`DataAppLinkProps`](./api/DataAppLinkProps.md) |+| Parameter | Type |+| :------------------------------------------------ | :----------------------------------------------------------------------- |+| `{ to, children, onClick, target, rel, ...rest }` | [`DataAppLinkProps`](/docs/latest/embedding/sdk/api/DataAppLinkProps.md) |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/DataAppRouter.md b/docs/embedding/sdk/api/snippets/DataAppRouter.mdindex 50cac51e681..8b1855ccc63 100644--- a/docs/embedding/sdk/api/snippets/DataAppRouter.md+++ b/docs/embedding/sdk/api/snippets/DataAppRouter.md@@ -13,9 +13,9 @@ basename resolves to `""` and the sub-path is just the raw pathname.<!-- [<snippet parameters>] -->-| Parameter | Type |-| :------------- | :-------------------------------------------------- |-| `{ children }` | [`DataAppRouterProps`](./api/DataAppRouterProps.md) |+| Parameter | Type |+| :------------- | :--------------------------------------------------------------------------- |+| `{ children }` | [`DataAppRouterProps`](/docs/latest/embedding/sdk/api/DataAppRouterProps.md) |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/DrillThroughQuestionProps.md b/docs/embedding/sdk/api/snippets/DrillThroughQuestionProps.mdindex a7f921893ff..556c395ebd1 100644--- a/docs/embedding/sdk/api/snippets/DrillThroughQuestionProps.md+++ b/docs/embedding/sdk/api/snippets/DrillThroughQuestionProps.md@@ -6,27 +6,27 @@ Props for the drill-through question<!-- [<snippet properties>] -->-| Property | Type | Description |-| :---------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-| <a id="children"></a> `children?` | [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478) | The children of the component |-| <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |-| <a id="datapicker"></a> `dataPicker?` | [`EmbeddingDataPicker`](./api/EmbeddingDataPicker.md) | Controls the menu for selecting data sources in questions. You can opt for the full data picker by setting `dataPicker = "staged"`. |-| <a id="entitytypes"></a> `entityTypes?` | [`EmbeddingEntityType`](./api/EmbeddingEntityType.md)[] | An array that specifies which entity types are available in the data picker |-| <a id="height"></a> `height?` | `Height`\<`string` \| `number`\> | A number or string specifying a CSS size value that specifies the height of the component |-| <a id="initialcollection"></a> `initialCollection?` | [`SdkCollectionId`](./api/SdkCollectionId.md) | The collection to preselect in the save modal's collection picker. Unlike `targetCollection`, the picker remains visible and the user can choose a different collection. Ignored when `targetCollection` is set. |-| <a id="initialsqlparameters"></a> `initialSqlParameters?` | [`SqlParameterValues`](./api/SqlParameterValues.md) | Initial values for SQL parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value: that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). |-| <a id="issaveenabled"></a> `isSaveEnabled?` | `boolean` | Whether to show the save button. |-| <a id="onbeforesave"></a> `onBeforeSave?` | (`question`: [`MetabaseQuestion`](./api/MetabaseQuestion.md) \| `undefined`, `context`: \{ `isNewQuestion`: `boolean`; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | A callback function that triggers before saving. Only relevant when `isSaveEnabled = true` |-| <a id="onrun"></a> `onRun?` | (`question`: [`MetabaseQuestion`](./api/MetabaseQuestion.md) \| `undefined`) => `void` | A callback function that triggers when a question is updated, including when a user clicks the `Visualize` button in the question editor |-| <a id="onsave"></a> `onSave?` | (`question`: [`MetabaseQuestion`](./api/MetabaseQuestion.md), `context`: \{ `dashboardTabId?`: `number`; `isNewQuestion`: `boolean`; \}) => `void` | A callback function that triggers when a user saves the question. Only relevant when `isSaveEnabled = true` |-| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](./api/MetabasePluginsConfig.md) | - |-| <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |-| <a id="targetcollection"></a> `targetCollection?` | [`SdkCollectionId`](./api/SdkCollectionId.md) | The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions. |-| <a id="title"></a> `title?` | [`SdkQuestionTitleProps`](./api/SdkQuestionTitleProps.md) | Determines whether the question title is displayed, and allows a custom title to be displayed instead of the default question title. Shown by default. |-| <a id="width"></a> `width?` | `Width`\<`string` \| `number`\> | A number or string specifying a CSS size value that specifies the width of the component |-| <a id="withalerts"></a> `withAlerts?` | `boolean` | Enables the ability to set up alerts on the question. |-| <a id="withcharttypeselector"></a> `withChartTypeSelector?` | `boolean` | Determines whether the chart type selector and corresponding settings button are shown. Only relevant when using the default layout. |-| <a id="withdownloads"></a> `withDownloads?` | `boolean` | Enables the ability to download results in the question. |-| <a id="witheditorbutton"></a> `withEditorButton?` | `boolean` | Determines whether the editor button is shown. Only relevant when using the default layout. |+| Property | Type | Description |+| :---------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| <a id="children"></a> `children?` | [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478) | The children of the component |+| <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |+| <a id="datapicker"></a> `dataPicker?` | [`EmbeddingDataPicker`](/docs/latest/embedding/sdk/api/EmbeddingDataPicker.md) | Controls the menu for selecting data sources in questions. You can opt for the full data picker by setting `dataPicker = "staged"`. |+| <a id="entitytypes"></a> `entityTypes?` | [`EmbeddingEntityType`](/docs/latest/embedding/sdk/api/EmbeddingEntityType.md)[] | An array that specifies which entity types are available in the data picker |+| <a id="height"></a> `height?` | `Height`\<`string` \| `number`\> | A number or string specifying a CSS size value that specifies the height of the component |+| <a id="initialcollection"></a> `initialCollection?` | [`SdkCollectionId`](/docs/latest/embedding/sdk/api/SdkCollectionId.md) | The collection to preselect in the save modal's collection picker. Unlike `targetCollection`, the picker remains visible and the user can choose a different collection. Ignored when `targetCollection` is set. |+| <a id="initialsqlparameters"></a> `initialSqlParameters?` | [`SqlParameterValues`](/docs/latest/embedding/sdk/api/SqlParameterValues.md) | Initial values for SQL parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value: that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). |+| <a id="issaveenabled"></a> `isSaveEnabled?` | `boolean` | Whether to show the save button. |+| <a id="onbeforesave"></a> `onBeforeSave?` | (`question`: [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md) \| `undefined`, `context`: \{ `isNewQuestion`: `boolean`; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | A callback function that triggers before saving. Only relevant when `isSaveEnabled = true` |+| <a id="onrun"></a> `onRun?` | (`question`: [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md) \| `undefined`) => `void` | A callback function that triggers when a question is updated, including when a user clicks the `Visualize` button in the question editor |+| <a id="onsave"></a> `onSave?` | (`question`: [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md), `context`: \{ `dashboardTabId?`: `number`; `isNewQuestion`: `boolean`; \}) => `void` | A callback function that triggers when a user saves the question. Only relevant when `isSaveEnabled = true` |+| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](/docs/latest/embedding/sdk/api/MetabasePluginsConfig.md) | - |+| <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |+| <a id="targetcollection"></a> `targetCollection?` | [`SdkCollectionId`](/docs/latest/embedding/sdk/api/SdkCollectionId.md) | The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions. |+| <a id="title"></a> `title?` | [`SdkQuestionTitleProps`](/docs/latest/embedding/sdk/api/SdkQuestionTitleProps.md) | Determines whether the question title is displayed, and allows a custom title to be displayed instead of the default question title. Shown by default. |+| <a id="width"></a> `width?` | `Width`\<`string` \| `number`\> | A number or string specifying a CSS size value that specifies the width of the component |+| <a id="withalerts"></a> `withAlerts?` | `boolean` | Enables the ability to set up alerts on the question. |+| <a id="withcharttypeselector"></a> `withChartTypeSelector?` | `boolean` | Determines whether the chart type selector and corresponding settings button are shown. Only relevant when using the default layout. |+| <a id="withdownloads"></a> `withDownloads?` | `boolean` | Enables the ability to download results in the question. |+| <a id="witheditorbutton"></a> `withEditorButton?` | `boolean` | Determines whether the editor button is shown. Only relevant when using the default layout. |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/EditableDashboard.md b/docs/embedding/sdk/api/snippets/EditableDashboard.mdindex 67d1baefba7..311d145a937 100644--- a/docs/embedding/sdk/api/snippets/EditableDashboard.md+++ b/docs/embedding/sdk/api/snippets/EditableDashboard.md@@ -8,9 +8,9 @@ A dashboard component with the features available in the `InteractiveDashboard`<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :---------------------------------------------------------- | :---------- |-| `props` | [`EditableDashboardProps`](./api/EditableDashboardProps.md) | |+| Parameter | Type | Description |+| :-------- | :----------------------------------------------------------------------------------- | :---------- |+| `props` | [`EditableDashboardProps`](/docs/latest/embedding/sdk/api/EditableDashboardProps.md) | |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/EditableDashboardProps.md b/docs/embedding/sdk/api/snippets/EditableDashboardProps.mdindex 9b1be6cfa7f..ee563818e9a 100644--- a/docs/embedding/sdk/api/snippets/EditableDashboardProps.md+++ b/docs/embedding/sdk/api/snippets/EditableDashboardProps.md@@ -4,29 +4,29 @@<!-- [<snippet properties>] -->-| Property | Type | Description |-| :-------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-| <a id="autorefreshinterval"></a> `autoRefreshInterval?` | `number` | The interval between auto refreshes on the dashboard, in seconds. |-| <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |-| <a id="dashboardid"></a> `dashboardId` | `string` \| `number` | The ID of the dashboard. <br/> This is either: <br/> - the numerical ID when accessing a dashboard link, i.e. `http://localhost:3000/dashboard/1-my-dashboard` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the dashboard object when using the API directly or using the SDK Collection Browser to return data |-| <a id="datapickerprops"></a> `dataPickerProps?` | [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`SdkQuestionProps`](./api/SdkQuestionProps.md), `"entityTypes"` \| `"dataPicker"`\> | Additional props to pass to the query builder rendered by `InteractiveQuestion` when creating a new dashboard question. Set `dataPicker: "staged"` to always get the staged data picker. By default, Metabase shows a simple dropdown menu with tables and models, and only switches to the staged picker when there are 100 or more data sources. `entityTypes: ["question"]` only takes effect in the staged picker. |-| <a id="drillthroughquestionheight"></a> `drillThroughQuestionHeight?` | `Height`\<`string` \| `number`\> | Height of a question component when drilled from the dashboard to a question level. |-| <a id="drillthroughquestionprops"></a> `drillThroughQuestionProps?` | [`DrillThroughQuestionProps`](./api/DrillThroughQuestionProps.md) | Props of a question component when drilled from the dashboard to a question level. |-| <a id="enableentitynavigation"></a> `enableEntityNavigation?` | `boolean` | When true, internal click behaviors (links to dashboards/questions) are preserved. When false (default for SDK), these click behaviors are filtered out. |-| <a id="hiddenparameters"></a> `hiddenParameters?` | `string`[] | A list of [parameters to hide](https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="initialparameters"></a> `initialParameters?` | [`ParameterValues`](./api/ParameterValues.md) | Initial values for query parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value (string for a single option, array of strings for multiple): that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). <br/> <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="onload"></a> `onLoad?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded. |-| <a id="onloadwithoutcards"></a> `onLoadWithoutCards?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded without cards. |-| <a id="onparameterschange"></a> `onParametersChange?` | (`payload`: [`ParameterChangePayload`](./api/ParameterChangePayload.md)) => `void` | Fires on parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |-| <a id="onvisualizationchange"></a> `onVisualizationChange?` | (`visualization`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void` | A callback function that triggers when a question is opened from a dashboard card or when the user changes the visualization type of a question. |-| <a id="parameters"></a> `parameters?` | [`ParameterValues`](./api/ParameterValues.md) | Controlled parameter values, slug-keyed. On every render, this object replaces the dashboard's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with [onParametersChange](./api/InteractiveDashboardProps.md#onparameterschange) to stay in sync with user edits. <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](./api/MetabasePluginsConfig.md) | Additional mapper function to override or add drill-down menu. See the implementing custom actions section for more details. |-| <a id="renderdrillthroughquestion"></a> `renderDrillThroughQuestion?` | () => [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478) | A custom React component to render the question layout. Use namespaced InteractiveQuestion components to build the layout. |-| <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |-| <a id="token"></a> `token?` | `string` \| `null` | - |-| <a id="withcardtitle"></a> `withCardTitle?` | `boolean` | Whether the dashboard cards should display a title. |-| <a id="withdownloads"></a> `withDownloads?` | `boolean` | Whether to hide the download button. |-| <a id="withsubscriptions"></a> `withSubscriptions?` | `boolean` | Whether to show the subscriptions button. |-| <a id="withtitle"></a> `withTitle?` | `boolean` | Whether the dashboard should display a title. |+| Property | Type | Description |+| :-------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| <a id="autorefreshinterval"></a> `autoRefreshInterval?` | `number` | The interval between auto refreshes on the dashboard, in seconds. |+| <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |+| <a id="dashboardid"></a> `dashboardId` | `string` \| `number` | The ID of the dashboard. <br/> This is either: <br/> - the numerical ID when accessing a dashboard link, i.e. `http://localhost:3000/dashboard/1-my-dashboard` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the dashboard object when using the API directly or using the SDK Collection Browser to return data |+| <a id="datapickerprops"></a> `dataPickerProps?` | [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`SdkQuestionProps`](/docs/latest/embedding/sdk/api/SdkQuestionProps.md), `"entityTypes"` \| `"dataPicker"`\> | Additional props to pass to the query builder rendered by `InteractiveQuestion` when creating a new dashboard question. Set `dataPicker: "staged"` to always get the staged data picker. By default, Metabase shows a simple dropdown menu with tables and models, and only switches to the staged picker when there are 100 or more data sources. `entityTypes: ["question"]` only takes effect in the staged picker. |+| <a id="drillthroughquestionheight"></a> `drillThroughQuestionHeight?` | `Height`\<`string` \| `number`\> | Height of a question component when drilled from the dashboard to a question level. |+| <a id="drillthroughquestionprops"></a> `drillThroughQuestionProps?` | [`DrillThroughQuestionProps`](/docs/latest/embedding/sdk/api/DrillThroughQuestionProps.md) | Props of a question component when drilled from the dashboard to a question level. |+| <a id="enableentitynavigation"></a> `enableEntityNavigation?` | `boolean` | When true, internal click behaviors (links to dashboards/questions) are preserved. When false (default for SDK), these click behaviors are filtered out. |+| <a id="hiddenparameters"></a> `hiddenParameters?` | `string`[] | A list of [parameters to hide](https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters). <br/> - Combining [initialParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="initialparameters"></a> `initialParameters?` | [`ParameterValues`](/docs/latest/embedding/sdk/api/ParameterValues.md) | Initial values for query parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value (string for a single option, array of strings for multiple): that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). <br/> <br/> - Combining [initialParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="onload"></a> `onLoad?` | (`dashboard`: [`MetabaseDashboard`](/docs/latest/embedding/sdk/api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded. |+| <a id="onloadwithoutcards"></a> `onLoadWithoutCards?` | (`dashboard`: [`MetabaseDashboard`](/docs/latest/embedding/sdk/api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded without cards. |+| <a id="onparameterschange"></a> `onParametersChange?` | (`payload`: [`ParameterChangePayload`](/docs/latest/embedding/sdk/api/ParameterChangePayload.md)) => `void` | Fires on parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |+| <a id="onvisualizationchange"></a> `onVisualizationChange?` | (`visualization`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void` | A callback function that triggers when a question is opened from a dashboard card or when the user changes the visualization type of a question. |+| <a id="parameters"></a> `parameters?` | [`ParameterValues`](/docs/latest/embedding/sdk/api/ParameterValues.md) | Controlled parameter values, slug-keyed. On every render, this object replaces the dashboard's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with [onParametersChange](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#onparameterschange) to stay in sync with user edits. <br/> - Combining [parameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [parameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](/docs/latest/embedding/sdk/api/MetabasePluginsConfig.md) | Additional mapper function to override or add drill-down menu. See the implementing custom actions section for more details. |+| <a id="renderdrillthroughquestion"></a> `renderDrillThroughQuestion?` | () => [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478) | A custom React component to render the question layout. Use namespaced InteractiveQuestion components to build the layout. |+| <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |+| <a id="token"></a> `token?` | `string` \| `null` | - |+| <a id="withcardtitle"></a> `withCardTitle?` | `boolean` | Whether the dashboard cards should display a title. |+| <a id="withdownloads"></a> `withDownloads?` | `boolean` | Whether to hide the download button. |+| <a id="withsubscriptions"></a> `withSubscriptions?` | `boolean` | Whether to show the subscriptions button. |+| <a id="withtitle"></a> `withTitle?` | `boolean` | Whether the dashboard should display a title. |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/InteractiveDashboard.md b/docs/embedding/sdk/api/snippets/InteractiveDashboard.mdindex f4c94b10270..7b33d2530c7 100644--- a/docs/embedding/sdk/api/snippets/InteractiveDashboard.md+++ b/docs/embedding/sdk/api/snippets/InteractiveDashboard.md@@ -61,9 +61,9 @@ A dashboard component with drill downs, click behaviors, and the ability to view<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- |-| `props` | \{ `autoRefreshInterval?`: `number`; `dashboardId`: [`SdkDashboardId`](./api/SdkDashboardId.md); `drillThroughQuestionHeight?`: `Height`\<`string` \| `number`\>; `drillThroughQuestionProps?`: [`DrillThroughQuestionProps`](./api/DrillThroughQuestionProps.md); `initialParameters?`: [`ParameterValues`](./api/ParameterValues.md); `onParametersChange?`: (`payload`: [`ParameterChangePayload`](./api/ParameterChangePayload.md)) => `void`; `parameters?`: [`ParameterValues`](./api/ParameterValues.md); `plugins?`: [`MetabasePluginsConfig`](./api/MetabasePluginsConfig.md); `renderDrillThroughQuestion?`: () => [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478); \} & \{ `dashboardId?`: [`SdkDashboardId`](./api/SdkDashboardId.md) \| `null`; `token?`: `string` \| `null`; \} & \{ `enableEntityNavigation?`: `boolean`; `hiddenParameters?`: `string`[]; `initialParameters?`: [`ParameterValues`](./api/ParameterValues.md); `withCardTitle?`: `boolean`; `withDownloads?`: `boolean`; `withSubscriptions?`: `boolean`; `withTitle?`: `boolean`; \} & \{ `className?`: `string`; `style?`: [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579); \} & \{ `onLoad?`: (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void`; `onLoadWithoutCards?`: (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void`; `onVisualizationChange?`: (`visualization`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void`; \} & \{ \} | |+| Parameter | Type | Description |+| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- |+| `props` | \{ `autoRefreshInterval?`: `number`; `dashboardId`: [`SdkDashboardId`](/docs/latest/embedding/sdk/api/SdkDashboardId.md); `drillThroughQuestionHeight?`: `Height`\<`string` \| `number`\>; `drillThroughQuestionProps?`: [`DrillThroughQuestionProps`](/docs/latest/embedding/sdk/api/DrillThroughQuestionProps.md); `initialParameters?`: [`ParameterValues`](/docs/latest/embedding/sdk/api/ParameterValues.md); `onParametersChange?`: (`payload`: [`ParameterChangePayload`](/docs/latest/embedding/sdk/api/ParameterChangePayload.md)) => `void`; `parameters?`: [`ParameterValues`](/docs/latest/embedding/sdk/api/ParameterValues.md); `plugins?`: [`MetabasePluginsConfig`](/docs/latest/embedding/sdk/api/MetabasePluginsConfig.md); `renderDrillThroughQuestion?`: () => [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478); \} & \{ `dashboardId?`: [`SdkDashboardId`](/docs/latest/embedding/sdk/api/SdkDashboardId.md) \| `null`; `token?`: `string` \| `null`; \} & \{ `enableEntityNavigation?`: `boolean`; `hiddenParameters?`: `string`[]; `initialParameters?`: [`ParameterValues`](/docs/latest/embedding/sdk/api/ParameterValues.md); `withCardTitle?`: `boolean`; `withDownloads?`: `boolean`; `withSubscriptions?`: `boolean`; `withTitle?`: `boolean`; \} & \{ `className?`: `string`; `style?`: [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579); \} & \{ `onLoad?`: (`dashboard`: [`MetabaseDashboard`](/docs/latest/embedding/sdk/api/MetabaseDashboard.md) \| `null`) => `void`; `onLoadWithoutCards?`: (`dashboard`: [`MetabaseDashboard`](/docs/latest/embedding/sdk/api/MetabaseDashboard.md) \| `null`) => `void`; `onVisualizationChange?`: (`visualization`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void`; \} & \{ \} | |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/InteractiveDashboardProps.md b/docs/embedding/sdk/api/snippets/InteractiveDashboardProps.mdindex a8867f1c9c1..370911260d8 100644--- a/docs/embedding/sdk/api/snippets/InteractiveDashboardProps.md+++ b/docs/embedding/sdk/api/snippets/InteractiveDashboardProps.md@@ -4,28 +4,28 @@<!-- [<snippet properties>] -->-| Property | Type | Description |-| :-------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-| <a id="autorefreshinterval"></a> `autoRefreshInterval?` | `number` | The interval between auto refreshes on the dashboard, in seconds. |-| <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |-| <a id="dashboardid"></a> `dashboardId` | `string` \| `number` | The ID of the dashboard. <br/> This is either: <br/> - the numerical ID when accessing a dashboard link, i.e. `http://localhost:3000/dashboard/1-my-dashboard` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the dashboard object when using the API directly or using the SDK Collection Browser to return data |-| <a id="drillthroughquestionheight"></a> `drillThroughQuestionHeight?` | `Height`\<`string` \| `number`\> | Height of a question component when drilled from the dashboard to a question level. |-| <a id="drillthroughquestionprops"></a> `drillThroughQuestionProps?` | [`DrillThroughQuestionProps`](./api/DrillThroughQuestionProps.md) | Props of a question component when drilled from the dashboard to a question level. |-| <a id="enableentitynavigation"></a> `enableEntityNavigation?` | `boolean` | When true, internal click behaviors (links to dashboards/questions) are preserved. When false (default for SDK), these click behaviors are filtered out. |-| <a id="hiddenparameters"></a> `hiddenParameters?` | `string`[] | A list of [parameters to hide](https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="initialparameters"></a> `initialParameters?` | [`ParameterValues`](./api/ParameterValues.md) | Initial values for query parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value (string for a single option, array of strings for multiple): that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). <br/> <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="onload"></a> `onLoad?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded. |-| <a id="onloadwithoutcards"></a> `onLoadWithoutCards?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded without cards. |-| <a id="onparameterschange"></a> `onParametersChange?` | (`payload`: [`ParameterChangePayload`](./api/ParameterChangePayload.md)) => `void` | Fires on parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |-| <a id="onvisualizationchange"></a> `onVisualizationChange?` | (`visualization`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void` | A callback function that triggers when a question is opened from a dashboard card or when the user changes the visualization type of a question. |-| <a id="parameters"></a> `parameters?` | [`ParameterValues`](./api/ParameterValues.md) | Controlled parameter values, slug-keyed. On every render, this object replaces the dashboard's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with [onParametersChange](./api/InteractiveDashboardProps.md#onparameterschange) to stay in sync with user edits. <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](./api/MetabasePluginsConfig.md) | Additional mapper function to override or add drill-down menu. See the implementing custom actions section for more details. |-| <a id="renderdrillthroughquestion"></a> `renderDrillThroughQuestion?` | () => [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478) | A custom React component to render the question layout. Use namespaced InteractiveQuestion components to build the layout. |-| <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |-| <a id="token"></a> `token?` | `string` \| `null` | - |-| <a id="withcardtitle"></a> `withCardTitle?` | `boolean` | Whether the dashboard cards should display a title. |-| <a id="withdownloads"></a> `withDownloads?` | `boolean` | Whether to hide the download button. |-| <a id="withsubscriptions"></a> `withSubscriptions?` | `boolean` | Whether to show the subscriptions button. |-| <a id="withtitle"></a> `withTitle?` | `boolean` | Whether the dashboard should display a title. |+| Property | Type | Description |+| :-------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| <a id="autorefreshinterval"></a> `autoRefreshInterval?` | `number` | The interval between auto refreshes on the dashboard, in seconds. |+| <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |+| <a id="dashboardid"></a> `dashboardId` | `string` \| `number` | The ID of the dashboard. <br/> This is either: <br/> - the numerical ID when accessing a dashboard link, i.e. `http://localhost:3000/dashboard/1-my-dashboard` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the dashboard object when using the API directly or using the SDK Collection Browser to return data |+| <a id="drillthroughquestionheight"></a> `drillThroughQuestionHeight?` | `Height`\<`string` \| `number`\> | Height of a question component when drilled from the dashboard to a question level. |+| <a id="drillthroughquestionprops"></a> `drillThroughQuestionProps?` | [`DrillThroughQuestionProps`](/docs/latest/embedding/sdk/api/DrillThroughQuestionProps.md) | Props of a question component when drilled from the dashboard to a question level. |+| <a id="enableentitynavigation"></a> `enableEntityNavigation?` | `boolean` | When true, internal click behaviors (links to dashboards/questions) are preserved. When false (default for SDK), these click behaviors are filtered out. |+| <a id="hiddenparameters"></a> `hiddenParameters?` | `string`[] | A list of [parameters to hide](https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters). <br/> - Combining [initialParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="initialparameters"></a> `initialParameters?` | [`ParameterValues`](/docs/latest/embedding/sdk/api/ParameterValues.md) | Initial values for query parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value (string for a single option, array of strings for multiple): that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). <br/> <br/> - Combining [initialParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="onload"></a> `onLoad?` | (`dashboard`: [`MetabaseDashboard`](/docs/latest/embedding/sdk/api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded. |+| <a id="onloadwithoutcards"></a> `onLoadWithoutCards?` | (`dashboard`: [`MetabaseDashboard`](/docs/latest/embedding/sdk/api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded without cards. |+| <a id="onparameterschange"></a> `onParametersChange?` | (`payload`: [`ParameterChangePayload`](/docs/latest/embedding/sdk/api/ParameterChangePayload.md)) => `void` | Fires on parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |+| <a id="onvisualizationchange"></a> `onVisualizationChange?` | (`visualization`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void` | A callback function that triggers when a question is opened from a dashboard card or when the user changes the visualization type of a question. |+| <a id="parameters"></a> `parameters?` | [`ParameterValues`](/docs/latest/embedding/sdk/api/ParameterValues.md) | Controlled parameter values, slug-keyed. On every render, this object replaces the dashboard's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with [onParametersChange](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#onparameterschange) to stay in sync with user edits. <br/> - Combining [parameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [parameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](/docs/latest/embedding/sdk/api/MetabasePluginsConfig.md) | Additional mapper function to override or add drill-down menu. See the implementing custom actions section for more details. |+| <a id="renderdrillthroughquestion"></a> `renderDrillThroughQuestion?` | () => [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478) | A custom React component to render the question layout. Use namespaced InteractiveQuestion components to build the layout. |+| <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |+| <a id="token"></a> `token?` | `string` \| `null` | - |+| <a id="withcardtitle"></a> `withCardTitle?` | `boolean` | Whether the dashboard cards should display a title. |+| <a id="withdownloads"></a> `withDownloads?` | `boolean` | Whether to hide the download button. |+| <a id="withsubscriptions"></a> `withSubscriptions?` | `boolean` | Whether to show the subscriptions button. |+| <a id="withtitle"></a> `withTitle?` | `boolean` | Whether the dashboard should display a title. |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/InteractiveQuestion.md b/docs/embedding/sdk/api/snippets/InteractiveQuestion.mdindex b5610da648a..74d55c2f75f 100644--- a/docs/embedding/sdk/api/snippets/InteractiveQuestion.md+++ b/docs/embedding/sdk/api/snippets/InteractiveQuestion.md@@ -8,9 +8,9 @@ A component that renders an interactive question.<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :-------------------------------------------------------------- | :---------- |-| `props` | [`InteractiveQuestionProps`](./api/InteractiveQuestionProps.md) | |+| Parameter | Type | Description |+| :-------- | :--------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionProps.md) | |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/InteractiveQuestionComponents.md b/docs/embedding/sdk/api/snippets/InteractiveQuestionComponents.mdindex 9fdde7c5360..c319051aa36 100644--- a/docs/embedding/sdk/api/snippets/InteractiveQuestionComponents.md+++ b/docs/embedding/sdk/api/snippets/InteractiveQuestionComponents.md@@ -17,7 +17,7 @@ BackButton: (props: InteractiveQuestionBackButtonProps) =>**`Function`**A navigation button that returns to the previous view.-Only visible when rendered within the [InteractiveDashboardProps.renderDrillThroughQuestion](./api/InteractiveDashboardProps.md#renderdrillthroughquestion) prop.+Only visible when rendered within the [InteractiveDashboardProps.renderDrillThroughQuestion](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#renderdrillthroughquestion) prop.<!-- [<endsnippet ~~backbutton()~~>] -->@@ -25,9 +25,9 @@ Only visible when rendered within the [InteractiveDashboardProps.renderDrillThro<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :---------------------------------------------------------------------------------- | :---------- |-| `props` | [`InteractiveQuestionBackButtonProps`](./api/InteractiveQuestionBackButtonProps.md) | |+| Parameter | Type | Description |+| :-------- | :----------------------------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionBackButtonProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionBackButtonProps.md) | |<!-- [<endsnippet parameters>] -->@@ -98,9 +98,9 @@ Dropdown button for the Breakout component.<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :---------------------------------------------------------------------------------------------- | :---------- |-| `props` | [`InteractiveQuestionBreakoutDropdownProps`](./api/InteractiveQuestionBreakoutDropdownProps.md) | |+| Parameter | Type | Description |+| :-------- | :----------------------------------------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionBreakoutDropdownProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionBreakoutDropdownProps.md) | |<!-- [<endsnippet parameters>] -->@@ -135,9 +135,9 @@ Automatically updates to show recommended visualization types for the current da<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :------------------------------------------------------------------------------------------------ | :---------- |-| `props` | [`InteractiveQuestionChartTypeDropdownProps`](./api/InteractiveQuestionChartTypeDropdownProps.md) | |+| Parameter | Type | Description |+| :-------- | :------------------------------------------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionChartTypeDropdownProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionChartTypeDropdownProps.md) | |<!-- [<endsnippet parameters>] -->@@ -280,9 +280,9 @@ Includes filtering, aggregation, custom expressions, and joins.<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :-------------------------------------------------------------------------- | :---------- |-| `props` | [`InteractiveQuestionEditorProps`](./api/InteractiveQuestionEditorProps.md) | |+| Parameter | Type | Description |+| :-------- | :--------------------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionEditorProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionEditorProps.md) | |<!-- [<endsnippet parameters>] -->@@ -310,7 +310,7 @@ EditorButton: (props: InteractiveQuestionEditorButtonProps) =>**`Function`**Toggle button for showing/hiding the Editor interface.-In custom layouts, the `EditorButton` _must_ have an [InteractiveQuestionEditorButtonProps.onClick](./api/InteractiveQuestionEditorButtonProps.md#onclick)` handler or the button won't do anything when clicked.+In custom layouts, the `EditorButton` _must_ have an [InteractiveQuestionEditorButtonProps.onClick](/docs/latest/embedding/sdk/api/InteractiveQuestionEditorButtonProps.md#onclick)` handler or the button won't do anything when clicked.<!-- [<endsnippet editorbutton()>] -->@@ -318,9 +318,9 @@ In custom layouts, the `EditorButton` _must_ have an [InteractiveQuestionEditorB<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :-------------------------------------------------------------------------------------- | :---------- |-| `props` | [`InteractiveQuestionEditorButtonProps`](./api/InteractiveQuestionEditorButtonProps.md) | |+| Parameter | Type | Description |+| :-------- | :--------------------------------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionEditorButtonProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionEditorButtonProps.md) | |<!-- [<endsnippet parameters>] -->@@ -354,9 +354,9 @@ Displays current filters as badges with an "Add another filter" option.<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :-------------------------------------------------------------------------- | :---------- |-| `props` | [`InteractiveQuestionFilterProps`](./api/InteractiveQuestionFilterProps.md) | |+| Parameter | Type | Description |+| :-------- | :--------------------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionFilterProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionFilterProps.md) | |<!-- [<endsnippet parameters>] -->@@ -390,9 +390,9 @@ A dropdown button for the Filter component.<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :------------------------------------------------------------------------------------------ | :---------- |-| `props` | [`InteractiveQuestionFilterDropdownProps`](./api/InteractiveQuestionFilterDropdownProps.md) | |+| Parameter | Type | Description |+| :-------- | :------------------------------------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionFilterDropdownProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionFilterDropdownProps.md) | |<!-- [<endsnippet parameters>] -->@@ -428,9 +428,9 @@ Includes filtering, aggregation, custom expressions, and joins.<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :-------------------------------------------------------------------------- | :---------- |-| `props` | [`InteractiveQuestionEditorProps`](./api/InteractiveQuestionEditorProps.md) | |+| Parameter | Type | Description |+| :-------- | :--------------------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionEditorProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionEditorProps.md) | |<!-- [<endsnippet parameters>] -->@@ -466,7 +466,7 @@ NotebookButton: (props: InteractiveQuestionEditorButtonProps) =>**`Function`**Toggle button for showing/hiding the Editor interface.-In custom layouts, the `EditorButton` _must_ have an [InteractiveQuestionEditorButtonProps.onClick](./api/InteractiveQuestionEditorButtonProps.md#onclick)` handler or the button won't do anything when clicked.+In custom layouts, the `EditorButton` _must_ have an [InteractiveQuestionEditorButtonProps.onClick](/docs/latest/embedding/sdk/api/InteractiveQuestionEditorButtonProps.md#onclick)` handler or the button won't do anything when clicked.<!-- [<endsnippet ~~notebookbutton()~~>] -->@@ -474,9 +474,9 @@ In custom layouts, the `EditorButton` _must_ have an [InteractiveQuestionEditorB<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :-------------------------------------------------------------------------------------- | :---------- |-| `props` | [`InteractiveQuestionEditorButtonProps`](./api/InteractiveQuestionEditorButtonProps.md) | |+| Parameter | Type | Description |+| :-------- | :--------------------------------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionEditorButtonProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionEditorButtonProps.md) | |<!-- [<endsnippet parameters>] -->@@ -557,9 +557,9 @@ Dropdown button that contains the QuestionSettings component.<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :-------------------------------------------------------------------------------------------------------------- | :---------- |-| `props?` | [`InteractiveQuestionQuestionSettingsDropdownProps`](./api/InteractiveQuestionQuestionSettingsDropdownProps.md) | |+| Parameter | Type | Description |+| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------- | :---------- |+| `props?` | [`InteractiveQuestionQuestionSettingsDropdownProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionQuestionSettingsDropdownProps.md) | |<!-- [<endsnippet parameters>] -->@@ -635,9 +635,9 @@ Button to run the current query. Only appears when automatic reruns are turned o<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :---------------------------------------------------------------------------------------- | :---------- |-| `props?` | [`InteractiveQuestionRefreshButtonProps`](./api/InteractiveQuestionRefreshButtonProps.md) | |+| Parameter | Type | Description |+| :-------- | :----------------------------------------------------------------------------------------------------------------- | :---------- |+| `props?` | [`InteractiveQuestionRefreshButtonProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionRefreshButtonProps.md) | |<!-- [<endsnippet parameters>] -->@@ -672,9 +672,9 @@ Button to reset question modifications. Only appears when there are unsaved chan<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :------------------------------------ | :---------- |-| `props?` | [`ButtonProps`](./api/ButtonProps.md) | |+| Parameter | Type | Description |+| :-------- | :------------------------------------------------------------- | :---------- |+| `props?` | [`ButtonProps`](/docs/latest/embedding/sdk/api/ButtonProps.md) | |<!-- [<endsnippet parameters>] -->@@ -709,9 +709,9 @@ _Note_: Currently, in custom layouts, the `SaveButton` must have an `onClick` ha<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :---------------------------------------------------------------------------------- | :---------- |-| `props?` | [`InteractiveQuestionSaveButtonProps`](./api/InteractiveQuestionSaveButtonProps.md) | |+| Parameter | Type | Description |+| :-------- | :----------------------------------------------------------------------------------------------------------- | :---------- |+| `props?` | [`InteractiveQuestionSaveButtonProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionSaveButtonProps.md) | |<!-- [<endsnippet parameters>] -->@@ -739,9 +739,9 @@ SaveQuestionForm: (props: InteractiveQuestionSaveQuestionFormProps) =>Form for saving a question, including title and description. When saved:-- For existing questions: Calls [SdkQuestionProps.onSave](./api/SdkQuestionProps.md#onsave)+- For existing questions: Calls [SdkQuestionProps.onSave](/docs/latest/embedding/sdk/api/SdkQuestionProps.md#onsave)- Both callbacks receive the updated question object-- Form can be cancelled via the [InteractiveQuestionSaveQuestionFormProps.onCancel](./api/InteractiveQuestionSaveQuestionFormProps.md#oncancel)+- Form can be cancelled via the [InteractiveQuestionSaveQuestionFormProps.onCancel](/docs/latest/embedding/sdk/api/InteractiveQuestionSaveQuestionFormProps.md#oncancel)<!-- [<endsnippet savequestionform()>] -->@@ -749,9 +749,9 @@ Form for saving a question, including title and description. When saved:<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :---------------------------------------------------------------------------------------------- | :---------- |-| `props` | [`InteractiveQuestionSaveQuestionFormProps`](./api/InteractiveQuestionSaveQuestionFormProps.md) | |+| Parameter | Type | Description |+| :-------- | :----------------------------------------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionSaveQuestionFormProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionSaveQuestionFormProps.md) | |<!-- [<endsnippet parameters>] -->@@ -838,9 +838,9 @@ Dropdown button for the Summarize component.<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :------------------------------------------------------------------------------------------------ | :---------- |-| `props` | [`InteractiveQuestionSummarizeDropdownProps`](./api/InteractiveQuestionSummarizeDropdownProps.md) | |+| Parameter | Type | Description |+| :-------- | :------------------------------------------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionSummarizeDropdownProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionSummarizeDropdownProps.md) | |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/InteractiveQuestionProps.md b/docs/embedding/sdk/api/snippets/InteractiveQuestionProps.mdindex 7d5ee7771f4..a2b904b56d5 100644--- a/docs/embedding/sdk/api/snippets/InteractiveQuestionProps.md+++ b/docs/embedding/sdk/api/snippets/InteractiveQuestionProps.md@@ -6,28 +6,28 @@| Property | Type | Description || :---------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-| <a id="card"></a> `card?` | `string` \| [`MetabaseCard`](./api/MetabaseCard.md) | An ad-hoc question to render without saving it first. Either a [MetabaseCard](./api/MetabaseCard.md) object, or a serialized card string copied from a question URL hash (`/question#<base64>` or the bare base64). |+| <a id="card"></a> `card?` | `string` \| [`MetabaseCard`](/docs/latest/embedding/sdk/api/MetabaseCard.md) | An ad-hoc question to render without saving it first. Either a [MetabaseCard](/docs/latest/embedding/sdk/api/MetabaseCard.md) object, or a serialized card string copied from a question URL hash (`/question#<base64>` or the bare base64). || <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |-| <a id="datapicker"></a> `dataPicker?` | [`EmbeddingDataPicker`](./api/EmbeddingDataPicker.md) | Controls the menu for selecting data sources in questions. You can opt for the full data picker by setting `dataPicker = "staged"`. |-| <a id="entitytypes"></a> `entityTypes?` | [`EmbeddingEntityType`](./api/EmbeddingEntityType.md)[] | An array that specifies which entity types are available in the data picker |+| <a id="datapicker"></a> `dataPicker?` | [`EmbeddingDataPicker`](/docs/latest/embedding/sdk/api/EmbeddingDataPicker.md) | Controls the menu for selecting data sources in questions. You can opt for the full data picker by setting `dataPicker = "staged"`. |+| <a id="entitytypes"></a> `entityTypes?` | [`EmbeddingEntityType`](/docs/latest/embedding/sdk/api/EmbeddingEntityType.md)[] | An array that specifies which entity types are available in the data picker || <a id="height"></a> `height?` | `Height`\<`string` \| `number`\> | A number or string specifying a CSS size value that specifies the height of the component || <a id="hiddenparameters"></a> `hiddenParameters?` | `string`[] | A list of parameters to hide. |-| <a id="initialcollection"></a> `initialCollection?` | [`SdkCollectionId`](./api/SdkCollectionId.md) | The collection to preselect in the save modal's collection picker. Unlike `targetCollection`, the picker remains visible and the user can choose a different collection. Ignored when `targetCollection` is set. |-| <a id="initialsqlparameters"></a> `initialSqlParameters?` | [`SqlParameterValues`](./api/SqlParameterValues.md) | Initial values for SQL parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value: that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). |+| <a id="initialcollection"></a> `initialCollection?` | [`SdkCollectionId`](/docs/latest/embedding/sdk/api/SdkCollectionId.md) | The collection to preselect in the save modal's collection picker. Unlike `targetCollection`, the picker remains visible and the user can choose a different collection. Ignored when `targetCollection` is set. |+| <a id="initialsqlparameters"></a> `initialSqlParameters?` | [`SqlParameterValues`](/docs/latest/embedding/sdk/api/SqlParameterValues.md) | Initial values for SQL parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value: that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). || <a id="issaveenabled"></a> `isSaveEnabled?` | `boolean` | Whether to show the save button. |-| <a id="onbeforesave"></a> `onBeforeSave?` | (`question`: [`MetabaseQuestion`](./api/MetabaseQuestion.md) \| `undefined`, `context`: \{ `isNewQuestion`: `boolean`; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | A callback function that triggers before saving. Only relevant when `isSaveEnabled = true` |+| <a id="onbeforesave"></a> `onBeforeSave?` | (`question`: [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md) \| `undefined`, `context`: \{ `isNewQuestion`: `boolean`; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | A callback function that triggers before saving. Only relevant when `isSaveEnabled = true` || <a id="onnavigateback"></a> `onNavigateBack?` | () => `void` | A callback function that triggers when a user clicks the back button. |-| <a id="onrun"></a> `onRun?` | (`question`: [`MetabaseQuestion`](./api/MetabaseQuestion.md) \| `undefined`) => `void` | A callback function that triggers when a question is updated, including when a user clicks the `Visualize` button in the question editor |-| <a id="onsave"></a> `onSave?` | (`question`: [`MetabaseQuestion`](./api/MetabaseQuestion.md), `context`: \{ `dashboardTabId?`: `number`; `isNewQuestion`: `boolean`; \}) => `void` | A callback function that triggers when a user saves the question. Only relevant when `isSaveEnabled = true` |-| <a id="onsqlparameterschange"></a> `onSqlParametersChange?` | (`payload`: [`SqlParameterChangePayload`](./api/SqlParameterChangePayload.md)) => `void` | Fires on SQL parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |+| <a id="onrun"></a> `onRun?` | (`question`: [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md) \| `undefined`) => `void` | A callback function that triggers when a question is updated, including when a user clicks the `Visualize` button in the question editor |+| <a id="onsave"></a> `onSave?` | (`question`: [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md), `context`: \{ `dashboardTabId?`: `number`; `isNewQuestion`: `boolean`; \}) => `void` | A callback function that triggers when a user saves the question. Only relevant when `isSaveEnabled = true` |+| <a id="onsqlparameterschange"></a> `onSqlParametersChange?` | (`payload`: [`SqlParameterChangePayload`](/docs/latest/embedding/sdk/api/SqlParameterChangePayload.md)) => `void` | Fires on SQL parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). || <a id="onvisualizationchange"></a> `onVisualizationChange?` | (`display`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void` | A callback function that triggers when the visualization type changes. |-| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](./api/MetabasePluginsConfig.md) | - |-| <a id="query"></a> `query?` | [`MetabaseQueryObject`](./api/MetabaseQueryObject.md) \| `null` | A table-backed ad hoc query created with `useMetabaseQueryObject`. |-| <a id="questionid"></a> `questionId?` | [`SdkQuestionId`](./api/SdkQuestionId.md) \| `null` | The ID of the question. <br/> This is either: <br/> - the numerical ID when accessing a question link, i.e. `http://localhost:3000/question/1-my-question` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the question object when using the API directly or using the SDK Collection Browser to return data <br/> - `new` to show the notebook editor for creating new questions <br/> - `new-native` to show the SQL editor for creating new native questions |-| <a id="sqlparameters"></a> `sqlParameters?` | [`SqlParameterValues`](./api/SqlParameterValues.md) | Controlled SQL parameter values, slug-keyed. On every render, this object replaces the question's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with `onSqlParametersChange` to stay in sync with user edits. |+| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](/docs/latest/embedding/sdk/api/MetabasePluginsConfig.md) | - |+| <a id="query"></a> `query?` | [`MetabaseQueryObject`](/docs/latest/embedding/sdk/api/MetabaseQueryObject.md) \| `null` | A table-backed ad hoc query created with `useMetabaseQueryObject`. |+| <a id="questionid"></a> `questionId?` | [`SdkQuestionId`](/docs/latest/embedding/sdk/api/SdkQuestionId.md) \| `null` | The ID of the question. <br/> This is either: <br/> - the numerical ID when accessing a question link, i.e. `http://localhost:3000/question/1-my-question` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the question object when using the API directly or using the SDK Collection Browser to return data <br/> - `new` to show the notebook editor for creating new questions <br/> - `new-native` to show the SQL editor for creating new native questions |+| <a id="sqlparameters"></a> `sqlParameters?` | [`SqlParameterValues`](/docs/latest/embedding/sdk/api/SqlParameterValues.md) | Controlled SQL parameter values, slug-keyed. On every render, this object replaces the question's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with `onSqlParametersChange` to stay in sync with user edits. || <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |-| <a id="targetcollection"></a> `targetCollection?` | [`SdkCollectionId`](./api/SdkCollectionId.md) | The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions. |-| <a id="title"></a> `title?` | [`SdkQuestionTitleProps`](./api/SdkQuestionTitleProps.md) | Determines whether the question title is displayed, and allows a custom title to be displayed instead of the default question title. Shown by default. |+| <a id="targetcollection"></a> `targetCollection?` | [`SdkCollectionId`](/docs/latest/embedding/sdk/api/SdkCollectionId.md) | The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions. |+| <a id="title"></a> `title?` | [`SdkQuestionTitleProps`](/docs/latest/embedding/sdk/api/SdkQuestionTitleProps.md) | Determines whether the question title is displayed, and allows a custom title to be displayed instead of the default question title. Shown by default. || <a id="token"></a> `token?` | `string` \| `null` | A valid JWT token for the guest embed. || <a id="width"></a> `width?` | `Width`\<`string` \| `number`\> | A number or string specifying a CSS size value that specifies the width of the component || <a id="withalerts"></a> `withAlerts?` | `boolean` | Enables the ability to set up alerts on the question. |diff --git a/docs/embedding/sdk/api/snippets/MetabaseAuthConfigWithJwt.md b/docs/embedding/sdk/api/snippets/MetabaseAuthConfigWithJwt.mdindex b16e2d0c0f1..80d997f80a8 100644--- a/docs/embedding/sdk/api/snippets/MetabaseAuthConfigWithJwt.md+++ b/docs/embedding/sdk/api/snippets/MetabaseAuthConfigWithJwt.md@@ -24,12 +24,12 @@ type MetabaseAuthConfigWithJwt = {<!-- [<snippet type-declaration>] -->-| Name | Type | Description |-| :--------------------- | :-------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------ |-| `apiKey?` | `never` | - |-| `fetchRequestToken?` | [`MetabaseFetchRequestTokenFn`](./api/MetabaseFetchRequestTokenFn.md) | Specifies a function to fetch the refresh token. The refresh token should be in the format of [UserBackendJwtResponse](./api/UserBackendJwtResponse.md) |-| `isGuest?` | `false` | - |-| `jwtProviderUri?` | `string` | Uri of the jwt provider. If provided the sdk will use jwt and will skip the first `/auth/sso` discovery request. |-| `preferredAuthMethod?` | `"jwt"` | Which authentication method to use. If both SAML and JWT are enabled at the same time, it defaults to SAML unless the preferredAuthMethod is specified. |+| Name | Type | Description |+| :--------------------- | :--------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| `apiKey?` | `never` | - |+| `fetchRequestToken?` | [`MetabaseFetchRequestTokenFn`](/docs/latest/embedding/sdk/api/MetabaseFetchRequestTokenFn.md) | Specifies a function to fetch the refresh token. The refresh token should be in the format of [UserBackendJwtResponse](/docs/latest/embedding/sdk/api/UserBackendJwtResponse.md) |+| `isGuest?` | `false` | - |+| `jwtProviderUri?` | `string` | Uri of the jwt provider. If provided the sdk will use jwt and will skip the first `/auth/sso` discovery request. |+| `preferredAuthMethod?` | `"jwt"` | Which authentication method to use. If both SAML and JWT are enabled at the same time, it defaults to SAML unless the preferredAuthMethod is specified. |<!-- [<endsnippet type-declaration>] -->diff --git a/docs/embedding/sdk/api/snippets/MetabaseClickActionPluginsConfig.md b/docs/embedding/sdk/api/snippets/MetabaseClickActionPluginsConfig.mdindex b2fc8998462..123aba7a0ae 100644--- a/docs/embedding/sdk/api/snippets/MetabaseClickActionPluginsConfig.md+++ b/docs/embedding/sdk/api/snippets/MetabaseClickActionPluginsConfig.md@@ -13,10 +13,10 @@ type MetabaseClickActionPluginsConfig = (<!-- [<snippet parameters>] -->-| Parameter | Type |-| :----------------- | :------------------------------------------------------------ |-| `clickActions` | [`MetabaseClickAction`](./api/MetabaseClickAction.md)[] |-| `clickedDataPoint` | [`MetabaseDataPointObject`](./api/MetabaseDataPointObject.md) |+| Parameter | Type |+| :----------------- | :------------------------------------------------------------------------------------- |+| `clickActions` | [`MetabaseClickAction`](/docs/latest/embedding/sdk/api/MetabaseClickAction.md)[] |+| `clickedDataPoint` | [`MetabaseDataPointObject`](/docs/latest/embedding/sdk/api/MetabaseDataPointObject.md) |<!-- [<endsnippet parameters>] -->@@ -24,7 +24,7 @@ type MetabaseClickActionPluginsConfig = (<!-- [<snippet returns>] -->-\| [`MetabaseClickAction`](./api/MetabaseClickAction.md)[]+\| [`MetabaseClickAction`](/docs/latest/embedding/sdk/api/MetabaseClickAction.md)[]\| \{`onClick`: () => `void`;\}diff --git a/docs/embedding/sdk/api/snippets/MetabaseCollection.md b/docs/embedding/sdk/api/snippets/MetabaseCollection.mdindex fe0fd93ca19..cb901e2a5c5 100644--- a/docs/embedding/sdk/api/snippets/MetabaseCollection.md+++ b/docs/embedding/sdk/api/snippets/MetabaseCollection.md@@ -14,12 +14,12 @@ The Collection entity<!-- [<snippet properties>] -->-| Property | Type |-| :------------------------------------- | :-------------------------------------------- |-| <a id="description"></a> `description` | `string` \| `null` |-| <a id="entity_id"></a> `entity_id?` | [`SdkEntityId`](./api/SdkEntityId.md) |-| <a id="id"></a> `id` | [`SdkCollectionId`](./api/SdkCollectionId.md) |-| <a id="name"></a> `name` | `string` |-| <a id="slug"></a> `slug?` | `string` |+| Property | Type |+| :------------------------------------- | :--------------------------------------------------------------------- |+| <a id="description"></a> `description` | `string` \| `null` |+| <a id="entity_id"></a> `entity_id?` | [`SdkEntityId`](/docs/latest/embedding/sdk/api/SdkEntityId.md) |+| <a id="id"></a> `id` | [`SdkCollectionId`](/docs/latest/embedding/sdk/api/SdkCollectionId.md) |+| <a id="name"></a> `name` | `string` |+| <a id="slug"></a> `slug?` | `string` |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/MetabaseCollectionItem.md b/docs/embedding/sdk/api/snippets/MetabaseCollectionItem.mdindex d4d976e4f5a..766d1b04bb8 100644--- a/docs/embedding/sdk/api/snippets/MetabaseCollectionItem.md+++ b/docs/embedding/sdk/api/snippets/MetabaseCollectionItem.md@@ -41,13 +41,13 @@ The CollectionItem entity| :-------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- || <a id="collection_namespace"></a> `collection_namespace?` | `string` \| `null` || <a id="description"></a> `description` | `string` \| `null` |-| <a id="entity_id"></a> `entity_id?` | [`SdkEntityId`](./api/SdkEntityId.md) |-| <a id="id"></a> `id` | [`SdkCollectionId`](./api/SdkCollectionId.md) |+| <a id="entity_id"></a> `entity_id?` | [`SdkEntityId`](/docs/latest/embedding/sdk/api/SdkEntityId.md) |+| <a id="id"></a> `id` | [`SdkCollectionId`](/docs/latest/embedding/sdk/api/SdkCollectionId.md) || <a id="is_remote_synced"></a> `is_remote_synced?` | `boolean` |-| <a id="last-edit-info"></a> `last-edit-info?` | \{ `email`: `string`; `first_name`: `string` \| `null`; `id`: [`SdkUserId`](./api/SdkUserId.md); `last_name`: `string` \| `null`; `timestamp`: `string`; \} |+| <a id="last-edit-info"></a> `last-edit-info?` | \{ `email`: `string`; `first_name`: `string` \| `null`; `id`: [`SdkUserId`](/docs/latest/embedding/sdk/api/SdkUserId.md); `last_name`: `string` \| `null`; `timestamp`: `string`; \} || `last-edit-info.email` | `string` || `last-edit-info.first_name` | `string` \| `null` |-| `last-edit-info.id` | [`SdkUserId`](./api/SdkUserId.md) |+| `last-edit-info.id` | [`SdkUserId`](/docs/latest/embedding/sdk/api/SdkUserId.md) || `last-edit-info.last_name` | `string` \| `null` || `last-edit-info.timestamp` | `string` || <a id="model"></a> `model` | `string` |diff --git a/docs/embedding/sdk/api/snippets/MetabaseColors.md b/docs/embedding/sdk/api/snippets/MetabaseColors.mdindex c9b63fd5e09..0adf0dbb8bd 100644--- a/docs/embedding/sdk/api/snippets/MetabaseColors.md+++ b/docs/embedding/sdk/api/snippets/MetabaseColors.md@@ -2,30 +2,30 @@<!-- [<snippet properties>] -->-| Property | Type | Description |-| :-------------------------------------------------------- | :------------------------------------ | :-------------------------------------------------------------------------------------- |-| <a id="background"></a> `background?` | `string` | Default background color. |-| <a id="background-disabled"></a> `background-disabled?` | `string` | Muted background color used for disabled elements, such as disabled buttons and inputs. |-| <a id="background-error"></a> `background-error?` | `string` | Color used for error backgrounds. Defaults to light red. |-| <a id="background-hover"></a> `background-hover?` | `string` | Slightly darker background color used for hover and accented elements. |-| <a id="background-light"></a> `background-light?` | `string` | Light background color used for some controls like a radiogroup. |-| <a id="background-secondary"></a> `background-secondary?` | `string` | Slightly muted background color. |-| <a id="border"></a> `border?` | `string` | Color used for borders |-| <a id="brand"></a> `brand?` | `string` | Primary brand color used for buttons and links |-| <a id="brand-hover"></a> `brand-hover?` | `string` | Lighter variation of the brand color. Used for hover and accented elements. |-| <a id="brand-hover-light"></a> `brand-hover-light?` | `string` | Lightest variation of the brand color. Used for hover and accented elements. |-| <a id="charts"></a> `charts?` | [`ChartColor`](./api/ChartColor.md)[] | Chart colors |-| <a id="error"></a> `error?` | `string` | Color used for error icons and borders. Defaults to red. |-| <a id="filter"></a> `filter?` | `string` | Color used for filters context |-| <a id="focus"></a> `focus?` | `string` | Color used to outline elements in focus |-| <a id="negative"></a> `negative?` | `string` | Color used to indicate dangerous actions and negative values/trends |-| <a id="positive"></a> `positive?` | `string` | Color used to indicate successful actions and positive values/trends |-| <a id="shadow"></a> `shadow?` | `string` | Color used for popover shadows |-| <a id="summarize"></a> `summarize?` | `string` | Color used for aggregations and breakouts context |-| <a id="text-hover"></a> `text-hover?` | `string` | Color used for some button text on hover |-| <a id="text-primary"></a> `text-primary?` | `string` | Text color on dark elements. Should be a lighter color for readability. |-| <a id="text-secondary"></a> `text-secondary?` | `string` | Lighter variation of dark text on light elements. |-| <a id="text-tertiary"></a> `text-tertiary?` | `string` | Text color on light elements. Should be a darker color for readability. |-| <a id="text-white"></a> `text-white?` | `string` | Color used for white text |+| Property | Type | Description |+| :-------------------------------------------------------- | :------------------------------------------------------------- | :-------------------------------------------------------------------------------------- |+| <a id="background"></a> `background?` | `string` | Default background color. |+| <a id="background-disabled"></a> `background-disabled?` | `string` | Muted background color used for disabled elements, such as disabled buttons and inputs. |+| <a id="background-error"></a> `background-error?` | `string` | Color used for error backgrounds. Defaults to light red. |+| <a id="background-hover"></a> `background-hover?` | `string` | Slightly darker background color used for hover and accented elements. |+| <a id="background-light"></a> `background-light?` | `string` | Light background color used for some controls like a radiogroup. |+| <a id="background-secondary"></a> `background-secondary?` | `string` | Slightly muted background color. |+| <a id="border"></a> `border?` | `string` | Color used for borders |+| <a id="brand"></a> `brand?` | `string` | Primary brand color used for buttons and links |+| <a id="brand-hover"></a> `brand-hover?` | `string` | Lighter variation of the brand color. Used for hover and accented elements. |+| <a id="brand-hover-light"></a> `brand-hover-light?` | `string` | Lightest variation of the brand color. Used for hover and accented elements. |+| <a id="charts"></a> `charts?` | [`ChartColor`](/docs/latest/embedding/sdk/api/ChartColor.md)[] | Chart colors |+| <a id="error"></a> `error?` | `string` | Color used for error icons and borders. Defaults to red. |+| <a id="filter"></a> `filter?` | `string` | Color used for filters context |+| <a id="focus"></a> `focus?` | `string` | Color used to outline elements in focus |+| <a id="negative"></a> `negative?` | `string` | Color used to indicate dangerous actions and negative values/trends |+| <a id="positive"></a> `positive?` | `string` | Color used to indicate successful actions and positive values/trends |+| <a id="shadow"></a> `shadow?` | `string` | Color used for popover shadows |+| <a id="summarize"></a> `summarize?` | `string` | Color used for aggregations and breakouts context |+| <a id="text-hover"></a> `text-hover?` | `string` | Color used for some button text on hover |+| <a id="text-primary"></a> `text-primary?` | `string` | Text color on dark elements. Should be a lighter color for readability. |+| <a id="text-secondary"></a> `text-secondary?` | `string` | Lighter variation of dark text on light elements. |+| <a id="text-tertiary"></a> `text-tertiary?` | `string` | Text color on light elements. Should be a darker color for readability. |+| <a id="text-white"></a> `text-white?` | `string` | Color used for white text |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/MetabaseDashboard.md b/docs/embedding/sdk/api/snippets/MetabaseDashboard.mdindex 9e69f680c7a..9f6a7156d51 100644--- a/docs/embedding/sdk/api/snippets/MetabaseDashboard.md+++ b/docs/embedding/sdk/api/snippets/MetabaseDashboard.md@@ -25,11 +25,11 @@ The Dashboard entity| Property | Type || :------------------------------------------- | :------------------------------------------------------------------------------------------------------------- |-| <a id="collection"></a> `collection?` | [`MetabaseCollection`](./api/MetabaseCollection.md) \| `null` |+| <a id="collection"></a> `collection?` | [`MetabaseCollection`](/docs/latest/embedding/sdk/api/MetabaseCollection.md) \| `null` || <a id="created_at"></a> `created_at` | `string` || <a id="description"></a> `description` | `string` \| `null` |-| <a id="entity_id"></a> `entity_id` | [`SdkEntityId`](./api/SdkEntityId.md) |-| <a id="id"></a> `id` | [`SdkDashboardId`](./api/SdkDashboardId.md) |+| <a id="entity_id"></a> `entity_id` | [`SdkEntityId`](/docs/latest/embedding/sdk/api/SdkEntityId.md) |+| <a id="id"></a> `id` | [`SdkDashboardId`](/docs/latest/embedding/sdk/api/SdkDashboardId.md) || <a id="last-edit-info"></a> `last-edit-info` | \{ `email`: `string`; `first_name`: `string`; `id`: `number`; `last_name`: `string`; `timestamp`: `string`; \} || `last-edit-info.email` | `string` || `last-edit-info.first_name` | `string` |diff --git a/docs/embedding/sdk/api/snippets/MetabaseDashboardPluginsConfig.md b/docs/embedding/sdk/api/snippets/MetabaseDashboardPluginsConfig.mdindex e6bb282d5a0..39aaed5b80a 100644--- a/docs/embedding/sdk/api/snippets/MetabaseDashboardPluginsConfig.md+++ b/docs/embedding/sdk/api/snippets/MetabaseDashboardPluginsConfig.md@@ -8,8 +8,8 @@ type MetabaseDashboardPluginsConfig = {<!-- [<snippet properties>] -->-| Property | Type |-| :-------------------------------------------------- | :------------------------------------------------ |-| <a id="dashboardcardmenu"></a> `dashboardCardMenu?` | [`DashboardCardMenu`](./api/DashboardCardMenu.md) |+| Property | Type |+| :-------------------------------------------------- | :------------------------------------------------------------------------- |+| <a id="dashboardcardmenu"></a> `dashboardCardMenu?` | [`DashboardCardMenu`](/docs/latest/embedding/sdk/api/DashboardCardMenu.md) |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/MetabaseDataPointObject.md b/docs/embedding/sdk/api/snippets/MetabaseDataPointObject.mdindex 8906b29622b..8c9d78e1cec 100644--- a/docs/embedding/sdk/api/snippets/MetabaseDataPointObject.md+++ b/docs/embedding/sdk/api/snippets/MetabaseDataPointObject.md@@ -31,7 +31,7 @@ type MetabaseDataPointObject = {| `column.name?` | `string` || <a id="data"></a> `data?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string` \| `number` \| `null` \| `boolean` \| `object`\> || <a id="event"></a> `event?` | [`MouseEvent`](https://developer.mozilla.org/docs/Web/API/MouseEvent) |-| <a id="question"></a> `question?` | [`MetabaseQuestion`](./api/MetabaseQuestion.md) |+| <a id="question"></a> `question?` | [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md) || <a id="raw"></a> `raw?` | \{ `column?`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>; `data?`: \{ `col`: \| [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\> \| `null`; `value`: `string` \| `number` \| `null` \| `boolean`; \}[]; `event?`: [`MouseEvent`](https://developer.mozilla.org/docs/Web/API/MouseEvent); `value?`: `string` \| `number` \| `null` \| `boolean`; \} || `raw.column?` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\> || `raw.data?` | \{ `col`: \| [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\> \| `null`; `value`: `string` \| `number` \| `null` \| `boolean`; \}[] |diff --git a/docs/embedding/sdk/api/snippets/MetabaseEmbeddingThemeV2.md b/docs/embedding/sdk/api/snippets/MetabaseEmbeddingThemeV2.mdindex 5eb8401c801..190769aa7f6 100644--- a/docs/embedding/sdk/api/snippets/MetabaseEmbeddingThemeV2.md+++ b/docs/embedding/sdk/api/snippets/MetabaseEmbeddingThemeV2.md@@ -6,7 +6,7 @@ Version 2 theme configuration for embedded Metabase components.| Property | Type | Description || :-------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------ |-| <a id="chartcolors"></a> `chartColors?` | [`ChartColorV2`](./api/ChartColorV2.md)[] | Chart colors overrides. Each color can be a string or an object with base/tint/shade. |+| <a id="chartcolors"></a> `chartColors?` | [`ChartColorV2`](/docs/latest/embedding/sdk/api/ChartColorV2.md)[] | Chart colors overrides. Each color can be a string or an object with base/tint/shade. || <a id="colors"></a> `colors?` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\< \| `"accent-gray"` \| `"accent-gray-dark"` \| `"accent-gray-light"` \| `"accent0-dark"` \| `"accent0-light"` \| `"accent1-dark"` \| `"accent1-light"` \| `"accent2-dark"` \| `"accent2-light"` \| `"accent3-dark"` \| `"accent3-light"` \| `"accent4-dark"` \| `"accent4-light"` \| `"accent5-dark"` \| `"accent5-light"` \| `"accent6-dark"` \| `"accent6-light"` \| `"accent7-dark"` \| `"accent7-light"` \| `"background_page-filter"` \| `"background_page-highlighted"` \| `"background_page-primary"` \| `"background_page-primary-inverse"` \| `"background_page-secondary"` \| `"background_page-secondary-inverse"` \| `"background_page-tertiary"` \| `"background_page-tertiary-inverse"` \| `"background_surface-brand-strong"` \| `"background_surface-brand-strong-hover"` \| `"background_surface-brand-strong-pressed"` \| `"background_surface-brand-subtle"` \| `"background_surface-brand-subtle-hover"` \| `"background_surface-brand-subtle-pressed"` \| `"background_surface-disabled"` \| `"background_surface-disabled-inverse"` \| `"background_surface-error"` \| `"background_surface-error-subtle"` \| `"background_surface-hover"` \| `"background_surface-primary"` \| `"background_surface-primary-hover"` \| `"background_surface-primary-inverse"` \| `"background_surface-primary-inverse-hover"` \| `"background_surface-primary-inverse-pressed"` \| `"background_surface-primary-pressed"` \| `"background_surface-secondary"` \| `"background_surface-secondary-hover"` \| `"background_surface-secondary-inverse"` \| `"background_surface-secondary-inverse-hover"` \| `"background_surface-secondary-inverse-pressed"` \| `"background_surface-secondary-pressed"` \| `"background_surface-selected"` \| `"background_surface-success"` \| `"background_surface-warning"` \| `"background_surface-warning-strong"` \| `"border-brand"` \| `"border-filter"` \| `"border-highlight"` \| `"border-neutral"` \| `"border-neutral-inverse-strong"` \| `"border-neutral-strong"` \| `"border-neutral-strongest"` \| `"border-neutral-subtle"` \| `"border-on_dark"` \| `"button-default-neutral-default"` \| `"button-default-neutral-hover"` \| `"button-default-neutral-pressed"` \| `"button-filled-brand-default"` \| `"button-filled-brand-hover"` \| `"button-filled-brand-pressed"` \| `"button-filled-filter-default"` \| `"button-filled-filter-hover"` \| `"button-filled-filter-pressed"` \| `"button-filled-negative-default"` \| `"button-filled-negative-hover"` \| `"button-filled-negative-pressed"` \| `"button-filled-positive-default"` \| `"button-filled-positive-hover"` \| `"button-filled-positive-pressed"` \| `"button-filled-warning-default"` \| `"button-filled-warning-hover"` \| `"button-filled-warning-pressed"` \| `"button-light-brand-default"` \| `"button-light-brand-hover"` \| `"button-light-brand-pressed"` \| `"button-light-filter-default"` \| `"button-light-filter-hover"` \| `"button-light-filter-pressed"` \| `"button-light-negative-default"` \| `"button-light-negative-hover"` \| `"button-light-negative-pressed"` \| `"button-light-neutral-default"` \| `"button-light-neutral-hover"` \| `"button-light-neutral-pressed"` \| `"button-light-positive-default"` \| `"button-light-positive-hover"` \| `"button-light-positive-pressed"` \| `"button-on_dark-disabled"` \| `"button-on_dark_primary-negative-default"` \| `"button-on_dark_primary-negative-hover"` \| `"button-on_dark_primary-negative-pressed"` \| `"button-on_dark_primary-neutral-default"` \| `"button-on_dark_primary-neutral-hover"` \| `"button-on_dark_primary-neutral-pressed"` \| `"button-on_dark_secondary-negative-default"` \| `"button-on_dark_secondary-negative-hover"` \| `"button-on_dark_secondary-negative-pressed"` \| `"button-on_dark_secondary-neutral-default"` \| `"button-on_dark_secondary-neutral-hover"` \| `"button-on_dark_secondary-neutral-pressed"` \| `"button-subtle-brand-default"` \| `"button-subtle-brand-hover"` \| `"button-subtle-brand-pressed"` \| `"button-subtle-negative-default"` \| `"button-subtle-negative-hover"` \| `"button-subtle-negative-pressed"` \| `"button-subtle-neutral-default"` \| `"button-subtle-neutral-hover"` \| `"button-subtle-neutral-pressed"` \| `"button-subtle-positive-default"` \| `"button-subtle-positive-hover"` \| `"button-subtle-positive-pressed"` \| `"button-subtle-warning-default"` \| `"button-subtle-warning-hover"` \| `"button-subtle-warning-pressed"` \| `"button_label-default-neutral-default"` \| `"button_label-filled-brand-default"` \| `"button_label-filled-filter-default"` \| `"button_label-filled-negative-default"` \| `"button_label-filled-positive-default"` \| `"button_label-filled-warning-default"` \| `"button_label-light-brand-default"` \| `"button_label-light-brand-hover"` \| `"button_label-light-filter-default"` \| `"button_label-light-filter-hover"` \| `"button_label-light-negative-default"` \| `"button_label-light-negative-hover"` \| `"button_label-light-neutral-default"` \| `"button_label-light-positive-default"` \| `"button_label-light-positive-hover"` \| `"button_label-on_dark-disabled"` \| `"button_label-on_dark_primary-negative-default"` \| `"button_label-on_dark_primary-neutral-default"` \| `"button_label-on_dark_secondary-negative-default"` \| `"button_label-on_dark_secondary-neutral-default"` \| `"button_label-subtle-brand-default"` \| `"button_label-subtle-brand-hover"` \| `"button_label-subtle-negative-default"` \| `"button_label-subtle-negative-hover"` \| `"button_label-subtle-neutral-default"` \| `"button_label-subtle-positive-default"` \| `"button_label-subtle-positive-hover"` \| `"button_label-subtle-warning-default"` \| `"button_label-subtle-warning-hover"` \| `"chart-axis"` \| `"core-blue-saturated"` \| `"core-brand"` \| `"core-brand-hover"` \| `"core-filter"` \| `"core-filter-strong"` \| `"core-gold"` \| `"core-green-saturated"` \| `"core-info"` \| `"core-purple-saturated"` \| `"core-red-saturated"` \| `"core-summarize"` \| `"core-white"` \| `"core-white_constant"` \| `"core-yellow-saturated"` \| `"feedback-negative"` \| `"feedback-negative-strong"` \| `"feedback-neutral-strong"` \| `"feedback-positive"` \| `"feedback-positive-selected"` \| `"feedback-positive-strong"` \| `"feedback-warning"` \| `"feedback-warning-strong"` \| `"icon-brand"` \| `"icon-brand-inverse"` \| `"icon-disabled"` \| `"icon-disabled-inverse"` \| `"icon-primary"` \| `"icon-primary-inverse"` \| `"icon-secondary"` \| `"icon-secondary-inverse"` \| `"illustration-secondary-brand"` \| `"illustration-tertiary-brand"` \| `"input-background"` \| `"input-focus"` \| `"modal-border"` \| `"modal-overlay"` \| `"segmented_control-hover"` \| `"segmented_control-pressed"` \| `"segmented_control-selected"` \| `"shadow-default"` \| `"switch-checked"` \| `"switch-disabled"` \| `"switch-unchecked"` \| `"switch_thumb-disabled"` \| `"text-brand"` \| `"text-brand-hover"` \| `"text-brand-strong"` \| `"text-brand-strong-hover"` \| `"text-disabled"` \| `"text-disabled-inverse"` \| `"text-filter"` \| `"text-primary"` \| `"text-primary-inverse"` \| `"text-secondary"` \| `"text-secondary-inverse"` \| `"text-secondary-opaque"` \| `"text-selected"` \| `"text-syntax-parameter"` \| `"text-syntax-parameter-active"` \| `"tooltip-background"` \| `"tooltip-background-focused"` \| `"tooltip-text"` \| `"tooltip-text-secondary"`, `string`\>\> | Color overrides. || <a id="version"></a> `version` | `2` | Theme version must be 2 for version 2 themes. |diff --git a/docs/embedding/sdk/api/snippets/MetabasePluginsConfig.md b/docs/embedding/sdk/api/snippets/MetabasePluginsConfig.mdindex 99bdc49c876..53bd6766e3a 100644--- a/docs/embedding/sdk/api/snippets/MetabasePluginsConfig.md+++ b/docs/embedding/sdk/api/snippets/MetabasePluginsConfig.md@@ -9,9 +9,9 @@ type MetabasePluginsConfig = {<!-- [<snippet properties>] -->-| Property | Type |-| :-------------------------------------------------------------- | :------------------------------------------------------------------------------ |-| <a id="dashboard"></a> `dashboard?` | [`MetabaseDashboardPluginsConfig`](./api/MetabaseDashboardPluginsConfig.md) |-| <a id="mapquestionclickactions"></a> `mapQuestionClickActions?` | [`MetabaseClickActionPluginsConfig`](./api/MetabaseClickActionPluginsConfig.md) |+| Property | Type |+| :-------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------- |+| <a id="dashboard"></a> `dashboard?` | [`MetabaseDashboardPluginsConfig`](/docs/latest/embedding/sdk/api/MetabaseDashboardPluginsConfig.md) |+| <a id="mapquestionclickactions"></a> `mapQuestionClickActions?` | [`MetabaseClickActionPluginsConfig`](/docs/latest/embedding/sdk/api/MetabaseClickActionPluginsConfig.md) |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/MetabaseProvider.md b/docs/embedding/sdk/api/snippets/MetabaseProvider.mdindex 2288dd6c271..4f8da5919fa 100644--- a/docs/embedding/sdk/api/snippets/MetabaseProvider.md+++ b/docs/embedding/sdk/api/snippets/MetabaseProvider.md@@ -8,9 +8,9 @@ A component that provides the Metabase SDK context and theme.<!-- [<snippet parameters>] -->-| Parameter | Type |-| :-------- | :-------------------------------------------------------- |-| `props` | [`MetabaseProviderProps`](./api/MetabaseProviderProps.md) |+| Parameter | Type |+| :-------- | :--------------------------------------------------------------------------------- |+| `props` | [`MetabaseProviderProps`](/docs/latest/embedding/sdk/api/MetabaseProviderProps.md) |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/MetabaseProviderProps.md b/docs/embedding/sdk/api/snippets/MetabaseProviderProps.mdindex 027bdee3147..65c0c4f6142 100644--- a/docs/embedding/sdk/api/snippets/MetabaseProviderProps.md+++ b/docs/embedding/sdk/api/snippets/MetabaseProviderProps.md@@ -8,16 +8,16 @@| :---------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- || <a id="allowconsolelog"></a> `allowConsoleLog?` | `boolean` | Whether to allow logging to the DevTools console. Defaults to true. || <a id="allowedcustomvisualizations"></a> `allowedCustomVisualizations?` | `` `custom:${string}` ``[] | Opt-in support for EE custom visualization plugins inside the SDK. Pass an allowlist of `custom:`-prefixed plugin identifiers (manifest `name`), e.g. `["custom:Thumbs", "custom:Calendar"]`. Only listed plugins are loaded. Omit or pass `[]` to disable. Requires the `custom-viz` premium feature. |-| <a id="authconfig"></a> `authConfig` | [`MetabaseAuthConfig`](./api/MetabaseAuthConfig.md) | Defines how to authenticate with Metabase. |+| <a id="authconfig"></a> `authConfig` | [`MetabaseAuthConfig`](/docs/latest/embedding/sdk/api/MetabaseAuthConfig.md) | Defines how to authenticate with Metabase. || <a id="children"></a> `children` | [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478) | The children of the MetabaseProvider component. || <a id="classname"></a> ~~`className?`~~ | `string` | A custom class name to be added to the root element. **Deprecated** This prop is not used anymore. || <a id="customvisualizationssandboxurl"></a> `customVisualizationsSandboxUrl?` | `string` | URL of an empty HTML page that custom visualizations run in. Use it when your page's Content Security Policy does not allow `'unsafe-eval'`. The page must be served from the same origin as your app, with its own `Content-Security-Policy: default-src 'none'; script-src 'unsafe-eval'`. |-| <a id="errorcomponent"></a> `errorComponent?` | [`SdkErrorComponent`](./api/SdkErrorComponent.md) | A custom error component to display when the SDK encounters an error. |-| <a id="eventhandlers"></a> `eventHandlers?` | [`SdkEventHandlersConfig`](./api/SdkEventHandlersConfig.md) | See [Handle embed events](https://www.metabase.com/docs/latest/embedding/config#handle-embed-events-react-sdk-only). |+| <a id="errorcomponent"></a> `errorComponent?` | [`SdkErrorComponent`](/docs/latest/embedding/sdk/api/SdkErrorComponent.md) | A custom error component to display when the SDK encounters an error. |+| <a id="eventhandlers"></a> `eventHandlers?` | [`SdkEventHandlersConfig`](/docs/latest/embedding/sdk/api/SdkEventHandlersConfig.md) | See [Handle embed events](https://www.metabase.com/docs/latest/embedding/config#handle-embed-events-react-sdk-only). || <a id="loadercomponent"></a> `loaderComponent?` | [`ComponentType`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L104)\<\{ `label?`: `string`; \}\> | A custom loader component to display while the SDK is loading. The component receives an optional `label` prop that can be used to display a loading message. || <a id="locale"></a> `locale?` | `string` | Defines the display language. Accepts an ISO language code such as `en` or `de`. Defaults to the instance locale. |-| <a id="pluginsconfig"></a> `pluginsConfig?` | [`MetabaseGlobalPluginsConfig`](./api/MetabaseGlobalPluginsConfig.md) | See [Plugins](https://www.metabase.com/docs/latest/embedding/sdk/plugins). |-| <a id="theme"></a> `theme?` | [`MetabaseEmbeddingTheme`](./api/MetabaseEmbeddingTheme.md) | See [Appearance](https://www.metabase.com/docs/latest/embedding/appearance). |+| <a id="pluginsconfig"></a> `pluginsConfig?` | [`MetabaseGlobalPluginsConfig`](/docs/latest/embedding/sdk/api/MetabaseGlobalPluginsConfig.md) | See [Plugins](https://www.metabase.com/docs/latest/embedding/sdk/plugins). |+| <a id="theme"></a> `theme?` | [`MetabaseEmbeddingTheme`](/docs/latest/embedding/sdk/api/MetabaseEmbeddingTheme.md) | See [Appearance](https://www.metabase.com/docs/latest/embedding/appearance). || <a id="uselegacymonolithicbundle"></a> `useLegacyMonolithicBundle?` | `boolean` | Whether to load the full SDK bundle directly as a single file (legacy behavior), instead of the optimized bootstrap that loads chunks in parallel and starts authentication early. Defaults to false (uses the optimized bootstrap loader). |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/MetabaseTheme.md b/docs/embedding/sdk/api/snippets/MetabaseTheme.mdindex bc4a31f5924..7d4e89fdee1 100644--- a/docs/embedding/sdk/api/snippets/MetabaseTheme.md+++ b/docs/embedding/sdk/api/snippets/MetabaseTheme.md@@ -6,7 +6,7 @@ Theme configuration for embedded Metabase components.| Property | Type | Description || :---------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-| <a id="colors"></a> `colors?` | [`MetabaseColors`](./api/MetabaseColors.md) | Color palette |+| <a id="colors"></a> `colors?` | [`MetabaseColors`](/docs/latest/embedding/sdk/api/MetabaseColors.md) | Color palette || <a id="components"></a> `components?` | \{ `cartesian?`: \{ `goalLine?`: \{ `label?`: \{ `fontSize?`: `string`; \}; \}; `label?`: \{ `fontSize?`: `string`; \}; `padding?`: `string`; `splitLine?`: \{ `lineStyle?`: \{ `color?`: `string`; \}; \}; \}; `collectionBrowser?`: \{ `breadcrumbs?`: \{ `expandButton?`: \{ `backgroundColor?`: `string`; `hoverBackgroundColor?`: `string`; `hoverTextColor?`: `string`; `textColor?`: `string`; \}; \}; `emptyContent?`: \{ `icon?`: \{ `height?`: `Width`\<... \| ...\>; `width?`: `Width`\<... \| ...\>; \}; `subtitle?`: \{ `fontSize?`: `FontSize`\<... \| ...\>; \}; `title?`: \{ `fontSize?`: `FontSize`\<... \| ...\>; \}; \}; \}; `dashboard?`: \{ `backgroundColor?`: `string`; `card?`: \{ `backgroundColor?`: `string`; `border?`: `string`; \}; `gridBorderColor?`: `string`; \}; `number?`: \{ `value?`: \{ `fontSize?`: `FontSize`\<`string` \| `number`\>; `lineHeight?`: `string`; \}; \}; `pivotTable?`: \{ `cell?`: \{ `fontSize?`: `string`; \}; `rowToggle?`: \{ `backgroundColor?`: `string`; `textColor?`: `string`; \}; \}; `popover?`: \{ `zIndex?`: `number`; \}; `question?`: \{ `backgroundColor?`: `string`; `toolbar?`: \{ `backgroundColor?`: `string`; \}; \}; `table?`: \{ `cell?`: \{ `backgroundColor?`: `string`; `fontSize?`: `string`; `textColor?`: `string`; \}; `idColumn?`: \{ `backgroundColor?`: `string`; `textColor`: `string`; \}; `stickyBackgroundColor?`: `string`; `stripedBackgroundColor?`: `string`; \}; `tooltip?`: \{ `backgroundColor?`: `string`; `focusedBackgroundColor?`: `string`; `secondaryTextColor?`: `string`; `textColor?`: `string`; \}; \} | Component theme options || `components.cartesian?` | \{ `goalLine?`: \{ `label?`: \{ `fontSize?`: `string`; \}; \}; `label?`: \{ `fontSize?`: `string`; \}; `padding?`: `string`; `splitLine?`: \{ `lineStyle?`: \{ `color?`: `string`; \}; \}; \} | Cartesian charts || `components.cartesian.goalLine?` | \{ `label?`: \{ `fontSize?`: `string`; \}; \} | - |@@ -70,9 +70,9 @@ Theme configuration for embedded Metabase components.| `components.tooltip.focusedBackgroundColor?` | `string` | Tooltip background color for focused rows. || `components.tooltip.secondaryTextColor?` | `string` | Secondary text color shown in the tooltip, e.g. for tooltip headers and percentage changes. || `components.tooltip.textColor?` | `string` | Tooltip text color. |-| <a id="fontfamily"></a> `fontFamily?` | \| `string` & \{ \} \| [`MetabaseFontFamily`](./api/MetabaseFontFamily.md) | Font family that will be used for all text, it defaults to the instance's default font. |+| <a id="fontfamily"></a> `fontFamily?` | \| `string` & \{ \} \| [`MetabaseFontFamily`](/docs/latest/embedding/sdk/api/MetabaseFontFamily.md) | Font family that will be used for all text, it defaults to the instance's default font. || <a id="fontsize"></a> `fontSize?` | `string` | Base font size. Supported units are px, em and rem. Defaults to ~14px (0.875em) || <a id="lineheight"></a> `lineHeight?` | `string` \| `number` | Base line height |-| <a id="preset"></a> `preset?` | [`MetabaseThemePreset`](./api/MetabaseThemePreset.md) | Predefined theme preset to use as a base. |+| <a id="preset"></a> `preset?` | [`MetabaseThemePreset`](/docs/latest/embedding/sdk/api/MetabaseThemePreset.md) | Predefined theme preset to use as a base. |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/MetabaseUser.md b/docs/embedding/sdk/api/snippets/MetabaseUser.mdindex 52fba4db665..731b2da0b03 100644--- a/docs/embedding/sdk/api/snippets/MetabaseUser.md+++ b/docs/embedding/sdk/api/snippets/MetabaseUser.md@@ -18,16 +18,16 @@ The User entity<!-- [<snippet properties>] -->-| Property | Type |-| :------------------------------------- | :-------------------------------- |-| <a id="common_name"></a> `common_name` | `string` |-| <a id="date_joined"></a> `date_joined` | `string` |-| <a id="email"></a> `email` | `string` |-| <a id="first_login"></a> `first_login` | `string` |-| <a id="first_name"></a> `first_name` | `string` \| `null` |-| <a id="id"></a> `id` | [`SdkUserId`](./api/SdkUserId.md) |-| <a id="last_login"></a> `last_login` | `string` |-| <a id="last_name"></a> `last_name` | `string` \| `null` |-| <a id="locale"></a> `locale` | `string` \| `null` |+| Property | Type |+| :------------------------------------- | :--------------------------------------------------------- |+| <a id="common_name"></a> `common_name` | `string` |+| <a id="date_joined"></a> `date_joined` | `string` |+| <a id="email"></a> `email` | `string` |+| <a id="first_login"></a> `first_login` | `string` |+| <a id="first_name"></a> `first_name` | `string` \| `null` |+| <a id="id"></a> `id` | [`SdkUserId`](/docs/latest/embedding/sdk/api/SdkUserId.md) |+| <a id="last_login"></a> `last_login` | `string` |+| <a id="last_name"></a> `last_name` | `string` \| `null` |+| <a id="locale"></a> `locale` | `string` \| `null` |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/MetabotAgentChartMessage.md b/docs/embedding/sdk/api/snippets/MetabotAgentChartMessage.mdindex 563bd2321cb..d269c856007 100644--- a/docs/embedding/sdk/api/snippets/MetabotAgentChartMessage.md+++ b/docs/embedding/sdk/api/snippets/MetabotAgentChartMessage.md@@ -12,12 +12,12 @@ type MetabotAgentChartMessage = {<!-- [<snippet properties>] -->-| Property | Type | Description |-| :--------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------- |-| <a id="chart"></a> `Chart` | [`React_2.ComponentType`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L104)\<[`MetabotChartProps`](./api/MetabotChartProps.md)\> | A pre-wired React component that renders the chart. |-| <a id="id"></a> `id` | `string` | - |-| <a id="questionpath"></a> `questionPath` | `string` | URL path to the question, e.g. `/question#<base64>` |-| <a id="role"></a> `role` | `"agent"` | - |-| <a id="type"></a> `type` | `"chart"` | - |+| Property | Type | Description |+| :--------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :-------------------------------------------------- |+| <a id="chart"></a> `Chart` | [`React_2.ComponentType`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L104)\<[`MetabotChartProps`](/docs/latest/embedding/sdk/api/MetabotChartProps.md)\> | A pre-wired React component that renders the chart. |+| <a id="id"></a> `id` | `string` | - |+| <a id="questionpath"></a> `questionPath` | `string` | URL path to the question, e.g. `/question#<base64>` |+| <a id="role"></a> `role` | `"agent"` | - |+| <a id="type"></a> `type` | `"chart"` | - |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/MetabotQuestion.md b/docs/embedding/sdk/api/snippets/MetabotQuestion.mdindex 23b1b616810..6f49c40d07b 100644--- a/docs/embedding/sdk/api/snippets/MetabotQuestion.md+++ b/docs/embedding/sdk/api/snippets/MetabotQuestion.md@@ -8,9 +8,9 @@ A component that renders a metabot question.<!-- [<snippet parameters>] -->-| Parameter | Type |-| :-------- | :------------------------------------------------------ |-| `props` | [`MetabotQuestionProps`](./api/MetabotQuestionProps.md) |+| Parameter | Type |+| :-------- | :------------------------------------------------------------------------------- |+| `props` | [`MetabotQuestionProps`](/docs/latest/embedding/sdk/api/MetabotQuestionProps.md) |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/MetabotQuestionProps.md b/docs/embedding/sdk/api/snippets/MetabotQuestionProps.mdindex aaddbf58970..533a577cbff 100644--- a/docs/embedding/sdk/api/snippets/MetabotQuestionProps.md+++ b/docs/embedding/sdk/api/snippets/MetabotQuestionProps.md@@ -21,7 +21,7 @@ Props for the MetabotQuestion component.| <a id="issaveenabled"></a> `isSaveEnabled?` | `boolean` | Whether to show the save button. || <a id="layout"></a> `layout?` | `"auto"` \| `"sidebar"` \| `"stacked"` | Layout for the MetabotQuestion component. - `auto` (default): Metabot uses the `stacked` layout on mobile screens, and a `sidebar` layout on larger screens. - `stacked`: the question visualization stacks on top of the chat interface. - `sidebar`: the question visualization appears to the left of the chat interface, which is on a sidebar on the right. || <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |-| <a id="targetcollection"></a> `targetCollection?` | [`SdkCollectionId`](./api/SdkCollectionId.md) | The collection to save the question to. This will hide the collection picker from the save modal. |+| <a id="targetcollection"></a> `targetCollection?` | [`SdkCollectionId`](/docs/latest/embedding/sdk/api/SdkCollectionId.md) | The collection to save the question to. This will hide the collection picker from the save modal. || <a id="width"></a> `width?` | `Width`\<`string` \| `number`\> | A number or string specifying a CSS size value that specifies the width of the component |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/ParameterChangePayload.md b/docs/embedding/sdk/api/snippets/ParameterChangePayload.mdindex 17174e35e74..ea285efe5c9 100644--- a/docs/embedding/sdk/api/snippets/ParameterChangePayload.md+++ b/docs/embedding/sdk/api/snippets/ParameterChangePayload.md@@ -13,11 +13,11 @@ Payload passed to `onParametersChange` callback<!-- [<snippet properties>] -->-| Property | Type |-| :--------------------------------------------------- | :-------------------------------------------------------- |-| <a id="defaultparameters"></a> `defaultParameters` | [`ParameterValues`](./api/ParameterValues.md) |-| <a id="lastusedparameters"></a> `lastUsedParameters` | [`ParameterValues`](./api/ParameterValues.md) |-| <a id="parameters"></a> `parameters` | [`ParameterValues`](./api/ParameterValues.md) |-| <a id="source"></a> `source` | [`ParameterChangeSource`](./api/ParameterChangeSource.md) |+| Property | Type |+| :--------------------------------------------------- | :--------------------------------------------------------------------------------- |+| <a id="defaultparameters"></a> `defaultParameters` | [`ParameterValues`](/docs/latest/embedding/sdk/api/ParameterValues.md) |+| <a id="lastusedparameters"></a> `lastUsedParameters` | [`ParameterValues`](/docs/latest/embedding/sdk/api/ParameterValues.md) |+| <a id="parameters"></a> `parameters` | [`ParameterValues`](/docs/latest/embedding/sdk/api/ParameterValues.md) |+| <a id="source"></a> `source` | [`ParameterChangeSource`](/docs/latest/embedding/sdk/api/ParameterChangeSource.md) |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/QueryData.md b/docs/embedding/sdk/api/snippets/QueryData.mdindex 70ca43feae7..94c2d51282f 100644--- a/docs/embedding/sdk/api/snippets/QueryData.md+++ b/docs/embedding/sdk/api/snippets/QueryData.md@@ -42,16 +42,16 @@ RowValues<!-- [<snippet properties>] -->-| Property | Type |-| :-------------------------------------- | :--------------------------------------------------------------------------------- |-| <a id="columns"></a> `columns` | `DatasetColumn`[] |-| <a id="description"></a> `description?` | [`QueryQuestionResult`](./api/QueryQuestionResult.md)\[`"description"`\] |-| <a id="entityid"></a> `entityId?` | \| [`QueryQuestionResult`](./api/QueryQuestionResult.md)\[`"entityId"`\] \| `null` |-| <a id="id"></a> `id?` | [`QueryQuestionResult`](./api/QueryQuestionResult.md)\[`"id"`\] \| `null` |-| <a id="name"></a> `name?` | \| [`QueryQuestionResult`](./api/QueryQuestionResult.md)\[`"name"`\] \| `null` |-| <a id="rawrows"></a> `rawRows` | `RowValues`[] |-| <a id="rowcount"></a> `rowCount` | `number` \| `null` |-| <a id="rows"></a> `rows` | `TRow`[] |-| <a id="runningtime"></a> `runningTime` | `number` \| `null` |+| Property | Type |+| :-------------------------------------- | :---------------------------------------------------------------------------------------------------------- |+| <a id="columns"></a> `columns` | `DatasetColumn`[] |+| <a id="description"></a> `description?` | [`QueryQuestionResult`](/docs/latest/embedding/sdk/api/QueryQuestionResult.md)\[`"description"`\] |+| <a id="entityid"></a> `entityId?` | \| [`QueryQuestionResult`](/docs/latest/embedding/sdk/api/QueryQuestionResult.md)\[`"entityId"`\] \| `null` |+| <a id="id"></a> `id?` | [`QueryQuestionResult`](/docs/latest/embedding/sdk/api/QueryQuestionResult.md)\[`"id"`\] \| `null` |+| <a id="name"></a> `name?` | \| [`QueryQuestionResult`](/docs/latest/embedding/sdk/api/QueryQuestionResult.md)\[`"name"`\] \| `null` |+| <a id="rawrows"></a> `rawRows` | `RowValues`[] |+| <a id="rowcount"></a> `rowCount` | `number` \| `null` |+| <a id="rows"></a> `rows` | `TRow`[] |+| <a id="runningtime"></a> `runningTime` | `number` \| `null` |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/QueryQuestionResult.md b/docs/embedding/sdk/api/snippets/QueryQuestionResult.mdindex 6a52d2acbb7..7815c638c8e 100644--- a/docs/embedding/sdk/api/snippets/QueryQuestionResult.md+++ b/docs/embedding/sdk/api/snippets/QueryQuestionResult.md@@ -15,15 +15,15 @@ type QueryQuestionResult = {<!-- [<snippet properties>] -->-| Property | Type |-| :------------------------------------- | :----------------------------------------------------------------- |-| <a id="columns"></a> `columns` | `DatasetColumn`[] |-| <a id="description"></a> `description` | [`MetabaseQuestion`](./api/MetabaseQuestion.md)\[`"description"`\] |-| <a id="entityid"></a> `entityId` | [`MetabaseQuestion`](./api/MetabaseQuestion.md)\[`"entityId"`\] |-| <a id="id"></a> `id` | [`MetabaseQuestion`](./api/MetabaseQuestion.md)\[`"id"`\] |-| <a id="name"></a> `name` | [`MetabaseQuestion`](./api/MetabaseQuestion.md)\[`"name"`\] |-| <a id="rowcount"></a> `rowCount` | `number` \| `null` |-| <a id="rows"></a> `rows` | `RowValues`[] |-| <a id="runningtime"></a> `runningTime` | `number` \| `null` |+| Property | Type |+| :------------------------------------- | :------------------------------------------------------------------------------------------ |+| <a id="columns"></a> `columns` | `DatasetColumn`[] |+| <a id="description"></a> `description` | [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md)\[`"description"`\] |+| <a id="entityid"></a> `entityId` | [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md)\[`"entityId"`\] |+| <a id="id"></a> `id` | [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md)\[`"id"`\] |+| <a id="name"></a> `name` | [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md)\[`"name"`\] |+| <a id="rowcount"></a> `rowCount` | `number` \| `null` |+| <a id="rows"></a> `rows` | `RowValues`[] |+| <a id="runningtime"></a> `runningTime` | `number` \| `null` |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/SchemaColumn.md b/docs/embedding/sdk/api/snippets/SchemaColumn.mdindex 4ed42f1273e..57da696c5c8 100644--- a/docs/embedding/sdk/api/snippets/SchemaColumn.md+++ b/docs/embedding/sdk/api/snippets/SchemaColumn.md@@ -14,14 +14,14 @@ type SchemaColumn = {<!-- [<snippet properties>] -->-| Property | Type |-| :------------------------------------------ | :------------------------------------------------------ |-| <a id="basetype"></a> `baseType?` | `string` |-| <a id="description"></a> `description?` | `string` |-| <a id="displayname"></a> `displayName?` | `string` |-| <a id="effectivetype"></a> `effectiveType?` | `string` |-| <a id="jstype"></a> `jsType?` | [`SchemaJavaScriptType`](./api/SchemaJavaScriptType.md) |-| <a id="name"></a> `name` | `string` |-| <a id="type"></a> `type?` | `"column"` |+| Property | Type |+| :------------------------------------------ | :------------------------------------------------------------------------------- |+| <a id="basetype"></a> `baseType?` | `string` |+| <a id="description"></a> `description?` | `string` |+| <a id="displayname"></a> `displayName?` | `string` |+| <a id="effectivetype"></a> `effectiveType?` | `string` |+| <a id="jstype"></a> `jsType?` | [`SchemaJavaScriptType`](/docs/latest/embedding/sdk/api/SchemaJavaScriptType.md) |+| <a id="name"></a> `name` | `string` |+| <a id="type"></a> `type?` | `"column"` |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/SchemaRow.md b/docs/embedding/sdk/api/snippets/SchemaRow.mdindex d935fe4193c..c79a3d13b6c 100644--- a/docs/embedding/sdk/api/snippets/SchemaRow.md+++ b/docs/embedding/sdk/api/snippets/SchemaRow.md@@ -8,9 +8,9 @@ type SchemaRow<TSchema> = {<!-- [<snippet type-parameters>] -->-| Type Parameter |-| :--------------------------------------------------------------------------------------- |-| `TSchema` _extends_ \{ `columns`: readonly [`SchemaColumn`](./api/SchemaColumn.md)[]; \} |+| Type Parameter |+| :---------------------------------------------------------------------------------------------------------------- |+| `TSchema` _extends_ \{ `columns`: readonly [`SchemaColumn`](/docs/latest/embedding/sdk/api/SchemaColumn.md)[]; \} |<!-- [<endsnippet type-parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/SdkActionDefinition.md b/docs/embedding/sdk/api/snippets/SdkActionDefinition.mdindex 71397d1e241..8694773f4a6 100644--- a/docs/embedding/sdk/api/snippets/SdkActionDefinition.md+++ b/docs/embedding/sdk/api/snippets/SdkActionDefinition.md@@ -16,10 +16,10 @@ instead, so an app works before its resources are written.<!-- [<snippet properties>] -->-| Property | Type |-| :-------------------------------------------------------- | :------------------------------------------------- |-| <a id="action"></a> `action` | \{ `id`: [`SdkActionId`](./api/SdkActionId.md); \} |-| `action.id` | [`SdkActionId`](./api/SdkActionId.md) |-| <a id="copiedactionentityid"></a> `copiedActionEntityId?` | [`SdkEntityId`](./api/SdkEntityId.md) |+| Property | Type |+| :-------------------------------------------------------- | :-------------------------------------------------------------------------- |+| <a id="action"></a> `action` | \{ `id`: [`SdkActionId`](/docs/latest/embedding/sdk/api/SdkActionId.md); \} |+| `action.id` | [`SdkActionId`](/docs/latest/embedding/sdk/api/SdkActionId.md) |+| <a id="copiedactionentityid"></a> `copiedActionEntityId?` | [`SdkEntityId`](/docs/latest/embedding/sdk/api/SdkEntityId.md) |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/SdkDashboardEntityPublicProps.md b/docs/embedding/sdk/api/snippets/SdkDashboardEntityPublicProps.mdindex 63c7675f9d0..d837ae0d5f0 100644--- a/docs/embedding/sdk/api/snippets/SdkDashboardEntityPublicProps.md+++ b/docs/embedding/sdk/api/snippets/SdkDashboardEntityPublicProps.md@@ -21,10 +21,10 @@ type SdkDashboardEntityPublicProps =}```-| Name | Type | Description |-| :------------ | :---------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-| `dashboardId` | [`SdkDashboardId`](./api/SdkDashboardId.md) \| `null` | The ID of the dashboard. <br/> This is either: <br/> - the numerical ID when accessing a dashboard link, i.e. `http://localhost:3000/dashboard/1-my-dashboard` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the dashboard object when using the API directly or using the SDK Collection Browser to return data |-| `token?` | `never` | - |+| Name | Type | Description |+| :------------ | :----------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| `dashboardId` | [`SdkDashboardId`](/docs/latest/embedding/sdk/api/SdkDashboardId.md) \| `null` | The ID of the dashboard. <br/> This is either: <br/> - the numerical ID when accessing a dashboard link, i.e. `http://localhost:3000/dashboard/1-my-dashboard` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the dashboard object when using the API directly or using the SDK Collection Browser to return data |+| `token?` | `never` | - |```ts{@@ -33,9 +33,9 @@ type SdkDashboardEntityPublicProps =}```-| Name | Type | Description |-| :------------- | :---------------------------------------------------- | :------------------------------------- |-| `dashboardId?` | `never` | - |-| `token` | [`SdkEntityToken`](./api/SdkEntityToken.md) \| `null` | A valid JWT token for the guest embed. |+| Name | Type | Description |+| :------------- | :----------------------------------------------------------------------------- | :------------------------------------- |+| `dashboardId?` | `never` | - |+| `token` | [`SdkEntityToken`](/docs/latest/embedding/sdk/api/SdkEntityToken.md) \| `null` | A valid JWT token for the guest embed. |<!-- [<endsnippet type-declaration>] -->diff --git a/docs/embedding/sdk/api/snippets/SdkDashboardLoadEvent.md b/docs/embedding/sdk/api/snippets/SdkDashboardLoadEvent.mdindex 3c57d1e1fe8..8b62ae25baa 100644--- a/docs/embedding/sdk/api/snippets/SdkDashboardLoadEvent.md+++ b/docs/embedding/sdk/api/snippets/SdkDashboardLoadEvent.md@@ -6,9 +6,9 @@ type SdkDashboardLoadEvent = (dashboard: MetabaseDashboard | null) => void;<!-- [<snippet parameters>] -->-| Parameter | Type |-| :---------- | :---------------------------------------------------------- |-| `dashboard` | [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null` |+| Parameter | Type |+| :---------- | :----------------------------------------------------------------------------------- |+| `dashboard` | [`MetabaseDashboard`](/docs/latest/embedding/sdk/api/MetabaseDashboard.md) \| `null` |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/SdkErrorComponent.md b/docs/embedding/sdk/api/snippets/SdkErrorComponent.mdindex e8a283286bb..8436987de8b 100644--- a/docs/embedding/sdk/api/snippets/SdkErrorComponent.md+++ b/docs/embedding/sdk/api/snippets/SdkErrorComponent.md@@ -10,9 +10,9 @@ type SdkErrorComponent = ({<!-- [<snippet parameters>] -->-| Parameter | Type |-| :-------------------------- | :---------------------------------------------------------- |-| `{ type, message, error, }` | [`SdkErrorComponentProps`](./api/SdkErrorComponentProps.md) |+| Parameter | Type |+| :-------------------------- | :----------------------------------------------------------------------------------- |+| `{ type, message, error, }` | [`SdkErrorComponentProps`](/docs/latest/embedding/sdk/api/SdkErrorComponentProps.md) |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/SdkEventHandlersConfig.md b/docs/embedding/sdk/api/snippets/SdkEventHandlersConfig.mdindex e40e11072d0..2cb1c3f8049 100644--- a/docs/embedding/sdk/api/snippets/SdkEventHandlersConfig.md+++ b/docs/embedding/sdk/api/snippets/SdkEventHandlersConfig.md@@ -9,9 +9,9 @@ type SdkEventHandlersConfig = {<!-- [<snippet properties>] -->-| Property | Type | Description |-| :---------------------------------------------------------------------- | :-------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-| <a id="ondashboardload"></a> `onDashboardLoad?` | [`SdkDashboardLoadEvent`](./api/SdkDashboardLoadEvent.md) | Triggers when a dashboard loads with all visible cards and their content |-| <a id="ondashboardloadwithoutcards"></a> `onDashboardLoadWithoutCards?` | [`SdkDashboardLoadEvent`](./api/SdkDashboardLoadEvent.md) | Triggers after a dashboard loads, but without its cards (at this stage only the dashboard title, tabs, and cards grid are rendered, but the contents of the cards have yet to load. |+| Property | Type | Description |+| :---------------------------------------------------------------------- | :--------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| <a id="ondashboardload"></a> `onDashboardLoad?` | [`SdkDashboardLoadEvent`](/docs/latest/embedding/sdk/api/SdkDashboardLoadEvent.md) | Triggers when a dashboard loads with all visible cards and their content |+| <a id="ondashboardloadwithoutcards"></a> `onDashboardLoadWithoutCards?` | [`SdkDashboardLoadEvent`](/docs/latest/embedding/sdk/api/SdkDashboardLoadEvent.md) | Triggers after a dashboard loads, but without its cards (at this stage only the dashboard title, tabs, and cards grid are rendered, but the contents of the cards have yet to load. |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/SdkQuestionEntityPublicProps.md b/docs/embedding/sdk/api/snippets/SdkQuestionEntityPublicProps.mdindex d1b02b2a43e..a3fa699abb5 100644--- a/docs/embedding/sdk/api/snippets/SdkQuestionEntityPublicProps.md+++ b/docs/embedding/sdk/api/snippets/SdkQuestionEntityPublicProps.md@@ -39,12 +39,12 @@ type SdkQuestionEntityPublicProps =}```-| Name | Type | Description |-| :----------- | :-------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-| `card?` | `never` | - |-| `query?` | `never` | - |-| `questionId` | [`SdkQuestionId`](./api/SdkQuestionId.md) \| `null` | The ID of the question. <br/> This is either: <br/> - the numerical ID when accessing a question link, i.e. `http://localhost:3000/question/1-my-question` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the question object when using the API directly or using the SDK Collection Browser to return data <br/> - `new` to show the notebook editor for creating new questions <br/> - `new-native` to show the SQL editor for creating new native questions |-| `token?` | `never` | - |+| Name | Type | Description |+| :----------- | :--------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| `card?` | `never` | - |+| `query?` | `never` | - |+| `questionId` | [`SdkQuestionId`](/docs/latest/embedding/sdk/api/SdkQuestionId.md) \| `null` | The ID of the question. <br/> This is either: <br/> - the numerical ID when accessing a question link, i.e. `http://localhost:3000/question/1-my-question` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the question object when using the API directly or using the SDK Collection Browser to return data <br/> - `new` to show the notebook editor for creating new questions <br/> - `new-native` to show the SQL editor for creating new native questions |+| `token?` | `never` | - |```ts{@@ -55,12 +55,12 @@ type SdkQuestionEntityPublicProps =}```-| Name | Type | Description |-| :------------ | :---------------------------------------------------- | :------------------------------------- |-| `card?` | `never` | - |-| `query?` | `never` | - |-| `questionId?` | `never` | - |-| `token` | [`SdkEntityToken`](./api/SdkEntityToken.md) \| `null` | A valid JWT token for the guest embed. |+| Name | Type | Description |+| :------------ | :----------------------------------------------------------------------------- | :------------------------------------- |+| `card?` | `never` | - |+| `query?` | `never` | - |+| `questionId?` | `never` | - |+| `token` | [`SdkEntityToken`](/docs/latest/embedding/sdk/api/SdkEntityToken.md) \| `null` | A valid JWT token for the guest embed. |```ts{@@ -71,12 +71,12 @@ type SdkQuestionEntityPublicProps =}```-| Name | Type | Description |-| :------------ | :-------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |-| `card` | `string` \| [`MetabaseCard`](./api/MetabaseCard.md) | An ad-hoc question to render without saving it first. Either a [MetabaseCard](./api/MetabaseCard.md) object, or a serialized card string copied from a question URL hash (`/question#<base64>` or the bare base64). |-| `query?` | `never` | - |-| `questionId?` | `never` | - |-| `token?` | `never` | - |+| Name | Type | Description |+| :------------ | :--------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| `card` | `string` \| [`MetabaseCard`](/docs/latest/embedding/sdk/api/MetabaseCard.md) | An ad-hoc question to render without saving it first. Either a [MetabaseCard](/docs/latest/embedding/sdk/api/MetabaseCard.md) object, or a serialized card string copied from a question URL hash (`/question#<base64>` or the bare base64). |+| `query?` | `never` | - |+| `questionId?` | `never` | - |+| `token?` | `never` | - |```ts{@@ -87,11 +87,11 @@ type SdkQuestionEntityPublicProps =}```-| Name | Type | Description |-| :------------ | :-------------------------------------------------------------- | :----------------------------------------------------------------- |-| `card?` | `never` | - |-| `query` | [`MetabaseQueryObject`](./api/MetabaseQueryObject.md) \| `null` | A table-backed ad hoc query created with `useMetabaseQueryObject`. |-| `questionId?` | `never` | - |-| `token?` | `never` | - |+| Name | Type | Description |+| :------------ | :--------------------------------------------------------------------------------------- | :----------------------------------------------------------------- |+| `card?` | `never` | - |+| `query` | [`MetabaseQueryObject`](/docs/latest/embedding/sdk/api/MetabaseQueryObject.md) \| `null` | A table-backed ad hoc query created with `useMetabaseQueryObject`. |+| `questionId?` | `never` | - |+| `token?` | `never` | - |<!-- [<endsnippet type-declaration>] -->diff --git a/docs/embedding/sdk/api/snippets/SdkQuestionProps.md b/docs/embedding/sdk/api/snippets/SdkQuestionProps.mdindex 878d6b1a7d7..f5030787041 100644--- a/docs/embedding/sdk/api/snippets/SdkQuestionProps.md+++ b/docs/embedding/sdk/api/snippets/SdkQuestionProps.md@@ -7,25 +7,25 @@| Property | Type | Description || :---------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- || <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |-| <a id="datapicker"></a> `dataPicker?` | [`EmbeddingDataPicker`](./api/EmbeddingDataPicker.md) | Controls the menu for selecting data sources in questions. You can opt for the full data picker by setting `dataPicker = "staged"`. |-| <a id="entitytypes"></a> `entityTypes?` | [`EmbeddingEntityType`](./api/EmbeddingEntityType.md)[] | An array that specifies which entity types are available in the data picker |+| <a id="datapicker"></a> `dataPicker?` | [`EmbeddingDataPicker`](/docs/latest/embedding/sdk/api/EmbeddingDataPicker.md) | Controls the menu for selecting data sources in questions. You can opt for the full data picker by setting `dataPicker = "staged"`. |+| <a id="entitytypes"></a> `entityTypes?` | [`EmbeddingEntityType`](/docs/latest/embedding/sdk/api/EmbeddingEntityType.md)[] | An array that specifies which entity types are available in the data picker || <a id="height"></a> `height?` | `Height`\<`string` \| `number`\> | A number or string specifying a CSS size value that specifies the height of the component || <a id="hiddenparameters"></a> `hiddenParameters?` | `string`[] | A list of parameters to hide. |-| <a id="initialcollection"></a> `initialCollection?` | [`SdkCollectionId`](./api/SdkCollectionId.md) | The collection to preselect in the save modal's collection picker. Unlike `targetCollection`, the picker remains visible and the user can choose a different collection. Ignored when `targetCollection` is set. |-| <a id="initialsqlparameters"></a> `initialSqlParameters?` | [`SqlParameterValues`](./api/SqlParameterValues.md) | Initial values for SQL parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value: that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). |+| <a id="initialcollection"></a> `initialCollection?` | [`SdkCollectionId`](/docs/latest/embedding/sdk/api/SdkCollectionId.md) | The collection to preselect in the save modal's collection picker. Unlike `targetCollection`, the picker remains visible and the user can choose a different collection. Ignored when `targetCollection` is set. |+| <a id="initialsqlparameters"></a> `initialSqlParameters?` | [`SqlParameterValues`](/docs/latest/embedding/sdk/api/SqlParameterValues.md) | Initial values for SQL parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value: that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). || <a id="issaveenabled"></a> `isSaveEnabled?` | `boolean` | Whether to show the save button. |-| <a id="onbeforesave"></a> `onBeforeSave?` | (`question`: [`MetabaseQuestion`](./api/MetabaseQuestion.md) \| `undefined`, `context`: \{ `isNewQuestion`: `boolean`; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | A callback function that triggers before saving. Only relevant when `isSaveEnabled = true` |+| <a id="onbeforesave"></a> `onBeforeSave?` | (`question`: [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md) \| `undefined`, `context`: \{ `isNewQuestion`: `boolean`; \}) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | A callback function that triggers before saving. Only relevant when `isSaveEnabled = true` || <a id="onnavigateback"></a> `onNavigateBack?` | () => `void` | A callback function that triggers when a user clicks the back button. |-| <a id="onrun"></a> `onRun?` | (`question`: [`MetabaseQuestion`](./api/MetabaseQuestion.md) \| `undefined`) => `void` | A callback function that triggers when a question is updated, including when a user clicks the `Visualize` button in the question editor |-| <a id="onsave"></a> `onSave?` | (`question`: [`MetabaseQuestion`](./api/MetabaseQuestion.md), `context`: \{ `dashboardTabId?`: `number`; `isNewQuestion`: `boolean`; \}) => `void` | A callback function that triggers when a user saves the question. Only relevant when `isSaveEnabled = true` |-| <a id="onsqlparameterschange"></a> `onSqlParametersChange?` | (`payload`: [`SqlParameterChangePayload`](./api/SqlParameterChangePayload.md)) => `void` | Fires on SQL parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |+| <a id="onrun"></a> `onRun?` | (`question`: [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md) \| `undefined`) => `void` | A callback function that triggers when a question is updated, including when a user clicks the `Visualize` button in the question editor |+| <a id="onsave"></a> `onSave?` | (`question`: [`MetabaseQuestion`](/docs/latest/embedding/sdk/api/MetabaseQuestion.md), `context`: \{ `dashboardTabId?`: `number`; `isNewQuestion`: `boolean`; \}) => `void` | A callback function that triggers when a user saves the question. Only relevant when `isSaveEnabled = true` |+| <a id="onsqlparameterschange"></a> `onSqlParametersChange?` | (`payload`: [`SqlParameterChangePayload`](/docs/latest/embedding/sdk/api/SqlParameterChangePayload.md)) => `void` | Fires on SQL parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). || <a id="onvisualizationchange"></a> `onVisualizationChange?` | (`display`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void` | A callback function that triggers when the visualization type changes. |-| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](./api/MetabasePluginsConfig.md) | - |-| <a id="questionid"></a> `questionId?` | [`SdkQuestionId`](./api/SdkQuestionId.md) \| `null` | - |-| <a id="sqlparameters"></a> `sqlParameters?` | [`SqlParameterValues`](./api/SqlParameterValues.md) | Controlled SQL parameter values, slug-keyed. On every render, this object replaces the question's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with `onSqlParametersChange` to stay in sync with user edits. |+| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](/docs/latest/embedding/sdk/api/MetabasePluginsConfig.md) | - |+| <a id="questionid"></a> `questionId?` | [`SdkQuestionId`](/docs/latest/embedding/sdk/api/SdkQuestionId.md) \| `null` | - |+| <a id="sqlparameters"></a> `sqlParameters?` | [`SqlParameterValues`](/docs/latest/embedding/sdk/api/SqlParameterValues.md) | Controlled SQL parameter values, slug-keyed. On every render, this object replaces the question's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with `onSqlParametersChange` to stay in sync with user edits. || <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |-| <a id="targetcollection"></a> `targetCollection?` | [`SdkCollectionId`](./api/SdkCollectionId.md) | The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions. |-| <a id="title"></a> `title?` | [`SdkQuestionTitleProps`](./api/SdkQuestionTitleProps.md) | Determines whether the question title is displayed, and allows a custom title to be displayed instead of the default question title. Shown by default. |+| <a id="targetcollection"></a> `targetCollection?` | [`SdkCollectionId`](/docs/latest/embedding/sdk/api/SdkCollectionId.md) | The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions. |+| <a id="title"></a> `title?` | [`SdkQuestionTitleProps`](/docs/latest/embedding/sdk/api/SdkQuestionTitleProps.md) | Determines whether the question title is displayed, and allows a custom title to be displayed instead of the default question title. Shown by default. || <a id="token"></a> `token?` | `string` \| `null` | - || <a id="width"></a> `width?` | `Width`\<`string` \| `number`\> | A number or string specifying a CSS size value that specifies the width of the component || <a id="withalerts"></a> `withAlerts?` | `boolean` | Enables the ability to set up alerts on the question. |diff --git a/docs/embedding/sdk/api/snippets/SqlParameterChangePayload.md b/docs/embedding/sdk/api/snippets/SqlParameterChangePayload.mdindex ba38f310ea4..72230bd53db 100644--- a/docs/embedding/sdk/api/snippets/SqlParameterChangePayload.md+++ b/docs/embedding/sdk/api/snippets/SqlParameterChangePayload.md@@ -12,10 +12,10 @@ Payload passed to `onSqlParametersChange` callback<!-- [<snippet properties>] -->-| Property | Type |-| :------------------------------------------------- | :-------------------------------------------------------------- |-| <a id="defaultparameters"></a> `defaultParameters` | [`ParameterValues`](./api/ParameterValues.md) |-| <a id="parameters"></a> `parameters` | [`ParameterValues`](./api/ParameterValues.md) |-| <a id="source"></a> `source` | [`SqlParameterChangeSource`](./api/SqlParameterChangeSource.md) |+| Property | Type |+| :------------------------------------------------- | :--------------------------------------------------------------------------------------- |+| <a id="defaultparameters"></a> `defaultParameters` | [`ParameterValues`](/docs/latest/embedding/sdk/api/ParameterValues.md) |+| <a id="parameters"></a> `parameters` | [`ParameterValues`](/docs/latest/embedding/sdk/api/ParameterValues.md) |+| <a id="source"></a> `source` | [`SqlParameterChangeSource`](/docs/latest/embedding/sdk/api/SqlParameterChangeSource.md) |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/StaticDashboard.md b/docs/embedding/sdk/api/snippets/StaticDashboard.mdindex 1342256ac54..b08ae3fb154 100644--- a/docs/embedding/sdk/api/snippets/StaticDashboard.md+++ b/docs/embedding/sdk/api/snippets/StaticDashboard.md@@ -8,9 +8,9 @@ A lightweight dashboard component.<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :------------------------------------------------------ | :---------- |-| `props` | [`StaticDashboardProps`](./api/StaticDashboardProps.md) | |+| Parameter | Type | Description |+| :-------- | :------------------------------------------------------------------------------- | :---------- |+| `props` | [`StaticDashboardProps`](/docs/latest/embedding/sdk/api/StaticDashboardProps.md) | |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/StaticDashboardProps.md b/docs/embedding/sdk/api/snippets/StaticDashboardProps.mdindex 689202c00d9..04488423216 100644--- a/docs/embedding/sdk/api/snippets/StaticDashboardProps.md+++ b/docs/embedding/sdk/api/snippets/StaticDashboardProps.md@@ -4,24 +4,24 @@<!-- [<snippet properties>] -->-| Property | Type | Description |-| :---------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-| <a id="autorefreshinterval"></a> `autoRefreshInterval?` | `number` | The interval between auto refreshes on the dashboard, in seconds. |-| <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |-| <a id="dashboardid"></a> `dashboardId?` | [`SdkDashboardId`](./api/SdkDashboardId.md) \| `null` | The ID of the dashboard. <br/> This is either: <br/> - the numerical ID when accessing a dashboard link, i.e. `http://localhost:3000/dashboard/1-my-dashboard` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the dashboard object when using the API directly or using the SDK Collection Browser to return data |-| <a id="hiddenparameters"></a> `hiddenParameters?` | `string`[] | A list of [parameters to hide](https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="initialparameters"></a> `initialParameters?` | [`ParameterValues`](./api/ParameterValues.md) | Initial values for query parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value (string for a single option, array of strings for multiple): that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). <br/> <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="onload"></a> `onLoad?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded. |-| <a id="onloadwithoutcards"></a> `onLoadWithoutCards?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded without cards. |-| <a id="onparameterschange"></a> `onParametersChange?` | (`payload`: [`ParameterChangePayload`](./api/ParameterChangePayload.md)) => `void` | Fires on parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |-| <a id="onvisualizationchange"></a> `onVisualizationChange?` | (`visualization`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void` | A callback function that triggers when a question is opened from a dashboard card or when the user changes the visualization type of a question. |-| <a id="parameters"></a> `parameters?` | [`ParameterValues`](./api/ParameterValues.md) | Controlled parameter values, slug-keyed. On every render, this object replaces the dashboard's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with [onParametersChange](./api/InteractiveDashboardProps.md#onparameterschange) to stay in sync with user edits. <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](./api/MetabasePluginsConfig.md) | Additional mapper function to override or add drill-down menu. See the implementing custom actions section for more details. |-| <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |-| <a id="token"></a> `token?` | `string` \| `null` | A valid JWT token for the guest embed. |-| <a id="withcardtitle"></a> `withCardTitle?` | `boolean` | Whether the dashboard cards should display a title. |-| <a id="withdownloads"></a> `withDownloads?` | `boolean` | Whether to hide the download button. |-| <a id="withsubscriptions"></a> `withSubscriptions?` | `boolean` | Whether to show the subscriptions button. |-| <a id="withtitle"></a> `withTitle?` | `boolean` | Whether the dashboard should display a title. |+| Property | Type | Description |+| :---------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| <a id="autorefreshinterval"></a> `autoRefreshInterval?` | `number` | The interval between auto refreshes on the dashboard, in seconds. |+| <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |+| <a id="dashboardid"></a> `dashboardId?` | [`SdkDashboardId`](/docs/latest/embedding/sdk/api/SdkDashboardId.md) \| `null` | The ID of the dashboard. <br/> This is either: <br/> - the numerical ID when accessing a dashboard link, i.e. `http://localhost:3000/dashboard/1-my-dashboard` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the dashboard object when using the API directly or using the SDK Collection Browser to return data |+| <a id="hiddenparameters"></a> `hiddenParameters?` | `string`[] | A list of [parameters to hide](https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters). <br/> - Combining [initialParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="initialparameters"></a> `initialParameters?` | [`ParameterValues`](/docs/latest/embedding/sdk/api/ParameterValues.md) | Initial values for query parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value (string for a single option, array of strings for multiple): that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). <br/> <br/> - Combining [initialParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="onload"></a> `onLoad?` | (`dashboard`: [`MetabaseDashboard`](/docs/latest/embedding/sdk/api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded. |+| <a id="onloadwithoutcards"></a> `onLoadWithoutCards?` | (`dashboard`: [`MetabaseDashboard`](/docs/latest/embedding/sdk/api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded without cards. |+| <a id="onparameterschange"></a> `onParametersChange?` | (`payload`: [`ParameterChangePayload`](/docs/latest/embedding/sdk/api/ParameterChangePayload.md)) => `void` | Fires on parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |+| <a id="onvisualizationchange"></a> `onVisualizationChange?` | (`visualization`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void` | A callback function that triggers when a question is opened from a dashboard card or when the user changes the visualization type of a question. |+| <a id="parameters"></a> `parameters?` | [`ParameterValues`](/docs/latest/embedding/sdk/api/ParameterValues.md) | Controlled parameter values, slug-keyed. On every render, this object replaces the dashboard's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with [onParametersChange](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#onparameterschange) to stay in sync with user edits. <br/> - Combining [parameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [parameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](/docs/latest/embedding/sdk/api/MetabasePluginsConfig.md) | Additional mapper function to override or add drill-down menu. See the implementing custom actions section for more details. |+| <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |+| <a id="token"></a> `token?` | `string` \| `null` | A valid JWT token for the guest embed. |+| <a id="withcardtitle"></a> `withCardTitle?` | `boolean` | Whether the dashboard cards should display a title. |+| <a id="withdownloads"></a> `withDownloads?` | `boolean` | Whether to hide the download button. |+| <a id="withsubscriptions"></a> `withSubscriptions?` | `boolean` | Whether to show the subscriptions button. |+| <a id="withtitle"></a> `withTitle?` | `boolean` | Whether the dashboard should display a title. |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/StaticQuestion.md b/docs/embedding/sdk/api/snippets/StaticQuestion.mdindex 82802f3858a..b11172a99e1 100644--- a/docs/embedding/sdk/api/snippets/StaticQuestion.md+++ b/docs/embedding/sdk/api/snippets/StaticQuestion.md@@ -8,9 +8,9 @@ A component that renders a static question.<!-- [<snippet parameters>] -->-| Parameter | Type |-| :-------- | :---------------------------------------------------- |-| `props` | [`StaticQuestionProps`](./api/StaticQuestionProps.md) |+| Parameter | Type |+| :-------- | :----------------------------------------------------------------------------- |+| `props` | [`StaticQuestionProps`](/docs/latest/embedding/sdk/api/StaticQuestionProps.md) |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/StaticQuestionComponents.md b/docs/embedding/sdk/api/snippets/StaticQuestionComponents.mdindex 38366e697e8..eb6122c5973 100644--- a/docs/embedding/sdk/api/snippets/StaticQuestionComponents.md+++ b/docs/embedding/sdk/api/snippets/StaticQuestionComponents.md@@ -52,9 +52,9 @@ Dropdown button for the Breakout component.<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :---------------------------------------------------------------------------------------------- | :---------- |-| `props` | [`InteractiveQuestionBreakoutDropdownProps`](./api/InteractiveQuestionBreakoutDropdownProps.md) | |+| Parameter | Type | Description |+| :-------- | :----------------------------------------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionBreakoutDropdownProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionBreakoutDropdownProps.md) | |<!-- [<endsnippet parameters>] -->@@ -89,9 +89,9 @@ Automatically updates to show recommended visualization types for the current da<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :------------------------------------------------------------------------------------------------ | :---------- |-| `props` | [`InteractiveQuestionChartTypeDropdownProps`](./api/InteractiveQuestionChartTypeDropdownProps.md) | |+| Parameter | Type | Description |+| :-------- | :------------------------------------------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionChartTypeDropdownProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionChartTypeDropdownProps.md) | |<!-- [<endsnippet parameters>] -->@@ -232,9 +232,9 @@ Displays current filters as badges with an "Add another filter" option.<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :-------------------------------------------------------------------------- | :---------- |-| `props` | [`InteractiveQuestionFilterProps`](./api/InteractiveQuestionFilterProps.md) | |+| Parameter | Type | Description |+| :-------- | :--------------------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionFilterProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionFilterProps.md) | |<!-- [<endsnippet parameters>] -->@@ -268,9 +268,9 @@ A dropdown button for the Filter component.<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :------------------------------------------------------------------------------------------ | :---------- |-| `props` | [`InteractiveQuestionFilterDropdownProps`](./api/InteractiveQuestionFilterDropdownProps.md) | |+| Parameter | Type | Description |+| :-------- | :------------------------------------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionFilterDropdownProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionFilterDropdownProps.md) | |<!-- [<endsnippet parameters>] -->@@ -343,9 +343,9 @@ Dropdown button that contains the QuestionSettings component.<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :-------------------------------------------------------------------------------------------------------------- | :---------- |-| `props?` | [`InteractiveQuestionQuestionSettingsDropdownProps`](./api/InteractiveQuestionQuestionSettingsDropdownProps.md) | |+| Parameter | Type | Description |+| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------- | :---------- |+| `props?` | [`InteractiveQuestionQuestionSettingsDropdownProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionQuestionSettingsDropdownProps.md) | |<!-- [<endsnippet parameters>] -->@@ -421,9 +421,9 @@ Button to run the current query. Only appears when automatic reruns are turned o<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :---------------------------------------------------------------------------------------- | :---------- |-| `props?` | [`InteractiveQuestionRefreshButtonProps`](./api/InteractiveQuestionRefreshButtonProps.md) | |+| Parameter | Type | Description |+| :-------- | :----------------------------------------------------------------------------------------------------------------- | :---------- |+| `props?` | [`InteractiveQuestionRefreshButtonProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionRefreshButtonProps.md) | |<!-- [<endsnippet parameters>] -->@@ -458,9 +458,9 @@ Button to reset question modifications. Only appears when there are unsaved chan<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :------------------------------------ | :---------- |-| `props?` | [`ButtonProps`](./api/ButtonProps.md) | |+| Parameter | Type | Description |+| :-------- | :------------------------------------------------------------- | :---------- |+| `props?` | [`ButtonProps`](/docs/latest/embedding/sdk/api/ButtonProps.md) | |<!-- [<endsnippet parameters>] -->@@ -547,9 +547,9 @@ Dropdown button for the Summarize component.<!-- [<snippet parameters>] -->-| Parameter | Type | Description |-| :-------- | :------------------------------------------------------------------------------------------------ | :---------- |-| `props` | [`InteractiveQuestionSummarizeDropdownProps`](./api/InteractiveQuestionSummarizeDropdownProps.md) | |+| Parameter | Type | Description |+| :-------- | :------------------------------------------------------------------------------------------------------------------------- | :---------- |+| `props` | [`InteractiveQuestionSummarizeDropdownProps`](/docs/latest/embedding/sdk/api/InteractiveQuestionSummarizeDropdownProps.md) | |<!-- [<endsnippet parameters>] -->diff --git a/docs/embedding/sdk/api/snippets/StaticQuestionProps.md b/docs/embedding/sdk/api/snippets/StaticQuestionProps.mdindex d6ab25a4f32..7360b518c21 100644--- a/docs/embedding/sdk/api/snippets/StaticQuestionProps.md+++ b/docs/embedding/sdk/api/snippets/StaticQuestionProps.md@@ -6,17 +6,17 @@| Property | Type | Description || :---------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-| <a id="card"></a> `card?` | `string` \| [`MetabaseCard`](./api/MetabaseCard.md) | An ad-hoc question to render without saving it first. Either a [MetabaseCard](./api/MetabaseCard.md) object, or a serialized card string copied from a question URL hash (`/question#<base64>` or the bare base64). |+| <a id="card"></a> `card?` | `string` \| [`MetabaseCard`](/docs/latest/embedding/sdk/api/MetabaseCard.md) | An ad-hoc question to render without saving it first. Either a [MetabaseCard](/docs/latest/embedding/sdk/api/MetabaseCard.md) object, or a serialized card string copied from a question URL hash (`/question#<base64>` or the bare base64). || <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. || <a id="height"></a> `height?` | `Height`\<`string` \| `number`\> | A number or string specifying a CSS size value that specifies the height of the component || <a id="hiddenparameters"></a> `hiddenParameters?` | `string`[] | A list of parameters to hide. |-| <a id="initialsqlparameters"></a> `initialSqlParameters?` | [`SqlParameterValues`](./api/SqlParameterValues.md) | Initial values for SQL parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value: that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). |-| <a id="onsqlparameterschange"></a> `onSqlParametersChange?` | (`payload`: [`SqlParameterChangePayload`](./api/SqlParameterChangePayload.md)) => `void` | Fires on SQL parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |-| <a id="query"></a> `query?` | [`MetabaseQueryObject`](./api/MetabaseQueryObject.md) \| `null` | A table-backed ad hoc query created with `useMetabaseQueryObject`. |-| <a id="questionid"></a> `questionId?` | [`SdkQuestionId`](./api/SdkQuestionId.md) \| `null` | The ID of the question. <br/> This is either: <br/> - the numerical ID when accessing a question link, i.e. `http://localhost:3000/question/1-my-question` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the question object when using the API directly or using the SDK Collection Browser to return data <br/> - `new` to show the notebook editor for creating new questions <br/> - `new-native` to show the SQL editor for creating new native questions |-| <a id="sqlparameters"></a> `sqlParameters?` | [`SqlParameterValues`](./api/SqlParameterValues.md) | Controlled SQL parameter values, slug-keyed. On every render, this object replaces the question's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with `onSqlParametersChange` to stay in sync with user edits. |+| <a id="initialsqlparameters"></a> `initialSqlParameters?` | [`SqlParameterValues`](/docs/latest/embedding/sdk/api/SqlParameterValues.md) | Initial values for SQL parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value: that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). |+| <a id="onsqlparameterschange"></a> `onSqlParametersChange?` | (`payload`: [`SqlParameterChangePayload`](/docs/latest/embedding/sdk/api/SqlParameterChangePayload.md)) => `void` | Fires on SQL parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |+| <a id="query"></a> `query?` | [`MetabaseQueryObject`](/docs/latest/embedding/sdk/api/MetabaseQueryObject.md) \| `null` | A table-backed ad hoc query created with `useMetabaseQueryObject`. |+| <a id="questionid"></a> `questionId?` | [`SdkQuestionId`](/docs/latest/embedding/sdk/api/SdkQuestionId.md) \| `null` | The ID of the question. <br/> This is either: <br/> - the numerical ID when accessing a question link, i.e. `http://localhost:3000/question/1-my-question` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the question object when using the API directly or using the SDK Collection Browser to return data <br/> - `new` to show the notebook editor for creating new questions <br/> - `new-native` to show the SQL editor for creating new native questions |+| <a id="sqlparameters"></a> `sqlParameters?` | [`SqlParameterValues`](/docs/latest/embedding/sdk/api/SqlParameterValues.md) | Controlled SQL parameter values, slug-keyed. On every render, this object replaces the question's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with `onSqlParametersChange` to stay in sync with user edits. || <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |-| <a id="title"></a> `title?` | [`SdkQuestionTitleProps`](./api/SdkQuestionTitleProps.md) | Determines whether the question title is displayed, and allows a custom title to be displayed instead of the default question title. Shown by default. |+| <a id="title"></a> `title?` | [`SdkQuestionTitleProps`](/docs/latest/embedding/sdk/api/SdkQuestionTitleProps.md) | Determines whether the question title is displayed, and allows a custom title to be displayed instead of the default question title. Shown by default. || <a id="token"></a> `token?` | `string` \| `null` | A valid JWT token for the guest embed. || <a id="width"></a> `width?` | `Width`\<`string` \| `number`\> | A number or string specifying a CSS size value that specifies the width of the component || <a id="withalerts"></a> `withAlerts?` | `boolean` | Enables the ability to set up alerts on the question. |diff --git a/docs/embedding/sdk/api/snippets/UseActionResult.md b/docs/embedding/sdk/api/snippets/UseActionResult.mdindex c8b61770db2..e72242b57a1 100644--- a/docs/embedding/sdk/api/snippets/UseActionResult.md+++ b/docs/embedding/sdk/api/snippets/UseActionResult.md@@ -7,7 +7,7 @@| Type Parameter || :----------------------------------------------------------------------------------------------------------------------------------------- || `TParameters` _extends_ [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `unknown`\> |-| `TKind` _extends_ [`ActionKind`](./api/ActionKind.md) \| `undefined` |+| `TKind` _extends_ [`ActionKind`](/docs/latest/embedding/sdk/api/ActionKind.md) \| `undefined` |<!-- [<endsnippet type-parameters>] -->@@ -15,12 +15,12 @@<!-- [<snippet properties>] -->-| Property | Type | Description |-| :------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-| <a id="error"></a> `error` | [`ActionExecuteError`](./api/ActionExecuteError.md) \| `null` | Last thrown error, normalized to the public `ActionExecuteError` shape, or `null`. |-| <a id="execute"></a> `execute` | (`parameters`: `TParameters`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`ActionResultForKind`](./api/ActionResultForKind.md)\<`TKind`\> \| `null`\> | Trigger the action with the given parameters. Returns the response body on success AND throws on failure — the same error is stored in `error` for render-time consumers. Resolves to the discriminated `result` shape (see `ActionResultForKind<TKind>`); when `TKind` is omitted it resolves to `AnyActionResult`, narrowable via `"<key>" in r`. Resolves to `null` (without making a request) when `actionId` is `null` or the SDK is not yet initialized — guard the host-side caller with `if (!actionId) return;` if these cases are reachable. |-| <a id="isexecuting"></a> `isExecuting` | `boolean` | - |-| <a id="reset"></a> `reset` | () => `void` | Clear `result` and `error`. |-| <a id="result"></a> `result` | [`ActionResultForKind`](./api/ActionResultForKind.md)\<`TKind`\> \| `null` | Last response, or `null` before first call and after `reset()`. |+| Property | Type | Description |+| :------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| <a id="error"></a> `error` | [`ActionExecuteError`](/docs/latest/embedding/sdk/api/ActionExecuteError.md) \| `null` | Last thrown error, normalized to the public `ActionExecuteError` shape, or `null`. |+| <a id="execute"></a> `execute` | (`parameters`: `TParameters`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`ActionResultForKind`](/docs/latest/embedding/sdk/api/ActionResultForKind.md)\<`TKind`\> \| `null`\> | Trigger the action with the given parameters. Returns the response body on success AND throws on failure — the same error is stored in `error` for render-time consumers. Resolves to the discriminated `result` shape (see `ActionResultForKind<TKind>`); when `TKind` is omitted it resolves to `AnyActionResult`, narrowable via `"<key>" in r`. Resolves to `null` (without making a request) when `actionId` is `null` or the SDK is not yet initialized — guard the host-side caller with `if (!actionId) return;` if these cases are reachable. |+| <a id="isexecuting"></a> `isExecuting` | `boolean` | - |+| <a id="reset"></a> `reset` | () => `void` | Clear `result` and `error`. |+| <a id="result"></a> `result` | [`ActionResultForKind`](/docs/latest/embedding/sdk/api/ActionResultForKind.md)\<`TKind`\> \| `null` | Last response, or `null` before first call and after `reset()`. |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/UseMetabotResult.md b/docs/embedding/sdk/api/snippets/UseMetabotResult.mdindex 0edf153215e..6c8a596af38 100644--- a/docs/embedding/sdk/api/snippets/UseMetabotResult.md+++ b/docs/embedding/sdk/api/snippets/UseMetabotResult.md@@ -18,18 +18,18 @@ type UseMetabotResult = {<!-- [<snippet properties>] -->-| Property | Type | Description |-| :----------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |-| <a id="cancelrequest"></a> `cancelRequest` | () => `void` | Cancel the current in-flight request. |-| <a id="contextwindowpercentusage"></a> `contextWindowPercentUsage` | `number` | How much of the model's context window the conversation occupies, 0-100. |-| <a id="currentchart"></a> `CurrentChart` | \| [`React_2.ComponentType`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L104)\<[`MetabotChartProps`](./api/MetabotChartProps.md)\> \| `null` | A pre-wired component bound to the latest chart the agent produced. `null` until the agent sends a chart — lets consumers detect presence and render a placeholder or swap panel content only when set. **Example** `{CurrentChart ? <CurrentChart /> : <Placeholder />}` |-| <a id="errormessages"></a> `errorMessages` | [`MetabotErrorMessage`](./api/MetabotErrorMessage.md)[] | Errors are conversation-level, not attached to individual messages. |-| <a id="incompleteresponse"></a> `incompleteResponse` | \| [`MetabotIncompleteResponse`](./api/MetabotIncompleteResponse.md) \| `null` | Set when the latest agent response stopped before it finished, e.g. at its step limit. |-| <a id="iscontextwindowfull"></a> `isContextWindowFull` | `boolean` | Whether the conversation has consumed its entire context window. |-| <a id="isprocessing"></a> `isProcessing` | `boolean` | `true` from the moment a message is submitted until the response completes — including success, error, or cancellation. |-| <a id="messages"></a> `messages` | [`MetabotMessage`](./api/MetabotMessage.md)[] | All messages in the conversation. Chart messages include a `Chart` property. |-| <a id="resetconversation"></a> `resetConversation` | () => `void` | Clear all messages and start fresh. |-| <a id="retrymessage"></a> `retryMessage` | (`messageId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | Rewinds the conversation to the user message preceding `messageId` and re-submits that prompt. The agent message at `messageId` and anything after it is dropped. |-| <a id="submitmessage"></a> `submitMessage` | (`message`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | Submit a new message to the conversation. |+| Property | Type | Description |+| :----------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |+| <a id="cancelrequest"></a> `cancelRequest` | () => `void` | Cancel the current in-flight request. |+| <a id="contextwindowpercentusage"></a> `contextWindowPercentUsage` | `number` | How much of the model's context window the conversation occupies, 0-100. |+| <a id="currentchart"></a> `CurrentChart` | \| [`React_2.ComponentType`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L104)\<[`MetabotChartProps`](/docs/latest/embedding/sdk/api/MetabotChartProps.md)\> \| `null` | A pre-wired component bound to the latest chart the agent produced. `null` until the agent sends a chart — lets consumers detect presence and render a placeholder or swap panel content only when set. **Example** `{CurrentChart ? <CurrentChart /> : <Placeholder />}` |+| <a id="errormessages"></a> `errorMessages` | [`MetabotErrorMessage`](/docs/latest/embedding/sdk/api/MetabotErrorMessage.md)[] | Errors are conversation-level, not attached to individual messages. |+| <a id="incompleteresponse"></a> `incompleteResponse` | \| [`MetabotIncompleteResponse`](/docs/latest/embedding/sdk/api/MetabotIncompleteResponse.md) \| `null` | Set when the latest agent response stopped before it finished, e.g. at its step limit. |+| <a id="iscontextwindowfull"></a> `isContextWindowFull` | `boolean` | Whether the conversation has consumed its entire context window. |+| <a id="isprocessing"></a> `isProcessing` | `boolean` | `true` from the moment a message is submitted until the response completes — including success, error, or cancellation. |+| <a id="messages"></a> `messages` | [`MetabotMessage`](/docs/latest/embedding/sdk/api/MetabotMessage.md)[] | All messages in the conversation. Chart messages include a `Chart` property. |+| <a id="resetconversation"></a> `resetConversation` | () => `void` | Clear all messages and start fresh. |+| <a id="retrymessage"></a> `retryMessage` | (`messageId`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | Rewinds the conversation to the user message preceding `messageId` and re-submits that prompt. The agent message at `messageId` and anything after it is dropped. |+| <a id="submitmessage"></a> `submitMessage` | (`message`: `string`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\> | Submit a new message to the conversation. |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/defineMetabaseAuthConfig.md b/docs/embedding/sdk/api/snippets/defineMetabaseAuthConfig.mdindex 7793a9de149..2024e641fd1 100644--- a/docs/embedding/sdk/api/snippets/defineMetabaseAuthConfig.md+++ b/docs/embedding/sdk/api/snippets/defineMetabaseAuthConfig.md@@ -10,9 +10,9 @@ Defines a Metabase auth config.<!-- [<snippet parameters>] -->-| Parameter | Type |-| :-------- | :-------------------------------------------------- |-| `config` | [`MetabaseAuthConfig`](./api/MetabaseAuthConfig.md) |+| Parameter | Type |+| :-------- | :--------------------------------------------------------------------------- |+| `config` | [`MetabaseAuthConfig`](/docs/latest/embedding/sdk/api/MetabaseAuthConfig.md) |<!-- [<endsnippet parameters>] -->@@ -20,6 +20,6 @@ Defines a Metabase auth config.<!-- [<snippet returns>] -->-[`MetabaseAuthConfig`](./api/MetabaseAuthConfig.md)+[`MetabaseAuthConfig`](/docs/latest/embedding/sdk/api/MetabaseAuthConfig.md)<!-- [<endsnippet returns>] -->diff --git a/docs/embedding/sdk/api/snippets/index.md b/docs/embedding/sdk/api/snippets/index.mdindex d5707e67792..a6fe412abcc 100644--- a/docs/embedding/sdk/api/snippets/index.md+++ b/docs/embedding/sdk/api/snippets/index.md@@ -1,236 +1,236 @@## CollectionBrowser-| Name | Description |-| :-------------------------------------------------------- | :----------------------------------------------------------------- |-| [CollectionBrowser](./api/CollectionBrowser.md) | A component that allows you to browse collections and their items. |-| [CollectionBrowserProps](./api/CollectionBrowserProps.md) | - |+| Name | Description |+| :--------------------------------------------------------------------------------- | :----------------------------------------------------------------- |+| [CollectionBrowser](/docs/latest/embedding/sdk/api/CollectionBrowser.md) | A component that allows you to browse collections and their items. |+| [CollectionBrowserProps](/docs/latest/embedding/sdk/api/CollectionBrowserProps.md) | - |## CreateDashboardModal-| Name | Description |-| :-------------------------------------------------------------- | :------------------ |-| [CreateDashboardModal](./api/CreateDashboardModal.md) | Creates a dashboard |-| [CreateDashboardModalProps](./api/CreateDashboardModalProps.md) | - |+| Name | Description |+| :--------------------------------------------------------------------------------------- | :------------------ |+| [CreateDashboardModal](/docs/latest/embedding/sdk/api/CreateDashboardModal.md) | Creates a dashboard |+| [CreateDashboardModalProps](/docs/latest/embedding/sdk/api/CreateDashboardModalProps.md) | - |## CreateQuestion-| Name | Description |-| :-------------------------------------------------- | :---------- |-| [~~CreateQuestion~~](./api/CreateQuestion.md) | - |-| [CreateQuestionProps](./api/CreateQuestionProps.md) | - |+| Name | Description |+| :--------------------------------------------------------------------------- | :---------- |+| [~~CreateQuestion~~](/docs/latest/embedding/sdk/api/CreateQuestion.md) | - |+| [CreateQuestionProps](/docs/latest/embedding/sdk/api/CreateQuestionProps.md) | - |## Dashboard-| Name | Description |-| :-------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-| [EditableDashboard](./api/EditableDashboard.md) | 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](./api/InteractiveDashboard.md) | A dashboard component with drill downs, click behaviors, and the ability to view and click into questions. |-| [StaticDashboard](./api/StaticDashboard.md) | A lightweight dashboard component. |-| [EditableDashboardProps](./api/EditableDashboardProps.md) | - |-| [InteractiveDashboardProps](./api/InteractiveDashboardProps.md) | - |-| [StaticDashboardProps](./api/StaticDashboardProps.md) | - |-| [ParameterChangePayload](./api/ParameterChangePayload.md) | Payload passed to `onParametersChange` callback |-| [ParameterChangeSource](./api/ParameterChangeSource.md) | 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. |+| Name | Description |+| :--------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| [EditableDashboard](/docs/latest/embedding/sdk/api/EditableDashboard.md) | 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](/docs/latest/embedding/sdk/api/InteractiveDashboard.md) | A dashboard component with drill downs, click behaviors, and the ability to view and click into questions. |+| [StaticDashboard](/docs/latest/embedding/sdk/api/StaticDashboard.md) | A lightweight dashboard component. |+| [EditableDashboardProps](/docs/latest/embedding/sdk/api/EditableDashboardProps.md) | - |+| [InteractiveDashboardProps](/docs/latest/embedding/sdk/api/InteractiveDashboardProps.md) | - |+| [StaticDashboardProps](/docs/latest/embedding/sdk/api/StaticDashboardProps.md) | - |+| [ParameterChangePayload](/docs/latest/embedding/sdk/api/ParameterChangePayload.md) | Payload passed to `onParametersChange` callback |+| [ParameterChangeSource](/docs/latest/embedding/sdk/api/ParameterChangeSource.md) | 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](./api/InteractiveQuestion.md) | A component that renders an interactive question. |-| [DrillThroughQuestionProps](./api/DrillThroughQuestionProps.md) | Props for the drill-through question |-| [InteractiveQuestionChartTypeDropdownProps](./api/InteractiveQuestionChartTypeDropdownProps.md) | - |-| [InteractiveQuestionEditorButtonProps](./api/InteractiveQuestionEditorButtonProps.md) | - |-| [InteractiveQuestionEditorProps](./api/InteractiveQuestionEditorProps.md) | - |-| [InteractiveQuestionProps](./api/InteractiveQuestionProps.md) | - |-| [InteractiveQuestionQuestionSettingsDropdownProps](./api/InteractiveQuestionQuestionSettingsDropdownProps.md) | - |-| [InteractiveQuestionQuestionVisualizationProps](./api/InteractiveQuestionQuestionVisualizationProps.md) | - |-| [InteractiveQuestionRefreshButtonProps](./api/InteractiveQuestionRefreshButtonProps.md) | - |-| [InteractiveQuestionResetButtonProps](./api/InteractiveQuestionResetButtonProps.md) | - |-| [InteractiveQuestionSaveQuestionFormProps](./api/InteractiveQuestionSaveQuestionFormProps.md) | - |-| [InteractiveQuestionTitleProps](./api/InteractiveQuestionTitleProps.md) | - |-| [SdkQuestionProps](./api/SdkQuestionProps.md) | - |-| [InteractiveQuestionBackButtonProps](./api/InteractiveQuestionBackButtonProps.md) | - |-| [InteractiveQuestionBreakoutDropdownProps](./api/InteractiveQuestionBreakoutDropdownProps.md) | - |-| [InteractiveQuestionChartTypeSelectorProps](./api/InteractiveQuestionChartTypeSelectorProps.md) | - |-| [InteractiveQuestionDownloadWidgetDropdownProps](./api/InteractiveQuestionDownloadWidgetDropdownProps.md) | - |-| [InteractiveQuestionDownloadWidgetProps](./api/InteractiveQuestionDownloadWidgetProps.md) | - |-| [InteractiveQuestionFilterDropdownProps](./api/InteractiveQuestionFilterDropdownProps.md) | - |-| [InteractiveQuestionFilterProps](./api/InteractiveQuestionFilterProps.md) | - |-| [InteractiveQuestionQuestionSettingsProps](./api/InteractiveQuestionQuestionSettingsProps.md) | - |-| [InteractiveQuestionSaveButtonProps](./api/InteractiveQuestionSaveButtonProps.md) | - |-| [InteractiveQuestionSummarizeDropdownProps](./api/InteractiveQuestionSummarizeDropdownProps.md) | - |-| [SqlParameterChangePayload](./api/SqlParameterChangePayload.md) | Payload passed to `onSqlParametersChange` callback |-| [SqlParameterChangeSource](./api/SqlParameterChangeSource.md) | 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. |+| Name | Description |+| :------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| [InteractiveQuestion](/docs/latest/embedding/sdk/api/InteractiveQuestion.md) | A component that renders an interactive question. |+| [DrillThroughQuestionProps](/docs/latest/embedding/sdk/api/DrillThroughQuestionProps.md) | Props for the drill-through question |+| [InteractiveQuestionChartTypeDropdownProps](/docs/latest/embedding/sdk/api/InteractiveQuestionChartTypeDropdownProps.md) | - |+| [InteractiveQuestionEditorButtonProps](/docs/latest/embedding/sdk/api/InteractiveQuestionEditorButtonProps.md) | - |+| [InteractiveQuestionEditorProps](/docs/latest/embedding/sdk/api/InteractiveQuestionEditorProps.md) | - |+| [InteractiveQuestionProps](/docs/latest/embedding/sdk/api/InteractiveQuestionProps.md) | - |+| [InteractiveQuestionQuestionSettingsDropdownProps](/docs/latest/embedding/sdk/api/InteractiveQuestionQuestionSettingsDropdownProps.md) | - |+| [InteractiveQuestionQuestionVisualizationProps](/docs/latest/embedding/sdk/api/InteractiveQuestionQuestionVisualizationProps.md) | - |+| [InteractiveQuestionRefreshButtonProps](/docs/latest/embedding/sdk/api/InteractiveQuestionRefreshButtonProps.md) | - |+| [InteractiveQuestionResetButtonProps](/docs/latest/embedding/sdk/api/InteractiveQuestionResetButtonProps.md) | - |+| [InteractiveQuestionSaveQuestionFormProps](/docs/latest/embedding/sdk/api/InteractiveQuestionSaveQuestionFormProps.md) | - |+| [InteractiveQuestionTitleProps](/docs/latest/embedding/sdk/api/InteractiveQuestionTitleProps.md) | - |+| [SdkQuestionProps](/docs/latest/embedding/sdk/api/SdkQuestionProps.md) | - |+| [InteractiveQuestionBackButtonProps](/docs/latest/embedding/sdk/api/InteractiveQuestionBackButtonProps.md) | - |+| [InteractiveQuestionBreakoutDropdownProps](/docs/latest/embedding/sdk/api/InteractiveQuestionBreakoutDropdownProps.md) | - |+| [InteractiveQuestionChartTypeSelectorProps](/docs/latest/embedding/sdk/api/InteractiveQuestionChartTypeSelectorProps.md) | - |+| [InteractiveQuestionDownloadWidgetDropdownProps](/docs/latest/embedding/sdk/api/InteractiveQuestionDownloadWidgetDropdownProps.md) | - |+| [InteractiveQuestionDownloadWidgetProps](/docs/latest/embedding/sdk/api/InteractiveQuestionDownloadWidgetProps.md) | - |+| [InteractiveQuestionFilterDropdownProps](/docs/latest/embedding/sdk/api/InteractiveQuestionFilterDropdownProps.md) | - |+| [InteractiveQuestionFilterProps](/docs/latest/embedding/sdk/api/InteractiveQuestionFilterProps.md) | - |+| [InteractiveQuestionQuestionSettingsProps](/docs/latest/embedding/sdk/api/InteractiveQuestionQuestionSettingsProps.md) | - |+| [InteractiveQuestionSaveButtonProps](/docs/latest/embedding/sdk/api/InteractiveQuestionSaveButtonProps.md) | - |+| [InteractiveQuestionSummarizeDropdownProps](/docs/latest/embedding/sdk/api/InteractiveQuestionSummarizeDropdownProps.md) | - |+| [SqlParameterChangePayload](/docs/latest/embedding/sdk/api/SqlParameterChangePayload.md) | Payload passed to `onSqlParametersChange` callback |+| [SqlParameterChangeSource](/docs/latest/embedding/sdk/api/SqlParameterChangeSource.md) | 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](./api/defineMetabaseAuthConfig.md) | Defines a Metabase auth config. |-| [MetabaseProvider](./api/MetabaseProvider.md) | A component that provides the Metabase SDK context and theme. |-| [MetabaseProviderProps](./api/MetabaseProviderProps.md) | - |-| [MetabaseAuthConfig](./api/MetabaseAuthConfig.md) | - |-| [MetabaseAuthConfigWithApiKey](./api/MetabaseAuthConfigWithApiKey.md) | - |-| [MetabaseAuthConfigWithJwt](./api/MetabaseAuthConfigWithJwt.md) | - |-| [MetabaseAuthConfigWithSaml](./api/MetabaseAuthConfigWithSaml.md) | - |-| [MetabaseIsGuestAuthConfig](./api/MetabaseIsGuestAuthConfig.md) | - |+| Name | Description |+| :--------------------------------------------------------------------------------------------- | :------------------------------------------------------------ |+| [defineMetabaseAuthConfig](/docs/latest/embedding/sdk/api/defineMetabaseAuthConfig.md) | Defines a Metabase auth config. |+| [MetabaseProvider](/docs/latest/embedding/sdk/api/MetabaseProvider.md) | A component that provides the Metabase SDK context and theme. |+| [MetabaseProviderProps](/docs/latest/embedding/sdk/api/MetabaseProviderProps.md) | - |+| [MetabaseAuthConfig](/docs/latest/embedding/sdk/api/MetabaseAuthConfig.md) | - |+| [MetabaseAuthConfigWithApiKey](/docs/latest/embedding/sdk/api/MetabaseAuthConfigWithApiKey.md) | - |+| [MetabaseAuthConfigWithJwt](/docs/latest/embedding/sdk/api/MetabaseAuthConfigWithJwt.md) | - |+| [MetabaseAuthConfigWithSaml](/docs/latest/embedding/sdk/api/MetabaseAuthConfigWithSaml.md) | - |+| [MetabaseIsGuestAuthConfig](/docs/latest/embedding/sdk/api/MetabaseIsGuestAuthConfig.md) | - |## MetabotQuestion-| Name | Description |-| :---------------------------------------------------- | :------------------------------------------- |-| [MetabotQuestion](./api/MetabotQuestion.md) | A component that renders a metabot question. |-| [MetabotQuestionProps](./api/MetabotQuestionProps.md) | Props for the MetabotQuestion component. |+| Name | Description |+| :----------------------------------------------------------------------------- | :------------------------------------------- |+| [MetabotQuestion](/docs/latest/embedding/sdk/api/MetabotQuestion.md) | A component that renders a metabot question. |+| [MetabotQuestionProps](/docs/latest/embedding/sdk/api/MetabotQuestionProps.md) | Props for the MetabotQuestion component. |## StaticQuestion-| Name | Description |-| :-------------------------------------------------- | :------------------------------------------ |-| [StaticQuestion](./api/StaticQuestion.md) | A component that renders a static question. |-| [StaticQuestionProps](./api/StaticQuestionProps.md) | - |+| Name | Description |+| :--------------------------------------------------------------------------- | :------------------------------------------ |+| [StaticQuestion](/docs/latest/embedding/sdk/api/StaticQuestion.md) | A component that renders a static question. |+| [StaticQuestionProps](/docs/latest/embedding/sdk/api/StaticQuestionProps.md) | - |## Theming-| Name | Description |-| :------------------------------------------------------------ | :-------------------------------------------------------------- |-| [MetabaseEmbeddingThemeV2](./api/MetabaseEmbeddingThemeV2.md) | Version 2 theme configuration for embedded Metabase components. |-| [ChartColorV2](./api/ChartColorV2.md) | Chart color definition for V2 themes. |-| [MetabaseColorKey](./api/MetabaseColorKey.md) | All color keys available in Metabase themes. |-| [MetabaseEmbeddingTheme](./api/MetabaseEmbeddingTheme.md) | Theme configuration for embedded Metabase components. |+| Name | Description |+| :------------------------------------------------------------------------------------- | :-------------------------------------------------------------- |+| [MetabaseEmbeddingThemeV2](/docs/latest/embedding/sdk/api/MetabaseEmbeddingThemeV2.md) | Version 2 theme configuration for embedded Metabase components. |+| [ChartColorV2](/docs/latest/embedding/sdk/api/ChartColorV2.md) | Chart color definition for V2 themes. |+| [MetabaseColorKey](/docs/latest/embedding/sdk/api/MetabaseColorKey.md) | All color keys available in Metabase themes. |+| [MetabaseEmbeddingTheme](/docs/latest/embedding/sdk/api/MetabaseEmbeddingTheme.md) | Theme configuration for embedded Metabase components. |## other-| Name | Description |-| :---------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |-| [DataAppLink](./api/DataAppLink.md) | Internal-only navigation link inside a data app. |-| [DataAppRouter](./api/DataAppRouter.md) | Wrap your data-app tree once. Inside, use `<DataAppLink to="…">` for navigation and `useDataAppLocation()` to read the current path. |-| [useAction](./api/useAction.md) | - |-| [useDataAppLocation](./api/useDataAppLocation.md) | The current data-app sub-path and a `navigate` function. |-| [DataAppLinkProps](./api/DataAppLinkProps.md) | - |-| [DataAppRouterProps](./api/DataAppRouterProps.md) | - |-| [InteractiveQuestionComponents](./api/InteractiveQuestionComponents.md) | - |-| [MetabaseColors](./api/MetabaseColors.md) | - |-| [MetabaseQuestion](./api/MetabaseQuestion.md) | - |-| [MetabaseTheme](./api/MetabaseTheme.md) | Theme configuration for embedded Metabase components. |-| [StaticQuestionComponents](./api/StaticQuestionComponents.md) | - |-| [ButtonProps](./api/ButtonProps.md) | - |-| [ChartColor](./api/ChartColor.md) | - |-| [CollectionBrowserListColumns](./api/CollectionBrowserListColumns.md) | - |-| [CustomDashboardCardMenuItem](./api/CustomDashboardCardMenuItem.md) | - |-| [DashboardCardCustomMenuItem](./api/DashboardCardCustomMenuItem.md) | - |-| [DashboardCardMenu](./api/DashboardCardMenu.md) | - |-| [DashboardCardMenuCustomElement](./api/DashboardCardMenuCustomElement.md) | - |-| [DashCardMenuItem](./api/DashCardMenuItem.md) | - |-| [EmbeddingDataPicker](./api/EmbeddingDataPicker.md) | - |-| [EmbeddingEntityType](./api/EmbeddingEntityType.md) | - |-| [EntityTypeFilterKeys](./api/EntityTypeFilterKeys.md) | - |-| [FieldSchema](./api/FieldSchema.md) | Metadata for a generated table field. |-| [IconName](./api/IconName.md) | - |-| [InitializationStatus](./api/InitializationStatus.md) | - |-| [LoginStatus](./api/LoginStatus.md) | - |-| [MetabaseCard](./api/MetabaseCard.md) | 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](./api/MetabaseClickAction.md) | - |-| [MetabaseClickActionPluginsConfig](./api/MetabaseClickActionPluginsConfig.md) | - |-| [MetabaseCollection](./api/MetabaseCollection.md) | The Collection entity |-| [MetabaseCollectionItem](./api/MetabaseCollectionItem.md) | The CollectionItem entity |-| [MetabaseComponentTheme](./api/MetabaseComponentTheme.md) | Theme options for customizing specific Metabase components and visualizations. |-| [MetabaseDashboard](./api/MetabaseDashboard.md) | The Dashboard entity |-| [MetabaseDashboardPluginsConfig](./api/MetabaseDashboardPluginsConfig.md) | - |-| [MetabaseDataPointObject](./api/MetabaseDataPointObject.md) | - |-| [MetabaseEmbeddingColorKeyV2](./api/MetabaseEmbeddingColorKeyV2.md) | Color keys available for theming in modular embedding. |-| [MetabaseFetchRequestTokenFn](./api/MetabaseFetchRequestTokenFn.md) | - |-| [MetabaseFontFamily](./api/MetabaseFontFamily.md) | - |-| [MetabaseGlobalPluginsConfig](./api/MetabaseGlobalPluginsConfig.md) | - |-| [MetabasePluginsConfig](./api/MetabasePluginsConfig.md) | - |-| [MetabaseQueryObject](./api/MetabaseQueryObject.md) | Public structural type for ad-hoc SDK queries created by `useMetabaseQueryObject`. |-| [MetabaseThemePreset](./api/MetabaseThemePreset.md) | - |-| [MetabaseUser](./api/MetabaseUser.md) | The User entity |-| [MetabotAgentChartMessage](./api/MetabotAgentChartMessage.md) | - |-| [MetabotAgentMessage](./api/MetabotAgentMessage.md) | - |-| [MetabotAgentTextMessage](./api/MetabotAgentTextMessage.md) | - |-| [MetabotUserTextMessage](./api/MetabotUserTextMessage.md) | - |-| [ParameterValues](./api/ParameterValues.md) | - |-| [ProtectedColorKey](./api/ProtectedColorKey.md) | Color keys that are protected and should not be exposed to embedding. |-| [QueryData](./api/QueryData.md) | - |-| [QueryQuestionResult](./api/QueryQuestionResult.md) | - |-| [RowValue](./api/RowValue.md) | A single value returned by Metabase query results or action responses. |-| [SchemaColumn](./api/SchemaColumn.md) | - |-| [SchemaJavaScriptType](./api/SchemaJavaScriptType.md) | - |-| [SchemaRow](./api/SchemaRow.md) | - |-| [SdkActionDefinition](./api/SdkActionDefinition.md) | How a data app names an action: the `defineAction` export, which is what a data app must pass. `copiedActionEntityId` addresses the copy in the app's own collection, the only one its viewers can read. The dev preview runs `action` instead, so an app works before its resources are written. |-| [SdkActionId](./api/SdkActionId.md) | How the raw SDK names an action: the id it was given. |-| [SdkActionInput](./api/SdkActionInput.md) | - |-| [SdkBrowserCollectionId](./api/SdkBrowserCollectionId.md) | `SdkCollectionId` plus `"all"`, a virtual read-only top level showing everything the current user can access. |-| [SdkCollectionId](./api/SdkCollectionId.md) | - |-| [SdkDashboardEntityPublicProps](./api/SdkDashboardEntityPublicProps.md) | - |-| [SdkDashboardId](./api/SdkDashboardId.md) | - |-| [SdkDashboardLoadEvent](./api/SdkDashboardLoadEvent.md) | - |-| [SdkEntityId](./api/SdkEntityId.md) | - |-| [SdkEntityToken](./api/SdkEntityToken.md) | - |-| [SdkErrorComponent](./api/SdkErrorComponent.md) | - |-| [SdkErrorComponentProps](./api/SdkErrorComponentProps.md) | - |-| [SdkEventHandlersConfig](./api/SdkEventHandlersConfig.md) | - |-| [SdkQuestionEntityPublicProps](./api/SdkQuestionEntityPublicProps.md) | - |-| [SdkQuestionId](./api/SdkQuestionId.md) | Represents the identifier for a question in the Metabase SDK. |-| [SdkQuestionTitleProps](./api/SdkQuestionTitleProps.md) | - |-| [SdkUserId](./api/SdkUserId.md) | - |-| [SqlParameterValues](./api/SqlParameterValues.md) | - |-| [UseDataAppLocationResult](./api/UseDataAppLocationResult.md) | - |-| [UserBackendJwtResponse](./api/UserBackendJwtResponse.md) | - |+| Name | Description |+| :----------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |+| [DataAppLink](/docs/latest/embedding/sdk/api/DataAppLink.md) | Internal-only navigation link inside a data app. |+| [DataAppRouter](/docs/latest/embedding/sdk/api/DataAppRouter.md) | Wrap your data-app tree once. Inside, use `<DataAppLink to="…">` for navigation and `useDataAppLocation()` to read the current path. |+| [useAction](/docs/latest/embedding/sdk/api/useAction.md) | - |+| [useDataAppLocation](/docs/latest/embedding/sdk/api/useDataAppLocation.md) | The current data-app sub-path and a `navigate` function. |+| [DataAppLinkProps](/docs/latest/embedding/sdk/api/DataAppLinkProps.md) | - |+| [DataAppRouterProps](/docs/latest/embedding/sdk/api/DataAppRouterProps.md) | - |+| [InteractiveQuestionComponents](/docs/latest/embedding/sdk/api/InteractiveQuestionComponents.md) | - |+| [MetabaseColors](/docs/latest/embedding/sdk/api/MetabaseColors.md) | - |+| [MetabaseQuestion](/docs/latest/embedding/sdk/api/MetabaseQuestion.md) | - |+| [MetabaseTheme](/docs/latest/embedding/sdk/api/MetabaseTheme.md) | Theme configuration for embedded Metabase components. |+| [StaticQuestionComponents](/docs/latest/embedding/sdk/api/StaticQuestionComponents.md) | - |+| [ButtonProps](/docs/latest/embedding/sdk/api/ButtonProps.md) | - |+| [ChartColor](/docs/latest/embedding/sdk/api/ChartColor.md) | - |+| [CollectionBrowserListColumns](/docs/latest/embedding/sdk/api/CollectionBrowserListColumns.md) | - |+| [CustomDashboardCardMenuItem](/docs/latest/embedding/sdk/api/CustomDashboardCardMenuItem.md) | - |+| [DashboardCardCustomMenuItem](/docs/latest/embedding/sdk/api/DashboardCardCustomMenuItem.md) | - |+| [DashboardCardMenu](/docs/latest/embedding/sdk/api/DashboardCardMenu.md) | - |+| [DashboardCardMenuCustomElement](/docs/latest/embedding/sdk/api/DashboardCardMenuCustomElement.md) | - |+| [DashCardMenuItem](/docs/latest/embedding/sdk/api/DashCardMenuItem.md) | - |+| [EmbeddingDataPicker](/docs/latest/embedding/sdk/api/EmbeddingDataPicker.md) | - |+| [EmbeddingEntityType](/docs/latest/embedding/sdk/api/EmbeddingEntityType.md) | - |+| [EntityTypeFilterKeys](/docs/latest/embedding/sdk/api/EntityTypeFilterKeys.md) | - |+| [FieldSchema](/docs/latest/embedding/sdk/api/FieldSchema.md) | Metadata for a generated table field. |+| [IconName](/docs/latest/embedding/sdk/api/IconName.md) | - |+| [InitializationStatus](/docs/latest/embedding/sdk/api/InitializationStatus.md) | - |+| [LoginStatus](/docs/latest/embedding/sdk/api/LoginStatus.md) | - |+| [MetabaseCard](/docs/latest/embedding/sdk/api/MetabaseCard.md) | 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](/docs/latest/embedding/sdk/api/MetabaseClickAction.md) | - |+| [MetabaseClickActionPluginsConfig](/docs/latest/embedding/sdk/api/MetabaseClickActionPluginsConfig.md) | - |+| [MetabaseCollection](/docs/latest/embedding/sdk/api/MetabaseCollection.md) | The Collection entity |+| [MetabaseCollectionItem](/docs/latest/embedding/sdk/api/MetabaseCollectionItem.md) | The CollectionItem entity |+| [MetabaseComponentTheme](/docs/latest/embedding/sdk/api/MetabaseComponentTheme.md) | Theme options for customizing specific Metabase components and visualizations. |+| [MetabaseDashboard](/docs/latest/embedding/sdk/api/MetabaseDashboard.md) | The Dashboard entity |+| [MetabaseDashboardPluginsConfig](/docs/latest/embedding/sdk/api/MetabaseDashboardPluginsConfig.md) | - |+| [MetabaseDataPointObject](/docs/latest/embedding/sdk/api/MetabaseDataPointObject.md) | - |+| [MetabaseEmbeddingColorKeyV2](/docs/latest/embedding/sdk/api/MetabaseEmbeddingColorKeyV2.md) | Color keys available for theming in modular embedding. |+| [MetabaseFetchRequestTokenFn](/docs/latest/embedding/sdk/api/MetabaseFetchRequestTokenFn.md) | - |+| [MetabaseFontFamily](/docs/latest/embedding/sdk/api/MetabaseFontFamily.md) | - |+| [MetabaseGlobalPluginsConfig](/docs/latest/embedding/sdk/api/MetabaseGlobalPluginsConfig.md) | - |+| [MetabasePluginsConfig](/docs/latest/embedding/sdk/api/MetabasePluginsConfig.md) | - |+| [MetabaseQueryObject](/docs/latest/embedding/sdk/api/MetabaseQueryObject.md) | Public structural type for ad-hoc SDK queries created by `useMetabaseQueryObject`. |+| [MetabaseThemePreset](/docs/latest/embedding/sdk/api/MetabaseThemePreset.md) | - |+| [MetabaseUser](/docs/latest/embedding/sdk/api/MetabaseUser.md) | The User entity |+| [MetabotAgentChartMessage](/docs/latest/embedding/sdk/api/MetabotAgentChartMessage.md) | - |+| [MetabotAgentMessage](/docs/latest/embedding/sdk/api/MetabotAgentMessage.md) | - |+| [MetabotAgentTextMessage](/docs/latest/embedding/sdk/api/MetabotAgentTextMessage.md) | - |+| [MetabotUserTextMessage](/docs/latest/embedding/sdk/api/MetabotUserTextMessage.md) | - |+| [ParameterValues](/docs/latest/embedding/sdk/api/ParameterValues.md) | - |+| [ProtectedColorKey](/docs/latest/embedding/sdk/api/ProtectedColorKey.md) | Color keys that are protected and should not be exposed to embedding. |+| [QueryData](/docs/latest/embedding/sdk/api/QueryData.md) | - |+| [QueryQuestionResult](/docs/latest/embedding/sdk/api/QueryQuestionResult.md) | - |+| [RowValue](/docs/latest/embedding/sdk/api/RowValue.md) | A single value returned by Metabase query results or action responses. |+| [SchemaColumn](/docs/latest/embedding/sdk/api/SchemaColumn.md) | - |+| [SchemaJavaScriptType](/docs/latest/embedding/sdk/api/SchemaJavaScriptType.md) | - |+| [SchemaRow](/docs/latest/embedding/sdk/api/SchemaRow.md) | - |+| [SdkActionDefinition](/docs/latest/embedding/sdk/api/SdkActionDefinition.md) | How a data app names an action: the `defineAction` export, which is what a data app must pass. `copiedActionEntityId` addresses the copy in the app's own collection, the only one its viewers can read. The dev preview runs `action` instead, so an app works before its resources are written. |+| [SdkActionId](/docs/latest/embedding/sdk/api/SdkActionId.md) | How the raw SDK names an action: the id it was given. |+| [SdkActionInput](/docs/latest/embedding/sdk/api/SdkActionInput.md) | - |+| [SdkBrowserCollectionId](/docs/latest/embedding/sdk/api/SdkBrowserCollectionId.md) | `SdkCollectionId` plus `"all"`, a virtual read-only top level showing everything the current user can access. |+| [SdkCollectionId](/docs/latest/embedding/sdk/api/SdkCollectionId.md) | - |+| [SdkDashboardEntityPublicProps](/docs/latest/embedding/sdk/api/SdkDashboardEntityPublicProps.md) | - |+| [SdkDashboardId](/docs/latest/embedding/sdk/api/SdkDashboardId.md) | - |+| [SdkDashboardLoadEvent](/docs/latest/embedding/sdk/api/SdkDashboardLoadEvent.md) | - |+| [SdkEntityId](/docs/latest/embedding/sdk/api/SdkEntityId.md) | - |+| [SdkEntityToken](/docs/latest/embedding/sdk/api/SdkEntityToken.md) | - |+| [SdkErrorComponent](/docs/latest/embedding/sdk/api/SdkErrorComponent.md) | - |+| [SdkErrorComponentProps](/docs/latest/embedding/sdk/api/SdkErrorComponentProps.md) | - |+| [SdkEventHandlersConfig](/docs/latest/embedding/sdk/api/SdkEventHandlersConfig.md) | - |+| [SdkQuestionEntityPublicProps](/docs/latest/embedding/sdk/api/SdkQuestionEntityPublicProps.md) | - |+| [SdkQuestionId](/docs/latest/embedding/sdk/api/SdkQuestionId.md) | Represents the identifier for a question in the Metabase SDK. |+| [SdkQuestionTitleProps](/docs/latest/embedding/sdk/api/SdkQuestionTitleProps.md) | - |+| [SdkUserId](/docs/latest/embedding/sdk/api/SdkUserId.md) | - |+| [SqlParameterValues](/docs/latest/embedding/sdk/api/SqlParameterValues.md) | - |+| [UseDataAppLocationResult](/docs/latest/embedding/sdk/api/UseDataAppLocationResult.md) | - |+| [UserBackendJwtResponse](/docs/latest/embedding/sdk/api/UserBackendJwtResponse.md) | - |## useAction-| Name | Description |-| :------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |-| [UseActionResult](./api/UseActionResult.md) | - |-| [ActionExecuteError](./api/ActionExecuteError.md) | 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](./api/ActionKind.md) | Flat public kind union. Maps onto the backend's namespaced `row/*` + `bulk/*` `implicitKind` and the `query` `type` value, but exposes a simpler five-value surface to callers: `create` / `update` / `delete` always refer to a single row, `bulk` covers any bulk variant, and `sql` covers custom SQL actions (the backend's `query`-type action). |-| [ActionResultForBulk](./api/ActionResultForBulk.md) | Response from any bulk variant — a success flag plus optional counts. |-| [ActionResultForCreate](./api/ActionResultForCreate.md) | Response from a single-row create — the inserted row. |-| [ActionResultForDelete](./api/ActionResultForDelete.md) | Response from a single-row delete — the affected primary keys. |-| [ActionResultForKind](./api/ActionResultForKind.md) | Maps an `ActionKind` literal to the discriminated `result` shape. Omit `TKind` (`undefined`) to fall back to the `AnyActionResult` union. |-| [ActionResultForSql](./api/ActionResultForSql.md) | Response from a custom SQL action — the affected row count. |-| [ActionResultForUpdate](./api/ActionResultForUpdate.md) | Response from a single-row update — the affected primary keys. |-| [AnyActionResult](./api/AnyActionResult.md) | 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. |+| Name | Description |+| :------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |+| [UseActionResult](/docs/latest/embedding/sdk/api/UseActionResult.md) | - |+| [ActionExecuteError](/docs/latest/embedding/sdk/api/ActionExecuteError.md) | 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](/docs/latest/embedding/sdk/api/ActionKind.md) | Flat public kind union. Maps onto the backend's namespaced `row/*` + `bulk/*` `implicitKind` and the `query` `type` value, but exposes a simpler five-value surface to callers: `create` / `update` / `delete` always refer to a single row, `bulk` covers any bulk variant, and `sql` covers custom SQL actions (the backend's `query`-type action). |+| [ActionResultForBulk](/docs/latest/embedding/sdk/api/ActionResultForBulk.md) | Response from any bulk variant — a success flag plus optional counts. |+| [ActionResultForCreate](/docs/latest/embedding/sdk/api/ActionResultForCreate.md) | Response from a single-row create — the inserted row. |+| [ActionResultForDelete](/docs/latest/embedding/sdk/api/ActionResultForDelete.md) | Response from a single-row delete — the affected primary keys. |+| [ActionResultForKind](/docs/latest/embedding/sdk/api/ActionResultForKind.md) | Maps an `ActionKind` literal to the discriminated `result` shape. Omit `TKind` (`undefined`) to fall back to the `AnyActionResult` union. |+| [ActionResultForSql](/docs/latest/embedding/sdk/api/ActionResultForSql.md) | Response from a custom SQL action — the affected row count. |+| [ActionResultForUpdate](/docs/latest/embedding/sdk/api/ActionResultForUpdate.md) | Response from a single-row update — the affected primary keys. |+| [AnyActionResult](/docs/latest/embedding/sdk/api/AnyActionResult.md) | 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](./api/useApplicationName.md) | Returns application name. Returns `null` until the SDK is fully loaded and initialized. |+| Function | Description |+| :------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- |+| [useApplicationName](/docs/latest/embedding/sdk/api/useApplicationName.md) | Returns application name. Returns `null` until the SDK is fully loaded and initialized. |## useAvailableFonts-| Function | Description |-| :---------------------------------------------- | :------------------------------------------------------------------------------------- |-| [useAvailableFonts](./api/useAvailableFonts.md) | Returns available fonts. Returns `null` until the SDK is fully loaded and initialized. |+| Function | Description |+| :----------------------------------------------------------------------- | :------------------------------------------------------------------------------------- |+| [useAvailableFonts](/docs/latest/embedding/sdk/api/useAvailableFonts.md) | Returns available fonts. Returns `null` until the SDK is fully loaded and initialized. |## useCreateDashboardApi-| Name | Description |-| :------------------------------------------------------ | :--------------------------------------------------------------------------------- |-| [useCreateDashboardApi](./api/useCreateDashboardApi.md) | Creates a dashboard. Returns `null` until the SDK is fully loaded and initialized. |-| [CreateDashboardValues](./api/CreateDashboardValues.md) | - |+| Name | Description |+| :------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------- |+| [useCreateDashboardApi](/docs/latest/embedding/sdk/api/useCreateDashboardApi.md) | Creates a dashboard. Returns `null` until the SDK is fully loaded and initialized. |+| [CreateDashboardValues](/docs/latest/embedding/sdk/api/CreateDashboardValues.md) | - |## useCurrentUser-| Function | Description |-| :---------------------------------------- | :-------------------------------------------------------------------------------------- |-| [useCurrentUser](./api/useCurrentUser.md) | Returns the current user. Returns `null` until the SDK is fully loaded and initialized. |+| Function | Description |+| :----------------------------------------------------------------- | :-------------------------------------------------------------------------------------- |+| [useCurrentUser](/docs/latest/embedding/sdk/api/useCurrentUser.md) | Returns the current user. Returns `null` until the SDK is fully loaded and initialized. |## useMetabaseAuthStatus-| Function | Description |-| :------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------- |-| [useMetabaseAuthStatus](./api/useMetabaseAuthStatus.md) | Returns the authentication status of the current user in the Metabase embedding SDK. Returns `null` until the SDK is fully loaded and initialized. |+| Function | Description |+| :------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------- |+| [useMetabaseAuthStatus](/docs/latest/embedding/sdk/api/useMetabaseAuthStatus.md) | 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](./api/useMetabot.md) | Returns the Metabot conversation API. |-| [MetabotChartProps](./api/MetabotChartProps.md) | - |-| [MetabotErrorMessage](./api/MetabotErrorMessage.md) | - |-| [MetabotIncompleteResponse](./api/MetabotIncompleteResponse.md) | - |-| [MetabotMessage](./api/MetabotMessage.md) | - |-| [UseMetabotResult](./api/UseMetabotResult.md) | - |+| Name | Description |+| :--------------------------------------------------------------------------------------- | :------------------------------------ |+| [useMetabot](/docs/latest/embedding/sdk/api/useMetabot.md) | Returns the Metabot conversation API. |+| [MetabotChartProps](/docs/latest/embedding/sdk/api/MetabotChartProps.md) | - |+| [MetabotErrorMessage](/docs/latest/embedding/sdk/api/MetabotErrorMessage.md) | - |+| [MetabotIncompleteResponse](/docs/latest/embedding/sdk/api/MetabotIncompleteResponse.md) | - |+| [MetabotMessage](/docs/latest/embedding/sdk/api/MetabotMessage.md) | - |+| [UseMetabotResult](/docs/latest/embedding/sdk/api/UseMetabotResult.md) | - |diff --git a/docs/embedding/sdk/api/snippets/useCreateDashboardApi.md b/docs/embedding/sdk/api/snippets/useCreateDashboardApi.mdindex 8a560314af8..0fbff0bd148 100644--- a/docs/embedding/sdk/api/snippets/useCreateDashboardApi.md+++ b/docs/embedding/sdk/api/snippets/useCreateDashboardApi.md@@ -14,7 +14,7 @@ Returns `null` until the SDK is fully loaded and initialized.<!-- [<snippet returns>] -->\| \{-`createDashboard`: (`params`: [`CreateDashboardValues`](./api/CreateDashboardValues.md)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`MetabaseDashboard`](./api/MetabaseDashboard.md)\>;+`createDashboard`: (`params`: [`CreateDashboardValues`](/docs/latest/embedding/sdk/api/CreateDashboardValues.md)) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`MetabaseDashboard`](/docs/latest/embedding/sdk/api/MetabaseDashboard.md)\>;\}\| `null`diff --git a/docs/embedding/sdk/api/snippets/useCurrentUser.md b/docs/embedding/sdk/api/snippets/useCurrentUser.mdindex daf481e0cd4..bd3115df7ff 100644--- a/docs/embedding/sdk/api/snippets/useCurrentUser.md+++ b/docs/embedding/sdk/api/snippets/useCurrentUser.md@@ -9,6 +9,6 @@ Returns `null` until the SDK is fully loaded and initialized.<!-- [<snippet returns>] -->-[`MetabaseUser`](./api/MetabaseUser.md) \| `null`+[`MetabaseUser`](/docs/latest/embedding/sdk/api/MetabaseUser.md) \| `null`<!-- [<endsnippet returns>] -->diff --git a/docs/embedding/sdk/api/snippets/useDataAppLocation.md b/docs/embedding/sdk/api/snippets/useDataAppLocation.mdindex b457610629c..480d16b4529 100644--- a/docs/embedding/sdk/api/snippets/useDataAppLocation.md+++ b/docs/embedding/sdk/api/snippets/useDataAppLocation.md@@ -11,6 +11,6 @@ Paths are relative to the data-app root: `/`, `/customers/42`, etc.<!-- [<snippet returns>] -->-[`UseDataAppLocationResult`](./api/UseDataAppLocationResult.md)+[`UseDataAppLocationResult`](/docs/latest/embedding/sdk/api/UseDataAppLocationResult.md)<!-- [<endsnippet returns>] -->diff --git a/docs/embedding/sdk/api/snippets/useMetabaseAuthStatus.md b/docs/embedding/sdk/api/snippets/useMetabaseAuthStatus.mdindex e3db12f9d30..bbe28065ce6 100644--- a/docs/embedding/sdk/api/snippets/useMetabaseAuthStatus.md+++ b/docs/embedding/sdk/api/snippets/useMetabaseAuthStatus.md@@ -9,6 +9,6 @@ Returns `null` until the SDK is fully loaded and initialized.<!-- [<snippet returns>] -->-[`InitializationStatus`](./api/InitializationStatus.md) \| `null`+[`InitializationStatus`](/docs/latest/embedding/sdk/api/InitializationStatus.md) \| `null`<!-- [<endsnippet returns>] -->diff --git a/docs/embedding/sdk/api/snippets/useMetabot.md b/docs/embedding/sdk/api/snippets/useMetabot.mdindex 3703d1860e5..9ca25bab4fd 100644--- a/docs/embedding/sdk/api/snippets/useMetabot.md+++ b/docs/embedding/sdk/api/snippets/useMetabot.md@@ -11,7 +11,7 @@ has mounted its internal subscriber. Guard before use:<!-- [<snippet returns>] -->-[`UseMetabotResult`](./api/UseMetabotResult.md) \| `null`+[`UseMetabotResult`](/docs/latest/embedding/sdk/api/UseMetabotResult.md) \| `null`<!-- [<endsnippet returns>] -->diff --git a/docs/util/check-links.sh b/docs/util/check-links.shindex d56fb444fef..cfbca465521 100755--- a/docs/util/check-links.sh+++ b/docs/util/check-links.sh@@ -4,7 +4,7 @@# (the page has to exist under docs/, and so does any #anchor).## docs/util/check-links.sh # all three-# docs/util/check-links.sh docs # only the markdown under docs/+# docs/util/check-links.sh docs # only the markdown under docs/, incl. the SDK snippets# docs/util/check-links.sh nav # only nav.yml# docs/util/check-links.sh src # only the source code# docs/util/check-links.sh site # metabase.com and GitHub wiki links against the live sites@@ -91,6 +91,54 @@ check_docs() {[ "$count" -eq 0 ]}+# The TypeDoc snippets in docs/embedding/sdk/api/snippets only reach readers through {% include_file %},+# which lychee doesn't expand, and the config skips docs/embedding/sdk/api. So check their links on their+# own, the same from every page that includes them. Each non-external link has to be+# /docs/latest/embedding/sdk/api/<Type>.md, whose generated <Type>.html (and #anchor) has to exist. Anything+# else fails up front: a relative link resolves against the includer, and lychee would skip other forms.+check_snippets() {+ echo "Checking links in the SDK snippets"+ local tmpdir links locations rendered report total count location url invalid=0+ tmpdir=$(mktemp -d)+ trap 'rm -rf "$tmpdir"' RETURN+ links=$tmpdir/links+ locations=$tmpdir/locations+ # The .md extension matters: lychee only looks for markdown links in markdown files.+ rendered=$tmpdir/snippet-links.md++ git grep -nIoE '\]\([^)]+\)' -- docs/embedding/sdk/api/snippets |+ sed -E 's/\]\((.*)\)$/\1/' | grep -vE '^[^:]+:[0-9]+:https?://' > "$links" || true+ if [ ! -s "$links" ]; then+ echo "No links found in docs/embedding/sdk/api/snippets" >&2+ return 1+ fi++ local api_link='^[^:]+:[0-9]+:/docs/latest/embedding/sdk/api/[A-Za-z0-9_]+\.md(#[a-z0-9-]+)?$'+ while IFS= read -r line; do+ invalid=$((invalid + 1))+ location=$(cut -d: -f1,2 <<<"$line")+ url=$(cut -d: -f3- <<<"$line")+ echo "$location: $url: not a /docs/latest/embedding/sdk/api/<Type>.md link"+ if [ -n "${LINKS_REPORT:-}" ]; then+ echo "$location: $url: not a /docs/latest/embedding/sdk/api/<Type>.md link" >> "$LINKS_REPORT"+ fi+ if [ -n "${GITHUB_ACTIONS:-}" ]; then+ echo "::error file=${location%:*},line=${location##*:}::$url: not a /docs/latest/embedding/sdk/api/<Type>.md link"+ fi+ done < <(grep -vE "$api_link" "$links" || true)+ grep -E "$api_link" "$links" > "$locations" || true+ sed -E "s#^[^:]+:[0-9]+:(.*)\$#- [snippet]($site\1)#" "$locations" > "$rendered"++ report=$(lychee --config ./.lychee/config.toml --offline --include-fragments=full --no-progress \+ --format json --include '^https?://(www\.)?metabase\.com/docs/latest/' \+ --remap "^https?://(www\.)?metabase\.com/docs/latest/([^#]+)\.md(#.*)?\$ file://$PWD/docs/\$2.html\$3" \+ "$rendered" || true)+ print_failures "$report" "$locations" || return 1+ count=$((count + invalid))+ echo "Checked $((total + invalid)) links in the SDK snippets, $count broken"+ [ "$count" -eq 0 ]+}+# lychee can't read YAML, so render the nav as markdown with one line per nav.yml line: a link on# each `url:` line, blank everywhere else. That way lychee's line numbers are nav.yml line numbers.# Urls with a scheme (https://...) or a leading slash (/learn/..., which is on the site, not in@@ -197,8 +245,9 @@ site_not_links=(status=0case "$what" in- all) check_docs || status=1; echo; check_nav || status=1; echo; check_src || status=1 ;;- docs) check_docs || status=1 ;;+ all) check_docs || status=1; echo; check_snippets || status=1; echo; check_nav || status=1; echo+ check_src || status=1 ;;+ docs) check_docs || status=1; echo; check_snippets || status=1 ;;nav) check_nav || status=1 ;;src) check_src || status=1 ;;site) check_site || status=1 ;;