diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 1bc4a8b..64b362b 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE43QzwvCIBTA8f/lnaUgagevuxYEQZexg6lDmdNwb/SL/e9Rh2ybK68+30f8Fg9AeUWgsGX3W660EUDgzFABhcaJzsh2+RktFDYGCNTaCqArAvx16qUFWkyhnBlzYrxug6gtSl8xPkCnC6N3NllPpvzeu3My/b6cxAax6ixH7WwUHFrZui9H2IF7Z8xRy0s8aJgnVw0rO4nKifnff+HRxX8lwsLvyrPvJPWOJRpGn/Uj+csnppI/WswCAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE52QywrCMBRE/+Wug4JoF9m6VRAEN6WLkNySYJqU9Jb6oP8uujA+EiluZ5gzw5RXIDwRcNiIy3mtjVXAoBWkgUPjVW+xmz+tmabGAoOjcQr4goG8qwEd8PIXqO6dJOPdKyoDLZZjNbI32F4Gb+3B4JCeFv3J+2Jki6S96iLZOMJQC/kNTwY/KldFdvwu+PaPnkdsekvu9Cw/cX91Axy86U4WAgAA" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 05ff4f1..d87d9af 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE82ZS2/bOBDHvwtzVVzPUJIf1yKHBbZAgRY5rGAUrkSvicqSISlpEiPffaEnSZO0Kcdd+CRD0vznwZ85JHUgRf67JMvoQH7xLCFL9Ei23jGyJH+v314/b3maEI88FSlZkl2ePKWs/DQ8mWyrXUo8EqfrsmQlWRLy7vVKoX9CavOUxRXPM1nslKxH9uuCZZUiJnxhEOrOPq/T9Oc6/lUOXnlWsWKzjpnR7fD+eP8wRZFtnj3Ufr5vC1Zu8zT5ui4vC+HOonQmLoOcPCxBQEWxfvyoXvfsetFNBsHxQU6M6dqL/MKr69TYIHQ7JT4OrqvwPV5cYy1da4kfecl/8pRXr83AXJqDLnMz5T0KrS+uf2lxj1N1Ke0Lr64Qfqtyi4V94VVf1/AKda0TPTPzfy3yvet00Lz7wRk/rh8WLBvt8k6ydK5Lm50llD0rYpZVTb1SNvzPx0dmF7pOoPzfLC/YP6zIv7B1+VSwXa0zOkybzHWC/EArl2I828arMrnn5T3PtqzgFUtGhvyB/+2ZKC9o563i/9PK1ehPtvFbKfFV2vlQ4z/dypXYT7XxGynvNdp5X9w/28ptYR+38dsr7KXt3FDXo1auNPJvcZGn6SNnv437T/H45Cb0eHkgzL6wapsn1plG0jfanV8xSAlY0CmbN77nH4rhTlJxCcYsdSEy4yJ06SZnFYd0zxT1W7UurH/GcXH3Ujde3iZMtynPucpt6mdK/ZBZ15fjMmiFbrzMD1ni1rSdi1yn7TJlndzWWL05bnDOT1f5ZlOy8X8puY/0ChcU7eQ6vWCbj8TVml8hqKMzT0MPUw8+rcLjxmvlEZ4l7IUsD+SZFSXPM7IkOKGTBfHIhrM0qc9429A8Eue7bpeU5PFT83PVvfbI4iov6pfbtz9NiRdNPQwn4QxXKy/qjZsHzY1eQ9xpDMFmCJohKIZIvAg8CpPZHBRD1AxRMaTEi9DkkWqGVDH0iRdRD2Dig2roa4a+YhgQL/JNHgPNMFAMQ5vHUDMMFcMZ8aLA5HGmGc4Uw7nN41wznCuGC+JFocnjQjNcqABMbS5BZweO4KmRmJkgAAM+Kj9QUzE32uoEgYoQ1GAsjLY6RKBSBDUbMDUa6yCBShIENnhBZwlUmMBKE+g4gcoTzGwIg04UqEiBlSnQoQKVKljYQAadK1DBQitYqIOFKlgINpxRBwuPJia0+jVMTSpYWLMCYHSsk4UqWdiQhcY5UScLVbKwhgWo0VhHC1W00IoW6mihihbWtIBvdKyzhSpbaGULdbZQZQtrXCAwOtbhQhUuaoWL6nBRFS5a8wKhyTHV6aIqXbTpe8Y5j+p40aPW1+BlnPSoofupeFHfyibV8epuNUuOZ1ZULPmrXXpE0bDMPpAf3XqE9uuhA/HJ8vDukbC9zNsLTLtrdxu6+9jdR+yu3XPsntPm+btYyzR3h+VM/azJYzheFyHNRUiATirtGfMbK/KdfMYsJGEqafpOmun67TVuP4kLHUmmr8s4sVh88paiE6pu+Q5y+3bDIaRmUp7uobX7nOdmGSyFJcdFu2F1L54Q3fUnOZI2StqXaGqZQygUqVvq/W5HEpHqR93GIs9YvZ+p+lPefXOwLSSlRLsaQuAq/MIrq64vdINOd+ao+zwc8LH2nFioBkJ11qkuxqs2Z6RCVBqZRTdLuA1Q94nruf3EVYlPXEJ7IQFPnUSbvaQ05NJ0Q90UWgqrXJGRJlJ0G+BehmVKRiCNAboVv1cq23MwSUuiBB3wWHlkz/cs5Rkjy2j1/v4ff4S88n8kAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE82WS2+jMBDHv8v06qXYvLmuelhpV1qpq15QVCEwClrAEZB00yjffQUOGNcmr3Loicj2/zePzHh8gJq9NRBGB/ibVymEBEEVlxRC+Bm/77+v8yIFBNu6gBBKlm4L2jyOO8a6LQtAkBRx09AGQoAjGkiufQaVbaukzVk1hZ3DItjENa1aCSZsyV4/JzUripecvmldF9tn/SeOO0P9Rds1S5sRnlctrbM4Ufla3eXwJgEIf7BJREab/sQf9ikfHiaUa5zRo6Z/ueNYImmvr+1+Q5fx0Bhh9ztqjOFeSOpzG9ftMn4PqC+e3t7NU46/2ctkmYd+IdVPVbpMBBz0xdP8VKVDkskySe7CvubK+l2zze0XVq9a4rpiWdbQ21tK2H8YCXckjQc/41pNs8/4xeULOPVhXGpmmDwzZ8G3/V8rBHmV0n8QHmBH6yZnFYRADMsIAEGW0yLtngfcNQQJK8sOhCBlybb/uTode6FJy+ruMD/9aAKKTIQ9I8D+aoWiQdxv9AsDQ6z0QjwnxIoQS0ICKMI6IVGERBJagCKCiGWYxJWEliK0JKENKLJ0QlsR2pLQARTZCNuG41iS0FGEjiR0AUWOzqKrCF1J6M1Z9BShJwl9QJGrs+grQl8SBnMWA0UYyAXQ1YOnM4nV2sEfiqcrCV+r1ZSPXD+4q4pAq1UrCMslhK254sNqEZ2W+ubb0bql6Q/ehFE0DpwDvJ46c7wZDuBAeDgi8Pgn6D5H0ZX94tiY3V5ntYjf9wl/fQumKZgm1+GrYXz47Pq7SRCxIJIT0boDWQ6Pa0EmgnwPccNnn+B5gofNq4DD9BEMf8K4LnP9pBCAYAIgVwF4RC2bUixBsW+C0EoqB1dw/Js4DX/gCpIjSO5l0grBJt/QIq8ohNHqePwPXAgXQZEOAAA="; \ No newline at end of file diff --git a/docs/functions/LazyChild.LazyChild.html b/docs/functions/LazyChild.LazyChild.html index 1585e4d..41da3dc 100644 --- a/docs/functions/LazyChild.LazyChild.html +++ b/docs/functions/LazyChild.LazyChild.html @@ -1 +1 @@ -LazyChild | react-native-lazy-scrollview

