Search code examples
reactjsreact-nativeecmascript-6destructuring

React-native animated.event custom onScroll listener


In official react-native documentation there is a section about Animated.event method. As example they use following code:

onScroll={Animated.event(
   // scrollX = e.nativeEvent.contentOffset.x
   [{ nativeEvent: {
        contentOffset: {
          x: scrollX
        }
      }
    }]
 )}

I would like to map correct values to Animated.event method and I would also like to map onScroll callback parameters to my own callback. Basically I would like to do something like this:

onScroll={(event) => {
  myOwnCallback(event.nativeEvent.contentOffset.x)
  Animated.event(
    // scrollX = e.nativeEvent.contentOffset.x
    [{nativeEvent: {
        contentOffset: {
          x: scrollX
        }
      }
    }]
  )
}}

Could you please explain how to do that?


Solution

  • When you look at the source code:

    /**
       * Takes an array of mappings and extracts values from each arg accordingly,
       * then calls `setValue` on the mapped outputs.  e.g.
       *
       *```javascript
       *  onScroll={Animated.event(
       *    [{nativeEvent: {contentOffset: {x: this._scrollX}}}]
       *    {listener},          // Optional async listener
       *  )
       *  ...
       *  onPanResponderMove: Animated.event([
       *    null,                // raw event arg ignored
       *    {dx: this._panX},    // gestureState arg
       *  ]),
       *```
       *
       * Config is an object that may have the following options:
       *
       *   - `listener`: Optional async listener.
       *   - `useNativeDriver`: Uses the native driver when true. Default false.
       */
      event,
    

    This is how I made it work:

    onScroll={Animated.event(
                [{ nativeEvent: { contentOffset: { y: this.state.scrollY } } }],
      {
        useNativeDriver: true,
        listener: event => {
          const offsetY = event.nativeEvent.contentOffset.y
          // do something special
        },
      },
    )}