docs: finalize upgrade guide#2581
Open
git-nandor wants to merge 1 commit into
Open
Conversation
|
Visual regression report✅ No changes.
Baselines come from the |
matyasf
requested changes
Jun 5, 2026
| ## New theming system | ||
|
|
||
| NOTE: this section is under development, will be updated soon | ||
| InstUI v11.7 introduces a token-based theming engine. Components imported from `/v11_7` (the `v2` label in the docs "Component version" selector) consume pre-resolved design tokens directly from the active theme. Components imported from `/v11_6` (the `v1` label) continue to use the legacy `generateComponentTheme` approach. **Both engines run side-by-side in the same app without conflict** — you can migrate component-by-component on your own schedule. |
Collaborator
There was a problem hiding this comment.
InstUI v11.7 introduces a token-based theming engine ->
InstUI v11.7 introduces a new theming engine. Components imported from /v11_7 (the v2 label in the docs "Component version" selector) consume design tokens directly from the active theme.
|
|
||
| 4. **Update per-component theme overrides.** Many v2 components have renamed / added / removed tokens — see the component-specific sections below for the exact changes. | ||
|
|
||
| > Components that haven't yet been promoted to v2 (`DateInput2`, `Editable`) ship as `v1` even when imported from `/v11_7` and continue to use legacy theming. The two engines coexist transparently — no special handling needed. |
Collaborator
There was a problem hiding this comment.
There are no such components now. Editable does not have a theme, this might've confused the AI, and DateInput2 is replaced
Comment on lines
+36
to
+39
| What changed is the **shape** of the override: | ||
|
|
||
| - **Legacy** — at both entry points, `themeOverride` accepted the component's flat theme-variable map (object or function returning one). | ||
| - **New** — provider-level `themeOverride` is a structured object keyed by token layer (`components.<Name>`, `semantics`, `sharedTokens`, `primitives`). The per-component `themeOverride` prop still accepts the component's own token map in object form or as a `(componentTheme) => ({...})` function — same shape as before, just with the v2 token names. |
Collaborator
There was a problem hiding this comment.
I would replace this with:
What changed:
- Theme overrides: in v11.7
InstUISettingsProvider'sthemeprop only accepts a full theme object. For v11.7 or later use the newthemeOverrideprop - token names/values: Lots of components had their theme tokens changed -- removed, added or renamed. Check the rest of this guide for the full list of changes.
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
2 participants
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.
INSTUI-4925
Summary
Add missing New theming system section to the Upgrade guide for v11.7 page
Co-Authored-By: 🤖 Claude