Function LazyChild

Settings

Member Visibility
+LazyChild | react-native-lazy-scrollview

Function LazyChild

Settings

Member Visibility
diff --git a/docs/functions/LazyScrollView.LazyScrollView.html b/docs/functions/LazyScrollView.LazyScrollView.html index 52a867f..1a20324 100644 --- a/docs/functions/LazyScrollView.LazyScrollView.html +++ b/docs/functions/LazyScrollView.LazyScrollView.html @@ -1,7 +1,7 @@ LazyScrollView | react-native-lazy-scrollview

Function LazyScrollView

ScrollView to wrap Lazy Children in.

  • LazyScrollView(props): null | ReactElement<any, string | JSXElementConstructor<any>>

  • NOTE: Exotic components are not callable.

    -

    Parameters

    • props: Pick<Props,
          | "children"
          | "style"
          | "hitSlop"
          | "pointerEvents"
          | "removeClippedSubviews"
          | "testID"
          | "nativeID"
          | "collapsable"
          | "needsOffscreenAlphaCompositing"
          | "renderToHardwareTextureAndroid"
          | "focusable"
          | "shouldRasterizeIOS"
          | "isTVSelectable"
          | "hasTVPreferredFocus"
          | "tvParallaxProperties"
          | "tvParallaxShiftDistanceX"
          | "tvParallaxShiftDistanceY"
          | "tvParallaxTiltAngle"
          | "tvParallaxMagnification"
          | "onStartShouldSetResponder"
          | "onMoveShouldSetResponder"
          | "onResponderEnd"
          | "onResponderGrant"
          | "onResponderReject"
          | "onResponderMove"
          | "onResponderRelease"
          | "onResponderStart"
          | "onResponderTerminationRequest"
          | "onResponderTerminate"
          | "onStartShouldSetResponderCapture"
          | "onMoveShouldSetResponderCapture"
          | "onTouchStart"
          | "onTouchMove"
          | "onTouchEnd"
          | "onTouchCancel"
          | "onTouchEndCapture"
          | "onPointerEnter"
          | "onPointerEnterCapture"
          | "onPointerLeave"
          | "onPointerLeaveCapture"
          | "onPointerMove"
          | "onPointerMoveCapture"
          | "onPointerCancel"
          | "onPointerCancelCapture"
          | "onPointerDown"
          | "onPointerDownCapture"
          | "onPointerUp"
          | "onPointerUpCapture"
          | "accessible"
          | "accessibilityActions"
          | "accessibilityLabel"
          | "accessibilityRole"
          | "accessibilityState"
          | "accessibilityHint"
          | "accessibilityValue"
          | "onAccessibilityAction"
          | "accessibilityLiveRegion"
          | "importantForAccessibility"
          | "accessibilityElementsHidden"
          | "accessibilityViewIsModal"
          | "onAccessibilityEscape"
          | "onAccessibilityTap"
          | "onMagicTap"
          | "accessibilityIgnoresInvertColors"
          | "animatedProps"
          | "layout"
          | "entering"
          | "exiting"
          | "contentContainerStyle"
          | "decelerationRate"
          | "horizontal"
          | "invertStickyHeaders"
          | "keyboardDismissMode"
          | "keyboardShouldPersistTaps"
          | "onContentSizeChange"
          | "onScrollBeginDrag"
          | "onScrollEndDrag"
          | "onMomentumScrollEnd"
          | "onMomentumScrollBegin"
          | "pagingEnabled"
          | "scrollEnabled"
          | "showsHorizontalScrollIndicator"
          | "showsVerticalScrollIndicator"
          | "stickyHeaderHiddenOnScroll"
          | "refreshControl"
          | "snapToInterval"
          | "snapToOffsets"
          | "snapToStart"
          | "snapToEnd"
          | "stickyHeaderIndices"
          | "disableIntervalMomentum"
          | "disableScrollViewPanResponder"
          | "StickyHeaderComponent"
          | "alwaysBounceHorizontal"
          | "alwaysBounceVertical"
          | "automaticallyAdjustContentInsets"
          | "automaticallyAdjustKeyboardInsets"
          | "automaticallyAdjustsScrollIndicatorInsets"
          | "bounces"
          | "bouncesZoom"
          | "canCancelContentTouches"
          | "centerContent"
          | "contentInset"
          | "contentOffset"
          | "contentInsetAdjustmentBehavior"
          | "directionalLockEnabled"
          | "indicatorStyle"
          | "maintainVisibleContentPosition"
          | "maximumZoomScale"
          | "minimumZoomScale"
          | "onScrollAnimationEnd"
          | "pinchGestureEnabled"
          | "scrollEventThrottle"
          | "scrollIndicatorInsets"
          | "scrollToOverflowEnabled"
          | "scrollsToTop"
          | "snapToAlignment"
          | "onScrollToTop"
          | "zoomScale"
          | "endFillColor"
          | "scrollPerfTag"
          | "overScrollMode"
          | "nestedScrollEnabled"
          | "fadingEdgeLength"
          | "persistentScrollbar"
          | "offset"> & RefAttributes<LazyScrollViewMethods>

    Returns null | ReactElement<any, string | JSXElementConstructor<any>>

