Document uiOverrides for translating embedded UI - #1196
Merged
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Documentation validation✅ All blocking checks passed. Component system0 finding(s) across the corpus. Findings on lines this pull request touched are annotated inline in Files changed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the new
uiOverridesReact SDK prop that translates Lightdash's UI chrome (filter operators and inputs, the filter popover, date zoom, tile menus, export buttons) in embeds, complementing the existingcontentOverridesmechanism.Changes to
embed/react-sdk.mdx:contentOverridesfor your content,uiOverridesfor Lightdash's UI) and notes that the host app owns locale state with English fallback for omitted keys.uiOverrides" section: typedSdkUiOverrideskey set, key namespaces (filters.*,dateZoom.*,tileMenu.*,dashboard.*), rules (optional keys, stable additive contract,{token}placeholders, one-key-per-plural-form limitation), and the i18next integration pattern.uiOverridesto the Dashboard, DashboardBuilder, Chart, and Explore prop listings, and to the AiAgent/MetricsCatalog "not accepted" notes.Details verified against
DEFAULT_UI_STRINGSand the SDK prop types in lightdash/lightdash. The minimum SDK version was not pinned since it wasn't provided; happy to add it once known.Generated by Mintlify Agent.
Requested by: marshall@lightdash.com via Slack
Mintlify session: slack_1787904965.300369_C0A3PQ0B2HZ