Rename ref & aref -> animatedRef in types
#4469
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
fluiddot
pushed a commit
to wordpress-mobile/react-native-reanimated
that referenced
this pull request
Jun 5, 2023
For better DX and consistency with the docs (current and the new ones) I've decided to rename the first argument of `useScrollViewOffset`, `measure`, `getRelativeCoords`, and `scrollTo` to `animatedRef`. ### Motivation Just `ref` as an argument indicates that a plain `const ref = React.useRef()` works with these functions leading to a confusing developer experience. Also, `aref` is a bit cryptic and a hard thing to look up on the Internet when just starting to learn Reanimated.
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.
For better DX and consistency with the docs (current and the new ones) I've decided to rename the first argument of
useScrollViewOffset,measure,getRelativeCoords, andscrollTotoanimatedRef.Motivation
Just
refas an argument indicates that a plainconst ref = React.useRef()works with these functions leading to a confusing developer experience.Also,
arefis a bit cryptic and a hard thing to look up on the Internet when just starting to learn Reanimated.