Skip to content

[auto-build] backport-55-b1cc2fb7ec7eef14e85e6052c67cdd97592244d0 -> release-x.55.x #301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions _docs/latest/embedding/sdk/api/snippets/EditableDashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,27 @@ latest: true
---

```ts
function EditableDashboard(props: EditableDashboardProps): Element;
function EditableDashboard(
props: {
drillThroughQuestionHeight: Height<string | number>;
drillThroughQuestionProps: DrillThroughQuestionProps;
plugins: MetabasePluginsConfig;
renderDrillThroughQuestion: () => ReactNode;
} & {
dashboardId: SdkDashboardId;
hiddenParameters: string[];
initialParameters: ParameterValues;
withCardTitle: boolean;
withDownloads: boolean;
withTitle: boolean;
} & {
className: string;
style: CSSProperties;
} & {
onLoad: (dashboard: null | MetabaseDashboard) => void;
onLoadWithoutCards: (dashboard: null | MetabaseDashboard) => void;
} & {},
): Element;
```

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.
Expand All @@ -21,9 +41,9 @@ A dashboard component with the features available in the `InteractiveDashboard`

<!-- [<snippet parameters>] -->

| Parameter | Type | Description |
| :-------- | :---------------------------------------------------------- | :---------- |
| `props` | [`EditableDashboardProps`](./api/EditableDashboardProps) | |
| Parameter | Type | Description |
| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- |
| `props` | \{ `drillThroughQuestionHeight`: `Height`\<`string` \| `number`\>; `drillThroughQuestionProps`: [`DrillThroughQuestionProps`](./api/DrillThroughQuestionProps); `plugins`: [`MetabasePluginsConfig`](./api/MetabasePluginsConfig); `renderDrillThroughQuestion`: () => [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478); \} & \{ `dashboardId`: [`SdkDashboardId`](./api/SdkDashboardId); `hiddenParameters`: `string`[]; `initialParameters`: [`ParameterValues`](./api/ParameterValues); `withCardTitle`: `boolean`; `withDownloads`: `boolean`; `withTitle`: `boolean`; \} & \{ `className`: `string`; `style`: [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579); \} & \{ `onLoad`: (`dashboard`: `null` \| [`MetabaseDashboard`](./api/MetabaseDashboard)) => `void`; `onLoadWithoutCards`: (`dashboard`: `null` \| [`MetabaseDashboard`](./api/MetabaseDashboard)) => `void`; \} & \{ \} | |

<!-- [<endsnippet parameters>] -->

Expand Down
28 changes: 24 additions & 4 deletions _docs/v0.55/embedding/sdk/api/snippets/EditableDashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,27 @@ layout: new-docs
---

```ts
function EditableDashboard(props: EditableDashboardProps): Element;
function EditableDashboard(
props: {
drillThroughQuestionHeight: Height<string | number>;
drillThroughQuestionProps: DrillThroughQuestionProps;
plugins: MetabasePluginsConfig;
renderDrillThroughQuestion: () => ReactNode;
} & {
dashboardId: SdkDashboardId;
hiddenParameters: string[];
initialParameters: ParameterValues;
withCardTitle: boolean;
withDownloads: boolean;
withTitle: boolean;
} & {
className: string;
style: CSSProperties;
} & {
onLoad: (dashboard: null | MetabaseDashboard) => void;
onLoadWithoutCards: (dashboard: null | MetabaseDashboard) => void;
} & {},
): Element;
```

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.
Expand All @@ -19,9 +39,9 @@ A dashboard component with the features available in the `InteractiveDashboard`

<!-- [<snippet parameters>] -->

| Parameter | Type | Description |
| :-------- | :---------------------------------------------------------- | :---------- |
| `props` | [`EditableDashboardProps`](./api/EditableDashboardProps) | |
| Parameter | Type | Description |
| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- |
| `props` | \{ `drillThroughQuestionHeight`: `Height`\<`string` \| `number`\>; `drillThroughQuestionProps`: [`DrillThroughQuestionProps`](./api/DrillThroughQuestionProps); `plugins`: [`MetabasePluginsConfig`](./api/MetabasePluginsConfig); `renderDrillThroughQuestion`: () => [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478); \} & \{ `dashboardId`: [`SdkDashboardId`](./api/SdkDashboardId); `hiddenParameters`: `string`[]; `initialParameters`: [`ParameterValues`](./api/ParameterValues); `withCardTitle`: `boolean`; `withDownloads`: `boolean`; `withTitle`: `boolean`; \} & \{ `className`: `string`; `style`: [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579); \} & \{ `onLoad`: (`dashboard`: `null` \| [`MetabaseDashboard`](./api/MetabaseDashboard)) => `void`; `onLoadWithoutCards`: (`dashboard`: `null` \| [`MetabaseDashboard`](./api/MetabaseDashboard)) => `void`; \} & \{ \} | |

<!-- [<endsnippet parameters>] -->

Expand Down