docs: clarify SpringValues typing vs CSSProperties#2508
Merged
Conversation
Document the two patterns users hit when forwarding animated styles or narrowing literal values inside useSpring, and link them from the useTransition glossary. Closes #1645
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
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.
Why
#1645 reports two TypeScript errors that both still reproduce on
nextbut are working-as-designed:SpringValues<T>is not structurallyReact.CSSProperties— each entry is aSpringValueinstance, not a primitive. Typing a child component's prop asCSSPropertiesis too narrow.CSSProperties['pointerEvents']deliberately rejectSpringValue<string>so typos insideuseSpring(pointerEvents: 'fooo') stay caught. The error people hit is TS widening a ternary likeshowMenu ? 'all' : 'none'tostringat the config seam.Loosening either type would weaken safety for everyone to paper over patterns that have clean call-site fixes. Better to document the patterns.
Changes
SpringValuesglossary entry with subsections for child-component typing and literal-value widening.SpringValuesto theuseTransitionTS Glossary list (was missing).Closes #1645