fix(core)!: type per-key event-handler arguments for useSpring/useTransition#2551
Open
joshuaellis wants to merge 1 commit into
Open
fix(core)!: type per-key event-handler arguments for useSpring/useTransition#2551joshuaellis wants to merge 1 commit into
joshuaellis wants to merge 1 commit into
Conversation
…nsition Per-key handlers now infer result.value from the animated value instead of any. Breaking: props are stricter (the loose UseSpringProps escape-hatch arm is gone). useSprings is unchanged (array-inference limitation). Part of #2541.
🦋 Changeset detectedLatest commit: 364f733 The changes in this PR will be included in the next version bump. This PR includes changesets to release 9 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
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.
Summary
Per-key event-handler arguments now infer their type from the animated value instead of leaking
any. InuseSpring({ x: 0, onChange: { x: result => result.value } }),result.valueis nownumber; the same holds foronStart/onChange/onRest/onPause/onResume(andonProps) acrossuseSpringanduseTransition, which also tightens fromunknownto the key's value type. This removes a recurring source of unchecked handler arguments (#2183).Why it leaked
The handler callback sits inside the same object literal that the hook's
Propsgeneric is inferred from, so TypeScript can't contextually type it from the still-inferring generic and falls back toany. The newEventfulPropshelper sources the handler keys from the resolved props viaNoInfer, so the state resolves first and the callbacks receive the key's value type. Typo detection is preserved as an inference-neutral layer.Breaking change
To make the inference work, the props parameter no longer accepts the loose
UseSpringProps/UseTransitionPropsescape-hatch union member. Object literals and pre-typed props are unaffected; loosely-typed or dynamically-built props objects, andParameters<typeof useSpring>extraction, are now checked more strictly.Out of scope
useSpringsis unchanged. Its props are an array, which TypeScript collapses to a single inferred type via best-common-type — fundamentally incompatible with the per-element phasing this fix relies on. The lazy() => propsforms are likewise unaffected. Both are documented inline; annotate handler arguments there.Part of #2541.