Skip to content
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.

Sign up for GitHub

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

Jump to bottom

🤖 backported "docs - update full-app embedding" #26271

Merged
merged 1 commit into from
Nov 7, 2022
Merged

🤖 backported "docs - update full-app embedding" #26271

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions docs/embedding/full-app-embedding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,27 +113,27 @@ If you're using [JWT](../people-and-groups/authenticating-with-jwt.md) for SSO,
To keep up with changes to an embedded Metabase URL (for example, when a filter is applied), set up your app to listen for "location" messages from the embedded Metabase. If you want to use this message for deep-linking, note that "location" mirrors "window.location".

```
{ “metabase”: { “type”: “location”, “location”: LOCATION_OBJECT_OR_URL }}
{ "metabase": { "type": "location", "location": LOCATION_OBJECT_OR_URL }}
```

To make an embedded Metabase page (like a question) fill up the entire iframe in your app, set up your app to listen for a "frame" message with "normal" mode from Metabase:

```
{ “metabase”: { “type”: “frame”, “frame”: { “mode”: “normal” }}}
{ "metabase": { "type": "frame", "frame": { "mode": "normal" }}}
```

To specify the size of an iframe in your app so that it matches an embedded Metabase page (such as a dashboard), set up your app to listen for a "frame" message with "fit" mode from Metabase:

```
{ “metabase”: { “type”: “frame”, “frame”: { “mode”: “fit”, height: HEIGHT_IN_PIXELS }}}
{ "metabase": { "type": "frame", "frame": { "mode": "fit", height: HEIGHT_IN_PIXELS }}}
```

## Supported postMessage messages _to_ embedded Metabase

To change an embedding URL, send a "location" message from your app to Metabase:

```
{ “metabase”: { “type”: “location”, “location”: LOCATION_OBJECT_OR_URL }}
{ "metabase": { "type": "location", "location": LOCATION_OBJECT_OR_URL }}
```

## Showing or hiding Metabase UI components
Expand Down Expand Up @@ -188,7 +188,7 @@ To hide a question or dashboard's title, [additional info](#additional_info), an

Visible by default on question and dashboard pages, when the [header](#header) is enabled.

To hide the gray text “Edited X days ago by FirstName LastName”, as well as the breadcrumbs with collection, database, and table names:
To hide the gray text "Edited X days ago by FirstName LastName", as well as the breadcrumbs with collection, database, and table names:

`header=false&additional_info=false`

Expand Down