Properties

$$typeof +

Parameters

  • props: Pick<Props,
        | "children"
        | "style"
        | "hitSlop"
        | "pointerEvents"
        | "removeClippedSubviews"
        | "testID"
        | "nativeID"
        | "collapsable"
        | "needsOffscreenAlphaCompositing"
        | "renderToHardwareTextureAndroid"
        | "focusable"
        | "shouldRasterizeIOS"
        | "isTVSelectable"
        | "hasTVPreferredFocus"
        | "tvParallaxProperties"
        | "tvParallaxShiftDistanceX"
        | "tvParallaxShiftDistanceY"
        | "tvParallaxTiltAngle"
        | "tvParallaxMagnification"
        | "onStartShouldSetResponder"
        | "onMoveShouldSetResponder"
        | "onResponderEnd"
        | "onResponderGrant"
        | "onResponderReject"
        | "onResponderMove"
        | "onResponderRelease"
        | "onResponderStart"
        | "onResponderTerminationRequest"
        | "onResponderTerminate"
        | "onStartShouldSetResponderCapture"
        | "onMoveShouldSetResponderCapture"
        | "onTouchStart"
        | "onTouchMove"
        | "onTouchEnd"
        | "onTouchCancel"
        | "onTouchEndCapture"
        | "onPointerEnter"
        | "onPointerEnterCapture"
        | "onPointerLeave"
        | "onPointerLeaveCapture"
        | "onPointerMove"
        | "onPointerMoveCapture"
        | "onPointerCancel"
        | "onPointerCancelCapture"
        | "onPointerDown"
        | "onPointerDownCapture"
        | "onPointerUp"
        | "onPointerUpCapture"
        | "accessible"
        | "accessibilityActions"
        | "accessibilityLabel"
        | "accessibilityRole"
        | "accessibilityState"
        | "accessibilityHint"
        | "accessibilityValue"
        | "onAccessibilityAction"
        | "accessibilityLiveRegion"
        | "importantForAccessibility"
        | "accessibilityElementsHidden"
        | "accessibilityViewIsModal"
        | "onAccessibilityEscape"
        | "onAccessibilityTap"
        | "onMagicTap"
        | "accessibilityIgnoresInvertColors"
        | "layout"
        | "entering"
        | "exiting"
        | "sharedTransitionTag"
        | "sharedTransitionStyle"
        | "animatedProps"
        | "contentContainerStyle"
        | "decelerationRate"
        | "horizontal"
        | "invertStickyHeaders"
        | "keyboardDismissMode"
        | "keyboardShouldPersistTaps"
        | "onContentSizeChange"
        | "onScrollBeginDrag"
        | "onScrollEndDrag"
        | "onMomentumScrollEnd"
        | "onMomentumScrollBegin"
        | "pagingEnabled"
        | "scrollEnabled"
        | "showsHorizontalScrollIndicator"
        | "showsVerticalScrollIndicator"
        | "stickyHeaderHiddenOnScroll"
        | "refreshControl"
        | "snapToInterval"
        | "snapToOffsets"
        | "snapToStart"
        | "snapToEnd"
        | "stickyHeaderIndices"
        | "disableIntervalMomentum"
        | "disableScrollViewPanResponder"
        | "StickyHeaderComponent"
        | "alwaysBounceHorizontal"
        | "alwaysBounceVertical"
        | "automaticallyAdjustContentInsets"
        | "automaticallyAdjustKeyboardInsets"
        | "automaticallyAdjustsScrollIndicatorInsets"
        | "bounces"
        | "bouncesZoom"
        | "canCancelContentTouches"
        | "centerContent"
        | "contentInset"
        | "contentOffset"
        | "contentInsetAdjustmentBehavior"
        | "directionalLockEnabled"
        | "indicatorStyle"
        | "maintainVisibleContentPosition"
        | "maximumZoomScale"
        | "minimumZoomScale"
        | "onScrollAnimationEnd"
        | "pinchGestureEnabled"
        | "scrollEventThrottle"
        | "scrollIndicatorInsets"
        | "scrollToOverflowEnabled"
        | "scrollsToTop"
        | "snapToAlignment"
        | "onScrollToTop"
        | "zoomScale"
        | "endFillColor"
        | "scrollPerfTag"
        | "overScrollMode"
        | "nestedScrollEnabled"
        | "fadingEdgeLength"
        | "persistentScrollbar"
        | "scrollViewOffset"
        | "key"
        | "offset"> & RefAttributes<LazyScrollViewMethods>

Returns null | ReactElement<any, string | JSXElementConstructor<any>>

Properties

$$typeof defaultProps? displayName? propTypes? -

Properties

Readonly$$typeof

$$typeof: symbol

OptionaldefaultProps

