about summary refs log tree commit diff
path: root/src/lib/hooks/useAnimatedScrollHandler_FIXED.ts
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/hooks/useAnimatedScrollHandler_FIXED.ts')
-rw-r--r--src/lib/hooks/useAnimatedScrollHandler_FIXED.ts14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/lib/hooks/useAnimatedScrollHandler_FIXED.ts b/src/lib/hooks/useAnimatedScrollHandler_FIXED.ts
index eccfabbb0..56a1e8b11 100644
--- a/src/lib/hooks/useAnimatedScrollHandler_FIXED.ts
+++ b/src/lib/hooks/useAnimatedScrollHandler_FIXED.ts
@@ -1 +1,15 @@
+// Be warned. This Hook is very buggy unless used in a very constrained way.
+// To use it safely:
+//
+// - DO NOT pass its return value as a prop to any user-defined component.
+// - DO NOT pass its return value to more than a single component.
+//
+// In other words, the only safe way to use it is next to the leaf Reanimated View.
+//
+// Relevant bug reports:
+// - https://github.com/software-mansion/react-native-reanimated/issues/5345
+// - https://github.com/software-mansion/react-native-reanimated/issues/5360
+// - https://github.com/software-mansion/react-native-reanimated/issues/5364
+//
+// It's great when it works though.
 export {useAnimatedScrollHandler} from 'react-native-reanimated'