fix: capture window dimensions in layout worklet - #2751
Open
huytdps13400 wants to merge 1 commit into
Open
Conversation
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.
Motivation
Since v5.2.14, the
Dimensionslistener inuseAnimatedLayoutdestructures its payload into a local namedwindow. Reanimated treatswindowas an ambient default global, so it does not capture that binding in thestate.modifyworklet closure. Native UI runtimes have no globalwindow, and every dimensions change can therefore throwReferenceError: Property 'window' doesn't exist.This renames the binding to
windowDimensions, which Reanimated captures, and removes the Dimensions subscription when the hook unmounts so repeated sheet mounts do not accumulate listeners.Closes #2734
Verification
__closure = {}while its worklet body referencedwindow.__closure = { windowDimensions: windowDimensions }and includessubscription.remove()cleanup.yarn typescriptyarn buildyarn biome check --error-on-warnings src/hooks/useAnimatedLayout.tsyarn lintreaches one pre-existing warning insrc/hooks/useBoundingClientRect.ts:54; the changed file is clean.