defaultProps?: Partial<Pick<Props,
    | "children"
    | "style"
    | "hitSlop"
    | "pointerEvents"
    | "removeClippedSubviews"
    | "testID"
    | "nativeID"
    | "collapsable"
    | "needsOffscreenAlphaCompositing"
    | "renderToHardwareTextureAndroid"
    | "focusable"
    | "shouldRasterizeIOS"
    | "isTVSelectable"
    | "hasTVPreferredFocus"
    | "tvParallaxProperties"
    | "tvParallaxShiftDistanceX"
    | "tvParallaxShiftDistanceY"
    | "tvParallaxTiltAngle"
    | "tvParallaxMagnification"
    | "onStartShouldSetResponder"
    | "onMoveShouldSetResponder"
    | "onResponderEnd"
    | "onResponderGrant"
    | "onResponderReject"
    | "onResponderMove"
    | "onResponderRelease"
    | "onResponderStart"
    | "onResponderTerminationRequest"
    | "onResponderTerminate"
    | "onStartShouldSetResponderCapture"
    | "onMoveShouldSetResponderCapture"
    | "onTouchStart"
    | "onTouchMove"
    | "onTouchEnd"
    | "onTouchCancel"
    | "onTouchEndCapture"
    | "onPointerEnter"
    | "onPointerEnterCapture"
    | "onPointerLeave"
    | "onPointerLeaveCapture"
    | "onPointerMove"
    | "onPointerMoveCapture"
    | "onPointerCancel"
    | "onPointerCancelCapture"
    | "onPointerDown"
    | "onPointerDownCapture"
    | "onPointerUp"
    | "onPointerUpCapture"
    | "accessible"
    | "accessibilityActions"
    | "accessibilityLabel"
    | "accessibilityRole"
    | "accessibilityState"
    | "accessibilityHint"
    | "accessibilityValue"
    | "onAccessibilityAction"
    | "accessibilityLiveRegion"
    | "importantForAccessibility"
    | "accessibilityElementsHidden"
    | "accessibilityViewIsModal"
    | "onAccessibilityEscape"
    | "onAccessibilityTap"
    | "onMagicTap"
    | "accessibilityIgnoresInvertColors"
    | "animatedProps"
    | "layout"
    | "entering"
    | "exiting"
    | "contentContainerStyle"
    | "decelerationRate"
    | "horizontal"
    | "invertStickyHeaders"
    | "keyboardDismissMode"
    | "keyboardShouldPersistTaps"
    | "onContentSizeChange"
    | "onScrollBeginDrag"
    | "onScrollEndDrag"
    | "onMomentumScrollEnd"
    | "onMomentumScrollBegin"
    | "pagingEnabled"
    | "scrollEnabled"
    | "showsHorizontalScrollIndicator"
    | "showsVerticalScrollIndicator"
    | "stickyHeaderHiddenOnScroll"
    | "refreshControl"
    | "snapToInterval"
    | "snapToOffsets"
    | "snapToStart"
    | "snapToEnd"
    | "stickyHeaderIndices"
    | "disableIntervalMomentum"
    | "disableScrollViewPanResponder"
    | "StickyHeaderComponent"
    | "alwaysBounceHorizontal"
    | "alwaysBounceVertical"
    | "automaticallyAdjustContentInsets"
    | "automaticallyAdjustKeyboardInsets"
    | "automaticallyAdjustsScrollIndicatorInsets"
    | "bounces"
    | "bouncesZoom"
    | "canCancelContentTouches"
    | "centerContent"
    | "contentInset"
    | "contentOffset"
    | "contentInsetAdjustmentBehavior"
    | "directionalLockEnabled"
    | "indicatorStyle"
    | "maintainVisibleContentPosition"
    | "maximumZoomScale"
    | "minimumZoomScale"
    | "onScrollAnimationEnd"
    | "pinchGestureEnabled"
    | "scrollEventThrottle"
    | "scrollIndicatorInsets"
    | "scrollToOverflowEnabled"
    | "scrollsToTop"
    | "snapToAlignment"
    | "onScrollToTop"
    | "zoomScale"
    | "endFillColor"
    | "scrollPerfTag"
    | "overScrollMode"
    | "nestedScrollEnabled"
    | "fadingEdgeLength"
    | "persistentScrollbar"
    | "offset"> & RefAttributes<LazyScrollViewMethods>>

OptionaldisplayName

displayName?: string

OptionalpropTypes

propTypes?: WeakValidationMap<Pick<Props,
    | "children"
    | "style"
    | "hitSlop"
    | "pointerEvents"
    | "removeClippedSubviews"
    | "testID"
    | "nativeID"
    | "collapsable"
    | "needsOffscreenAlphaCompositing"
    | "renderToHardwareTextureAndroid"
    | "focusable"
    | "shouldRasterizeIOS"
    | "isTVSelectable"
    | "hasTVPreferredFocus"
    | "tvParallaxProperties"
    | "tvParallaxShiftDistanceX"
    | "tvParallaxShiftDistanceY"
    | "tvParallaxTiltAngle"
    | "tvParallaxMagnification"
    | "onStartShouldSetResponder"
    | "onMoveShouldSetResponder"
    | "onResponderEnd"
    | "onResponderGrant"
    | "onResponderReject"
    | "onResponderMove"
    | "onResponderRelease"
    | "onResponderStart"
    | "onResponderTerminationRequest"
    | "onResponderTerminate"
    | "onStartShouldSetResponderCapture"
    | "onMoveShouldSetResponderCapture"
    | "onTouchStart"
    | "onTouchMove"
    | "onTouchEnd"
    | "onTouchCancel"
    | "onTouchEndCapture"
    | "onPointerEnter"
    | "onPointerEnterCapture"
    | "onPointerLeave"
    | "onPointerLeaveCapture"
    | "onPointerMove"
    | "onPointerMoveCapture"
    | "onPointerCancel"
    | "onPointerCancelCapture"
    | "onPointerDown"
    | "onPointerDownCapture"
    | "onPointerUp"
    | "onPointerUpCapture"
    | "accessible"
    | "accessibilityActions"
    | "accessibilityLabel"
    | "accessibilityRole"
    | "accessibilityState"
    | "accessibilityHint"
    | "accessibilityValue"
    | "onAccessibilityAction"
    | "accessibilityLiveRegion"
    | "importantForAccessibility"
    | "accessibilityElementsHidden"
    | "accessibilityViewIsModal"
    | "onAccessibilityEscape"
    | "onAccessibilityTap"
    | "onMagicTap"
    | "accessibilityIgnoresInvertColors"
    | "animatedProps"
    | "layout"
    | "entering"
    | "exiting"
    | "contentContainerStyle"
    | "decelerationRate"
    | "horizontal"
    | "invertStickyHeaders"
    | "keyboardDismissMode"
    | "keyboardShouldPersistTaps"
    | "onContentSizeChange"
    | "onScrollBeginDrag"
    | "onScrollEndDrag"
    | "onMomentumScrollEnd"
    | "onMomentumScrollBegin"
    | "pagingEnabled"
    | "scrollEnabled"
    | "showsHorizontalScrollIndicator"
    | "showsVerticalScrollIndicator"
    | "stickyHeaderHiddenOnScroll"
    | "refreshControl"
    | "snapToInterval"
    | "snapToOffsets"
    | "snapToStart"
    | "snapToEnd"
    | "stickyHeaderIndices"
    | "disableIntervalMomentum"
    | "disableScrollViewPanResponder"
    | "StickyHeaderComponent"
    | "alwaysBounceHorizontal"
    | "alwaysBounceVertical"
    | "automaticallyAdjustContentInsets"
    | "automaticallyAdjustKeyboardInsets"
    | "automaticallyAdjustsScrollIndicatorInsets"
    | "bounces"
    | "bouncesZoom"
    | "canCancelContentTouches"
    | "centerContent"
    | "contentInset"
    | "contentOffset"
    | "contentInsetAdjustmentBehavior"
    | "directionalLockEnabled"
    | "indicatorStyle"
    | "maintainVisibleContentPosition"
    | "maximumZoomScale"
    | "minimumZoomScale"
    | "onScrollAnimationEnd"
    | "pinchGestureEnabled"
    | "scrollEventThrottle"
    | "scrollIndicatorInsets"
    | "scrollToOverflowEnabled"
    | "scrollsToTop"
    | "snapToAlignment"
    | "onScrollToTop"
    | "zoomScale"
    | "endFillColor"
    | "scrollPerfTag"
    | "overScrollMode"
    | "nestedScrollEnabled"
    | "fadingEdgeLength"
    | "persistentScrollbar"
    | "offset"> & RefAttributes<LazyScrollViewMethods>>

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonly$$typeof

$$typeof: symbol

OptionaldefaultProps

defaultProps?: Partial<Pick<Props,
    | "children"
    | "style"
    | "hitSlop"
    | "pointerEvents"
    | "removeClippedSubviews"
    | "testID"
    | "nativeID"
    | "collapsable"
    | "needsOffscreenAlphaCompositing"
    | "renderToHardwareTextureAndroid"
    | "focusable"
    | "shouldRasterizeIOS"
    | "isTVSelectable"
    | "hasTVPreferredFocus"
    | "tvParallaxProperties"
    | "tvParallaxShiftDistanceX"
    | "tvParallaxShiftDistanceY"
    | "tvParallaxTiltAngle"
    | "tvParallaxMagnification"
    | "onStartShouldSetResponder"
    | "onMoveShouldSetResponder"
    | "onResponderEnd"
    | "onResponderGrant"
    | "onResponderReject"
    | "onResponderMove"
    | "onResponderRelease"
    | "onResponderStart"
    | "onResponderTerminationRequest"
    | "onResponderTerminate"
    | "onStartShouldSetResponderCapture"
    | "onMoveShouldSetResponderCapture"
    | "onTouchStart"
    | "onTouchMove"
    | "onTouchEnd"
    | "onTouchCancel"
    | "onTouchEndCapture"
    | "onPointerEnter"
    | "onPointerEnterCapture"
    | "onPointerLeave"
    | "onPointerLeaveCapture"
    | "onPointerMove"
    | "onPointerMoveCapture"
    | "onPointerCancel"
    | "onPointerCancelCapture"
    | "onPointerDown"
    | "onPointerDownCapture"
    | "onPointerUp"
    | "onPointerUpCapture"
    | "accessible"
    | "accessibilityActions"
    | "accessibilityLabel"
    | "accessibilityRole"
    | "accessibilityState"
    | "accessibilityHint"
    | "accessibilityValue"
    | "onAccessibilityAction"
    | "accessibilityLiveRegion"
    | "importantForAccessibility"
    | "accessibilityElementsHidden"
    | "accessibilityViewIsModal"
    | "onAccessibilityEscape"
    | "onAccessibilityTap"
    | "onMagicTap"
    | "accessibilityIgnoresInvertColors"
    | "layout"
    | "entering"
    | "exiting"
    | "sharedTransitionTag"
    | "sharedTransitionStyle"
    | "animatedProps"
    | "contentContainerStyle"
    | "decelerationRate"
    | "horizontal"
    | "invertStickyHeaders"
    | "keyboardDismissMode"
    | "keyboardShouldPersistTaps"
    | "onContentSizeChange"
    | "onScrollBeginDrag"
    | "onScrollEndDrag"
    | "onMomentumScrollEnd"
    | "onMomentumScrollBegin"
    | "pagingEnabled"
    | "scrollEnabled"
    | "showsHorizontalScrollIndicator"
    | "showsVerticalScrollIndicator"
    | "stickyHeaderHiddenOnScroll"
    | "refreshControl"
    | "snapToInterval"
    | "snapToOffsets"
    | "snapToStart"
    | "snapToEnd"
    | "stickyHeaderIndices"
    | "disableIntervalMomentum"
    | "disableScrollViewPanResponder"
    | "StickyHeaderComponent"
    | "alwaysBounceHorizontal"
    | "alwaysBounceVertical"
    | "automaticallyAdjustContentInsets"
    | "automaticallyAdjustKeyboardInsets"
    | "automaticallyAdjustsScrollIndicatorInsets"
    | "bounces"
    | "bouncesZoom"
    | "canCancelContentTouches"
    | "centerContent"
    | "contentInset"
    | "contentOffset"
    | "contentInsetAdjustmentBehavior"
    | "directionalLockEnabled"
    | "indicatorStyle"
    | "maintainVisibleContentPosition"
    | "maximumZoomScale"
    | "minimumZoomScale"
    | "onScrollAnimationEnd"
    | "pinchGestureEnabled"
    | "scrollEventThrottle"
    | "scrollIndicatorInsets"
    | "scrollToOverflowEnabled"
    | "scrollsToTop"
    | "snapToAlignment"
    | "onScrollToTop"
    | "zoomScale"
    | "endFillColor"
    | "scrollPerfTag"
    | "overScrollMode"
    | "nestedScrollEnabled"
    | "fadingEdgeLength"
    | "persistentScrollbar"
    | "scrollViewOffset"
    | "key"
    | "offset"> & RefAttributes<LazyScrollViewMethods>>

