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
docs - embed translations (#69196)
Jeff Bruemmer98d8aef4f014
diff --git a/docs/embedding/components.md b/docs/embedding/components.mdindex ab2f9fe9ead..4e49951c681 100644--- a/docs/embedding/components.md+++ b/docs/embedding/components.md@@ -37,7 +37,7 @@ To render a dashboard:- `refresh` - auto-refreshes the dashboard. `refresh="60"` will refresh the dashboard every 60 seconds.- `hidden-parameters` - list of filter names to hide from the dashboard, like `['productId']`-For guest embeds, you can also set a `locale` in your page-level configuration to [translate embedded content](./translations.md).+For all modular embeds, you can also set a `locale` in your page-level configuration to [translate embedded content](./translations.md), including content from translation dictionaries.Only `with-title` and `with-downloads` are supported in [guest embeds](./guest-embedding.md).diff --git a/docs/embedding/guest-embedding.md b/docs/embedding/guest-embedding.mdindex bd89a77f84b..7f13493f208 100644--- a/docs/embedding/guest-embedding.md+++ b/docs/embedding/guest-embedding.md@@ -275,7 +275,7 @@ You can only use the **URL** option for [custom destinations](../dashboards/inteYou can propagate filter values into the external URL, unless the filter is locked.-## Translating guest embeds+## Translating embedsTo translate an embed, set the `locale` in `window.metabaseConfig`:@@ -289,7 +289,7 @@ To translate an embed, set the `locale` in `window.metabaseConfig`:</script>```-The `locale` setting works for all modular embeds (guest and SSO). Metabase will automatically translate UI elements (like menus and buttons). To also translate content like dashboard titles and filter labels, you'll need to upload a translation dictionary. Translation dictionaries only work with guest embeds. See [Translating embedded questions and dashboards](./translations.md).+The `locale` setting works for all modular embeds (guest, SSO, and SDK). Metabase will automatically translate UI elements (like menus and buttons). To also translate content like dashboard titles and filter labels, you'll need to upload a [translation dictionary](./translations.md).## How guest embedding worksdiff --git a/docs/embedding/start.md b/docs/embedding/start.mdindex 44def237dd8..4d698046ecc 100644--- a/docs/embedding/start.md+++ b/docs/embedding/start.md@@ -28,9 +28,9 @@ Jump to a SDK quickstart with a sample React application.Guest embedding is a secure way to embed charts and dashboards. Guest embeds are view-only; people won't be able to drill-through charts and tables.-### [Translating guest embeds](./translations.md)+### [Translating embeds](./translations.md)-Upload a translation dictionary to translate questions and dashboards (only in guest embeds).+Upload a translation dictionary to translate questions and dashboards in modular embeds.## [Full app embedding](./full-app-embedding.md)diff --git a/docs/embedding/translations.md b/docs/embedding/translations.mdindex 0dae944ebb9..54f5417289b 100644--- a/docs/embedding/translations.md+++ b/docs/embedding/translations.md@@ -1,17 +1,17 @@----title: Translate embedded dashboards and questions-summary: Upload a translation dictionary to translate questions and dashboards into different languages. Translation dictionaries are only available for guest embeds.+title: Translate embedded components+summary: Upload a translation dictionary to translate the UI and content of embedded components like questions and dashboards into different languages.----# Translate embedded dashboards and questions+# Translate embedded components{% include plans-blockquote.html feature="Translation of embedded content" convert_pro_link_to_embbedding=true %}-You can set a locale on all modular embeds (guest and SSO) to translate Metabase's UI. Translation dictionaries, however, are only available for [guest embeds](./guest-embedding.md).+You can set a locale on modular embeds (guest, SSO, and SDK) to translate Metabase's UI. If you've uploaded a translation dictionary, Metabase will also translate content strings (like dashboard names and filter labels) for all [modular embeds](./modular-embedding.md).## Set a locale to translate UI, and upload a dictionary to translate content-To translate an embed's user interface, set the locale in the config. The `locale` setting works for all modular embeds (guest and SSO). Metabase UI elements (like menus) will be translated automatically - you don't need to add translations for them to your dictionary.+To translate an embed's user interface, set the locale in the config. The `locale` setting works for all modular embeds (guest, SSO, and SDK). Metabase UI elements (like menus) will be translated automatically - you don't need to add translations for them to your dictionary.For guest and SSO embeds (not the SDK), set the `locale` in `window.metabaseConfig`:@@ -21,7 +21,7 @@ For guest and SSO embeds (not the SDK), set the `locale` in `window.metabaseConfisGuest: true,instanceUrl: "YOUR_METABASE_URL",// Translates UI elements to the locale's language.- // For guest embeds, if you've uploaded a translation dictionary,+ // If you've uploaded a translation dictionary,// Metabase will also translate content strings// to this locale from that dictionary.locale: "es"@@ -31,7 +31,7 @@ For guest and SSO embeds (not the SDK), set the `locale` in `window.metabaseConf<metabase-dashboard token="YOUR_JWT_TOKEN"></metabase-dashboard>```-For guest embeds (and only guest embeds), if you also want to translate content (like item titles, headings, filter labels---even data), you'll need to add a translation dictionary.+If you also want to translate content (like item titles, headings, filter labels, or data), you'll need to add a translation dictionary.### SDK translations@@ -45,6 +45,8 @@ For the SDK, set the `locale` prop on the `MetabaseProvider` component:</MetabaseProvider>```+If you've uploaded a translation dictionary, the SDK will also translate content strings (like dashboard names and filter labels) to this locale from that dictionary.+## Add a translation dictionaryThe dictionary must be a CSV with these columns:@@ -66,7 +68,7 @@ To remove a translation dictionary, upload a blank dictionary.## Example translation dictionary-Metabase uses these dictionaries to translate user-generated content, like dashboard names in [guest embeds](./guest-embedding.md).+Metabase uses these dictionaries to translate user-generated content, like dashboard names in [modular embeds](./modular-embedding.md).| Language | String | Translation || -------- | ----------- | ------------ |@@ -77,7 +79,7 @@ Metabase uses these dictionaries to translate user-generated content, like dashb| pt-BR | Vendor | Vendedor || IT | Examples | Esempi |-Prefer hyphens in your `pt-BR` in your translation dictionary. Underscores are also acceptable (if you download the dictionary _after_ uploading it, Metabase will transform `pt-BR` to `pt_BR`), but since the `locale` parameter in guest embeds only accepts locales with hyphens (like `pt-BR`), we recommend using hyphens for consistency.+Prefer hyphens in your `pt-BR` in your translation dictionary. Underscores are also acceptable (if you download the dictionary _after_ uploading it, Metabase will transform `pt-BR` to `pt_BR`), but since the `locale` parameter in modular embeds only accepts locales with hyphens (like `pt-BR`), we recommend using hyphens for consistency.[See a list of supported locales](../configuring-metabase/localization.md#supported-languages).@@ -109,6 +111,12 @@ If the strings you want to translate include markdown formatting, you'll need to| pt-BR | `_Examples_` | `_Exemplos_` || pt-BR | `## Examples` | `## Exemplos` |++## The AI chat component isn't translated++One exception is that Metabase won't translate the text in the [AI chat component](./sdk/ai-chat.md). While Metabot can understand other languages, it works best in English.+## Further reading+- [Modular embedding](./modular-embedding.md)- [Guest embedding](./guest-embedding.md)