Fix rendering of design token previews in storybook #1028
Merged
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
rajsite
reviewed
Feb 7, 2023
packages/nimble-components/src/theme-provider/tests/tokens.stories.ts
Outdated
Show resolved
Hide resolved
packages/nimble-components/src/theme-provider/tests/tokens.stories.ts
Outdated
Show resolved
Hide resolved
packages/nimble-components/src/theme-provider/tests/tokens.stories.ts
Outdated
Show resolved
Hide resolved
rajsite
approved these changes
Feb 13, 2023
packages/nimble-components/src/theme-provider/tests/tokens.stories.ts
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Pull Request
🤨 Rationale
Fixes #714
👩💻 Implementation
The theme-aware tokens story tries to read token values from the CSS variables that are mirrored to the document's root
<html>element. But at the time the story renders, not all of those variables have been populated yet. This is because some of the updates are queued in the FAST render queue. (I'm not sure exactly why some previews worked, but it appears that the tokens with constant default values are not readable while the ones with values generated by functions are available)My fix is to call our
processUpdates()async helper to flush the queue before reading token values.🧪 Testing
✅ Checklist