Update variants.md #277
Closed
Update variants.md #277
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
davebcn87
reviewed
Feb 23, 2024
| @@ -49,7 +49,7 @@ const theme = createTheme({ | |||
|
|
|||
| import {createVariant, createRestyleComponent, VariantProps} from '@shopify/restyle' | |||
| import {Theme} from './theme'; | |||
| const variant = createVariant<Theme>({themeKey: 'cardVariants', defaults: { | |||
| const variant = createVariant<Theme, 'cardVariant'>({themeKey: 'cardVariants', defaults: { | |||
There was a problem hiding this comment.
Suggested change
| const variant = createVariant<Theme, 'cardVariant'>({themeKey: 'cardVariants', defaults: { | |
| const variant = createVariant<Theme, 'cardVariants'>({themeKey: 'cardVariants', defaults: { |
There was a problem hiding this comment.
It looks like there is a typo
2 tasks
|
Addressed in #292 |
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.
Description
Based on this issue there is a typescript problem that throws an error on trying to create a variant. In the issue there was a fix indicating that if we specify the name of the key like:
const variant = createVariant<Theme, 'buttonVariants'>({ themeKey: 'buttonVariants', defaults: { margin: 'm', }, })the ts error goes away. I updated the docs because this caused me a 1 day delay to search and fix.