OptionaldisplayName

displayName?: string

OptionalpropTypes

propTypes?: WeakValidationMap<Pick<Props,
    | "children"
    | "style"
    | "hitSlop"
    | "pointerEvents"
    | "removeClippedSubviews"
    | "testID"
    | "nativeID"
    | "collapsable"
    | "needsOffscreenAlphaCompositing"
    | "renderToHardwareTextureAndroid"
    | "focusable"
    | "shouldRasterizeIOS"
    | "isTVSelectable"
    | "hasTVPreferredFocus"
    | "tvParallaxProperties"
    | "tvParallaxShiftDistanceX"
    | "tvParallaxShiftDistanceY"
    | "tvParallaxTiltAngle"
    | "tvParallaxMagnification"
    | "onStartShouldSetResponder"
    | "onMoveShouldSetResponder"
    | "onResponderEnd"
    | "onResponderGrant"
    | "onResponderReject"
    | "onResponderMove"
    | "onResponderRelease"
    | "onResponderStart"
    | "onResponderTerminationRequest"
    | "onResponderTerminate"
    | "onStartShouldSetResponderCapture"
    | "onMoveShouldSetResponderCapture"
    | "onTouchStart"
    | "onTouchMove"
    | "onTouchEnd"
    | "onTouchCancel"
    | "onTouchEndCapture"
    | "onPointerEnter"
    | "onPointerEnterCapture"
    | "onPointerLeave"
    | "onPointerLeaveCapture"
    | "onPointerMove"
    | "onPointerMoveCapture"
    | "onPointerCancel"
    | "onPointerCancelCapture"
    | "onPointerDown"
    | "onPointerDownCapture"
    | "onPointerUp"
    | "onPointerUpCapture"
    | "accessible"
    | "accessibilityActions"
    | "accessibilityLabel"
    | "accessibilityRole"
    | "accessibilityState"
    | "accessibilityHint"
    | "accessibilityValue"
    | "onAccessibilityAction"
    | "accessibilityLiveRegion"
    | "importantForAccessibility"
    | "accessibilityElementsHidden"
    | "accessibilityViewIsModal"
    | "onAccessibilityEscape"
    | "onAccessibilityTap"
    | "onMagicTap"
    | "accessibilityIgnoresInvertColors"
    | "layout"
    | "entering"
    | "exiting"
    | "sharedTransitionTag"
    | "sharedTransitionStyle"
    | "animatedProps"
    | "contentContainerStyle"
    | "decelerationRate"
    | "horizontal"
    | "invertStickyHeaders"
    | "keyboardDismissMode"
    | "keyboardShouldPersistTaps"
    | "onContentSizeChange"
    | "onScrollBeginDrag"
    | "onScrollEndDrag"
    | "onMomentumScrollEnd"
    | "onMomentumScrollBegin"
    | "pagingEnabled"
    | "scrollEnabled"
    | "showsHorizontalScrollIndicator"
    | "showsVerticalScrollIndicator"
    | "stickyHeaderHiddenOnScroll"
    | "refreshControl"
    | "snapToInterval"
    | "snapToOffsets"
    | "snapToStart"
    | "snapToEnd"
    | "stickyHeaderIndices"
    | "disableIntervalMomentum"
    | "disableScrollViewPanResponder"
    | "StickyHeaderComponent"
    | "alwaysBounceHorizontal"
    | "alwaysBounceVertical"
    | "automaticallyAdjustContentInsets"
    | "automaticallyAdjustKeyboardInsets"
    | "automaticallyAdjustsScrollIndicatorInsets"
    | "bounces"
    | "bouncesZoom"
    | "canCancelContentTouches"
    | "centerContent"
    | "contentInset"
    | "contentOffset"
    | "contentInsetAdjustmentBehavior"
    | "directionalLockEnabled"
    | "indicatorStyle"
    | "maintainVisibleContentPosition"
    | "maximumZoomScale"
    | "minimumZoomScale"
    | "onScrollAnimationEnd"
    | "pinchGestureEnabled"
    | "scrollEventThrottle"
    | "scrollIndicatorInsets"
    | "scrollToOverflowEnabled"
    | "scrollsToTop"
    | "snapToAlignment"
    | "onScrollToTop"
    | "zoomScale"
    | "endFillColor"
    | "scrollPerfTag"
    | "overScrollMode"
    | "nestedScrollEnabled"
    | "fadingEdgeLength"
    | "persistentScrollbar"
    | "scrollViewOffset"
    | "key"
    | "offset"> & RefAttributes<LazyScrollViewMethods>>

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/hierarchy.html b/docs/hierarchy.html deleted file mode 100644 index bef35de..0000000 --- a/docs/hierarchy.html +++ /dev/null @@ -1 +0,0 @@ -react-native-lazy-scrollview

react-native-lazy-scrollview

Class Hierarchy

Settings

Member Visibility
diff --git a/docs/index.html b/docs/index.html index 3880896..025bfd4 100644 --- a/docs/index.html +++ b/docs/index.html @@ -11,6 +11,7 @@

react-native-lazy-scrollview

Example: Say you have some components lower in your scoll that make expensive api calls. Give them a skeleton loader, make your threshold 300, and trigger your api call when the component is within 300 px of the bottom of the ScrollView by passing yourApiCall to the onEnterThresholdPass prop on the LazyChild that wraps your component. And then say you're like "yeah but I also want to know when 75% of this api-heavy component is viewable". Then set the percentVisibleThreshold on the LazyChild wrapping that sucker to 0.75, then trigger and analytic call with onVisibilityEnter! This will fire every time the component leaves or enters. It has onVisibilityExit, which you can use if you're feeling super froggy and want to pause a video when it goes under a certain percentage of viewable area, and if then you can use onExitThresholdPass to unmount the video and replace it with a spacer.

Notes

⚠️ Limitations

Currently only supports vertical ScrollView.

diff --git a/docs/interfaces/LazyChild.LazyChildCallbacks.html b/docs/interfaces/LazyChild.LazyChildCallbacks.html deleted file mode 100644 index 10d77a4..0000000 --- a/docs/interfaces/LazyChild.LazyChildCallbacks.html +++ /dev/null @@ -1,21 +0,0 @@ -LazyChildCallbacks | react-native-lazy-scrollview

Interface LazyChildCallbacks

interface LazyChildCallbacks {
    onEnterThresholdPass?: (() => void);
    onExitThresholdPass?: (() => void);
    onVisibilityEnter?: (() => void);
    onVisibilityExit?: (() => void);
}

Hierarchy (view full)

Properties

onEnterThresholdPass? -onExitThresholdPass? -onVisibilityEnter? -onVisibilityExit? -

Properties

OptionalonEnterThresholdPass

onEnterThresholdPass?: (() => void)

Callback to fire when the LazyChild passes the LazyScrollView's offset after being offscreen

-
    -
  • Note: This will only fire once and stop measuring if onExitThresholdPass is not provided.
    • -
-

OptionalonExitThresholdPass

onExitThresholdPass?: (() => void)

Callback to fire when the LazyChild passes the LazyScrollView's offset after being onscreen

-
    -
  • Note: This will not fire if onEnterThresholdPass has not fired.
    • -
-

OptionalonVisibilityEnter

onVisibilityEnter?: (() => void)

Callback to fire when the LazyChild's viewable area exceeds the percentVisibleThreshold.

-
    -
  • Note: This will only fire once and stop measuring if onVisibilityExit is not provided.
    • -
-

OptionalonVisibilityExit

onVisibilityExit?: (() => void)

Callback to fire when the LazyChild's viewable area goes under the percentVisibleThreshold after being above it.

-
    -
  • Note: This will not fire if onVisibilityEnter has not fired.
    • -
-

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/LazyChild.LazyChildProps.html b/docs/interfaces/LazyChild.LazyChildProps.html deleted file mode 100644 index 43ccc80..0000000 --- a/docs/interfaces/LazyChild.LazyChildProps.html +++ /dev/null @@ -1,33 +0,0 @@ -LazyChildProps | react-native-lazy-scrollview

Interface LazyChildProps

LazyChildProps

-
interface LazyChildProps {
    children: ReactNode;
    ignoreZeroMeasurement?: boolean;
    onEnterThresholdPass?: (() => void);
    onExitThresholdPass?: (() => void);
    onVisibilityEnter?: (() => void);
    onVisibilityExit?: (() => void);
    percentVisibleThreshold?: number;
}

Hierarchy (view full)

Properties

children -ignoreZeroMeasurement? -onEnterThresholdPass? -onExitThresholdPass? -onVisibilityEnter? -onVisibilityExit? -percentVisibleThreshold? -

Properties

children

children: ReactNode

OptionalignoreZeroMeasurement

ignoreZeroMeasurement?: boolean

Protects against firing callback on measurement with zero value. Good to set to false if you know the LazyChild is the first item in the LazyScrollview.

-

Default Value

true
-
- -

OptionalonEnterThresholdPass

onEnterThresholdPass?: (() => void)

Callback to fire when the LazyChild passes the LazyScrollView's offset after being offscreen

-
    -
  • Note: This will only fire once and stop measuring if onExitThresholdPass is not provided.
    • -
-

OptionalonExitThresholdPass

onExitThresholdPass?: (() => void)

Callback to fire when the LazyChild passes the LazyScrollView's offset after being onscreen

-
    -
  • Note: This will not fire if onEnterThresholdPass has not fired.
    • -
-

OptionalonVisibilityEnter

onVisibilityEnter?: (() => void)

Callback to fire when the LazyChild's viewable area exceeds the percentVisibleThreshold.

-
    -
  • Note: This will only fire once and stop measuring if onVisibilityExit is not provided.
    • -
-

OptionalonVisibilityExit

onVisibilityExit?: (() => void)

Callback to fire when the LazyChild's viewable area goes under the percentVisibleThreshold after being above it.

-
    -
  • Note: This will not fire if onVisibilityEnter has not fired.
    • -
-

OptionalpercentVisibleThreshold

percentVisibleThreshold?: number

How much of the LazyChild should be visible before the percent visible threshold is passed. For example, 0.5 would fire onPercentVisibleThresholdPass when 50% of the LazyChild is visible. This has no effect if onPercentVisibleThresholdPass is not provided.

-

Default Value

1.0
-
- -

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/LazyScrollView.LazyScrollViewMethods.html b/docs/interfaces/LazyScrollView.LazyScrollViewMethods.html index 426928b..a2bee3e 100644 --- a/docs/interfaces/LazyScrollView.LazyScrollViewMethods.html +++ b/docs/interfaces/LazyScrollView.LazyScrollViewMethods.html @@ -1,4 +1,4 @@ -LazyScrollViewMethods | react-native-lazy-scrollview

Interface LazyScrollViewMethods

interface LazyScrollViewMethods {
    scrollTo: ((y?: number | {
        animated?: boolean;
        x?: number;
        y?: number;
    }, x?: number, animated?: boolean) => void);
    scrollToEnd: ((options?: {
        animated: boolean;
    }) => void);
    scrollToStart: ((options?: {
        animated: boolean;
    }) => void);
}

Properties

scrollTo +LazyScrollViewMethods | react-native-lazy-scrollview

Interface LazyScrollViewMethods

interface LazyScrollViewMethods {
    scrollTo: ((y?: number | {
        animated?: boolean;
        x?: number;
        y?: number;
    }, x?: number, animated?: boolean) => void);
    scrollToEnd: ((options?: {
        animated: boolean;
    }) => void);
    scrollToStart: ((options?: {
        animated: boolean;
    }) => void);
}

Properties

scrollTo scrollToEnd scrollToStart

Properties

scrollTo

scrollTo: ((y?: number | {
    animated?: boolean;
    x?: number;
    y?: number;
}, x?: number, animated?: boolean) => void)

Type declaration

    • (y?, x?, animated?): void

    • Scrolls to a given x, y offset, either immediately or with a smooth animation. @@ -7,14 +7,14 @@

      Note: The weird argument signature is due to the fact that, for historical reasons, the function also accepts separate arguments as an alternative to the options object. This is deprecated due to ambiguity (y before x), and SHOULD NOT BE USED.

      -

      Parameters

      • Optionaly: number | {
            animated?: boolean;
            x?: number;
            y?: number;
        }
      • Optionalx: number
      • Optionalanimated: boolean

      Returns void

scrollToEnd

scrollToEnd: ((options?: {
    animated: boolean;
}) => void)

Type declaration

    • (options?): void

    • A helper function that scrolls to the end of the scrollview; +

      Parameters

      • Optionaly: number | {
            animated?: boolean;
            x?: number;
            y?: number;
        }
      • Optionalx: number
      • Optionalanimated: boolean

      Returns void

scrollToEnd

scrollToEnd: ((options?: {
    animated: boolean;
}) => void)

Type declaration

    • (options?): void

    • A helper function that scrolls to the end of the scrollview; If this is a vertical ScrollView, it scrolls to the bottom. If this is a horizontal ScrollView scrolls to the right.

      The options object has an animated prop, that enables the scrolling animation or not. The animated prop defaults to true

      -

      Parameters

      • Optionaloptions: {
            animated: boolean;
        }
        • animated: boolean

      Returns void

scrollToStart

scrollToStart: ((options?: {
    animated: boolean;
}) => void)

Type declaration

    • (options?): void

    • A helper function that scrolls to the end of the scrollview; +

      Parameters

      • Optionaloptions: {
            animated: boolean;
        }
        • animated: boolean

      Returns void

scrollToStart

scrollToStart: ((options?: {
    animated: boolean;
}) => void)

Type declaration

    • (options?): void

    • A helper function that scrolls to the end of the scrollview; If this is a vertical ScrollView, it scrolls to the bottom. If this is a horizontal ScrollView scrolls to the right.

      The options object has an animated prop, that enables the scrolling animation or not. The animated prop defaults to true

      -

      Parameters

      • Optionaloptions: {
            animated: boolean;
        }
        • animated: boolean

      Returns void

Settings

Member Visibility

On This Page

Properties
+

Parameters

  • Optionaloptions: {
        animated: boolean;
    }
    • animated: boolean

Returns void

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/LazyScrollView.LazyScrollViewProps.html b/docs/interfaces/LazyScrollView.LazyScrollViewProps.html index 084c2a8..f40b316 100644 --- a/docs/interfaces/LazyScrollView.LazyScrollViewProps.html +++ b/docs/interfaces/LazyScrollView.LazyScrollViewProps.html @@ -1,8 +1,8 @@ -LazyScrollViewProps | react-native-lazy-scrollview

Interface LazyScrollViewProps

interface LazyScrollViewProps {
    offset?: number;
    ref?: MutableRefObject<LazyScrollViewMethods>;
}

Properties

offset? +LazyScrollViewProps | react-native-lazy-scrollview

Interface LazyScrollViewProps

interface LazyScrollViewProps {
    offset?: number;
    ref?: MutableRefObject<LazyScrollViewMethods>;
}

Properties

offset? ref?

Properties

Optionaloffset

offset?: number

How far above or below the bottom of the ScrollView the threshold trigger is. Negative is above, postive it below. Accepts ScrollView props.

Default Value

0 (bottom of ScrollView)
-

Optionalref

ref?: MutableRefObject<LazyScrollViewMethods>

Ref to the LazyScrollView. Exposes scrollTo, scrollToStart, and scrollToEnd methods.

-

Settings

Member Visibility

On This Page

Properties
+

Optionalref

ref?: MutableRefObject<LazyScrollViewMethods>

Ref to the LazyScrollView. Exposes scrollTo, scrollToStart, and scrollToEnd methods.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/modules/LazyChild.html b/docs/modules/LazyChild.html index 49e0581..312fc41 100644 --- a/docs/modules/LazyChild.html +++ b/docs/modules/LazyChild.html @@ -1,4 +1,2 @@ -LazyChild | react-native-lazy-scrollview

Module LazyChild

Index

Interfaces

LazyChildCallbacks -LazyChildProps -

Functions

LazyChild +LazyChild | react-native-lazy-scrollview

Module LazyChild

Index

Functions

LazyChild

Settings

Member Visibility
diff --git a/docs/modules/LazyScrollView.html b/docs/modules/LazyScrollView.html index 72c6bd8..1ad3ce3 100644 --- a/docs/modules/LazyScrollView.html +++ b/docs/modules/LazyScrollView.html @@ -1,4 +1,4 @@ -LazyScrollView | react-native-lazy-scrollview

Module LazyScrollView

Index

Interfaces

LazyScrollViewMethods +LazyScrollView | react-native-lazy-scrollview

Module LazyScrollView

Index

Interfaces

LazyScrollViewMethods LazyScrollViewProps

Functions

LazyScrollView

Settings

Member Visibility