`fix(ui): Storybook's <DocsContainer /> overwriting theme object #29770
Conversation
This file contains 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
Storybook's <DocsContainer /> implements its own theme context. In the current configuration, that theme context is a descendant of the custom context that we implemented:
<ThemeProvider> // our theme context
<DocsContainer /> // DocsContainer and its own theme context
</ThemeProvider>
This means DocsContainer's theme context will overwrite any property in our custom theme. This is a problem because both contexts have the `background` property. DocsContainer's `background` is an object, while ours is a string value. Components inside DocsContainer cannot use our own `background` value because it is overwritten by DocsContainer.
Fix: Move our custom ThemeProvider inside DocsContainer, making it more specific.
billyvg
approved these changes
Nov 4, 2021
| <ThemeProvider theme={currentTheme}>{children}</ThemeProvider> | ||
| </DocsContainer> | ||
| <ThemeProvider theme={currentTheme}> | ||
| <TableOfContents /> |
There was a problem hiding this comment.
Is it ok that this is not part of DocsContainer? This is a bit awk, but not a big deal
There was a problem hiding this comment.
Should be okay. DocsContainer is just a wrapper around the main content. There's another wrapper (#docs-root) surrounding both it and <TableOfContents />.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Storybook's
<DocsContainer />implements its own theme context. In the current configuration, that theme context is a descendant of the custom theme context that we implemented:This means
DocsContainer's theme object will overwrite any property in our theme object. This is a problem because both have thebackgroundproperty. Any component insideDocsContainerwill see onlyDocsContainer'sbackgroundand not ours:To fix this, we can move our custom
ThemeProvidercontext insideDocsContainer, making it more specific and thus overwriting whatever value is inDocsContainer's theme. As a result, components insideDocsContainerwill now get the correct theme values: