@tamagui/react-native-web-lite
Version:
React Native for Web
524 lines (523 loc) • 23.1 kB
JavaScript
import React from "react";
import { Platform, StyleSheet, TextInputState, UIManager, dismissKeyboard, invariant, mergeRefs, warning } from "@tamagui/react-native-web-internals";
import Dimensions from "../Dimensions/index.mjs";
import View from "../View/index.mjs";
import ScrollViewBase from "./ScrollViewBase.mjs";
import { jsx } from "react/jsx-runtime";
const emptyObject = {},
IS_ANIMATING_TOUCH_START_THRESHOLD_MS = 16;
class ScrollView extends React.Component {
_scrollNodeRef;
_innerViewRef;
keyboardWillOpenTo = null;
additionalScrollOffset = 0;
preventNegativeScrollOffset = !1;
isTouching = !1;
lastMomentumScrollBeginTime = 0;
lastMomentumScrollEndTime = 0;
// Reset to false every time becomes responder. This is used to:
// - Determine if the scroll view has been scrolled and therefore should
// refuse to give up its responder lock.
// - Determine if releasing should dismiss the keyboard when we are in
// tap-to-dismiss mode (!this.props.keyboardShouldPersistTaps).
observedScrollSinceBecomingResponder = !1;
becameResponderWhileAnimating = !1;
/**
* Returns a reference to the underlying scroll responder, which supports
* operations like `scrollTo`. All ScrollView-like components should
* implement this method so that they can be composed while providing access
* to the underlying scroll responder's methods.
*/
getScrollResponder() {
return this;
}
getScrollableNode() {
return this._scrollNodeRef;
}
getInnerViewRef() {
return this._innerViewRef;
}
getInnerViewNode() {
return this._innerViewRef;
}
getNativeScrollRef() {
return this._scrollNodeRef;
}
flashScrollIndicators = () => {
this.scrollResponderFlashScrollIndicators();
};
/**
* Scrolls to a given x, y offset, either immediately or with a smooth animation.
* Syntax:
*
* scrollTo(options: {x: number = 0; y: number = 0; animated: boolean = true})
*
* Note: The weird argument signature is due to the fact that, for historical reasons,
* the function also accepts separate arguments as as alternative to the options object.
* This is deprecated due to ambiguity (y before x), and SHOULD NOT BE USED.
*/
scrollTo = (y, x, animated) => {
typeof y == "number" ? console.warn("`scrollTo(y, x, animated)` is deprecated. Use `scrollTo({x: 5, y: 5, animated: true})` instead.") : {
x,
y,
animated
} = y || emptyObject, this.scrollResponderScrollTo({
x: x || 0,
y: y || 0,
animated: animated !== !1
});
};
/**
* If this is a vertical ScrollView scrolls to the bottom.
* If this is a horizontal ScrollView scrolls to the right.
*
* Use `scrollToEnd({ animated: true })` for smooth animated scrolling,
* `scrollToEnd({ animated: false })` for immediate scrolling.
* If no options are passed, `animated` defaults to true.
*/
scrollToEnd = options => {
const animated = (options && options.animated) !== !1,
{
horizontal
} = this.props,
scrollResponderNode = this.getScrollableNode(),
x = horizontal ? scrollResponderNode.scrollWidth : 0,
y = horizontal ? 0 : scrollResponderNode.scrollHeight;
this.scrollResponderScrollTo({
x,
y,
animated
});
};
render() {
const {
contentContainerStyle,
horizontal,
onContentSizeChange,
refreshControl,
stickyHeaderIndices,
pagingEnabled,
/* eslint-disable */
forwardedRef,
keyboardDismissMode,
onScroll,
centerContent,
/* eslint-enable */
...other
} = this.props;
if (process.env.NODE_ENV !== "production" && this.props.style) {
const style = StyleSheet.flatten(this.props.style),
childLayoutProps = ["alignItems", "justifyContent"].filter(prop => style && style[prop] !== void 0);
invariant(childLayoutProps.length === 0, `ScrollView child layout (${JSON.stringify(childLayoutProps)}) must be applied through the contentContainerStyle prop.`);
}
let contentSizeChangeProps = {};
onContentSizeChange && (contentSizeChangeProps = {
onLayout: this._handleContentOnLayout.bind(this)
});
const hasStickyHeaderIndices = !horizontal && Array.isArray(stickyHeaderIndices),
children = hasStickyHeaderIndices || pagingEnabled ? React.Children.map(this.props.children, (child, i) => {
const isSticky = hasStickyHeaderIndices && stickyHeaderIndices.indexOf(i) > -1;
return child != null && (isSticky || pagingEnabled) ? /* @__PURE__ */jsx(View, {
style: StyleSheet.compose(isSticky && styles.stickyHeader, pagingEnabled && styles.pagingEnabledChild),
children: child
}) : child;
}) : this.props.children,
contentContainer = /* @__PURE__ */jsx(View, {
...contentSizeChangeProps,
collapsable: !1,
ref: this._setInnerViewRef.bind(this),
style: [horizontal && styles.contentContainerHorizontal, centerContent && styles.contentContainerCenterContent, contentContainerStyle],
children
}),
baseStyle = horizontal ? styles.baseHorizontal : styles.baseVertical,
pagingEnabledStyle = horizontal ? styles.pagingEnabledHorizontal : styles.pagingEnabledVertical,
props = {
...other,
style: [baseStyle, pagingEnabled && pagingEnabledStyle, this.props.style],
onTouchStart: this.scrollResponderHandleTouchStart.bind(this),
onTouchMove: this.scrollResponderHandleTouchMove.bind(this),
onTouchEnd: this.scrollResponderHandleTouchEnd.bind(this),
onScrollBeginDrag: this.scrollResponderHandleScrollBeginDrag.bind(this),
onScrollEndDrag: this.scrollResponderHandleScrollEndDrag.bind(this),
onMomentumScrollBegin: this.scrollResponderHandleMomentumScrollBegin.bind(this),
onMomentumScrollEnd: this.scrollResponderHandleMomentumScrollEnd.bind(this),
onStartShouldSetResponder: this.scrollResponderHandleStartShouldSetResponder.bind(this),
onStartShouldSetResponderCapture: this.scrollResponderHandleStartShouldSetResponderCapture.bind(this),
onScrollShouldSetResponder: this.scrollResponderHandleScrollShouldSetResponder.bind(this),
onScroll: this._handleScroll.bind(this),
onResponderGrant: this.scrollResponderHandleResponderGrant.bind(this),
onResponderTerminationRequest: this.scrollResponderHandleTerminationRequest.bind(this),
onResponderRelease: this.scrollResponderHandleResponderRelease.bind(this),
onResponderReject: this.scrollResponderHandleResponderReject.bind(this),
onResponderTerminate: this.scrollResponderHandleTerminate.bind(this)
},
ScrollViewClass = ScrollViewBase;
invariant(ScrollViewClass !== void 0, "ScrollViewClass must not be undefined");
const scrollView = /* @__PURE__ */jsx(ScrollViewClass, {
...props,
ref: this._setScrollNodeRef.bind(this),
children: contentContainer
});
return refreshControl ? React.cloneElement(refreshControl, {
style: props.style
}, scrollView) : scrollView;
}
_handleContentOnLayout(e) {
const {
width,
height
} = e.nativeEvent.layout;
this.props.onContentSizeChange?.(width, height);
}
_handleScroll(e) {
process.env.NODE_ENV !== "production" && this.props.onScroll && this.props.scrollEventThrottle == null && console.info("You specified `onScroll` on a <ScrollView> but not `scrollEventThrottle`. You will only receive one event. Using `16` you get all the events but be aware that it may cause frame drops, use a bigger number if you don't need as much precision."), this.props.keyboardDismissMode === "on-drag" && dismissKeyboard(), this.scrollResponderHandleScroll(e);
}
_setInnerViewRef(node) {
this._innerViewRef = node;
}
_setScrollNodeRef(node) {
this._scrollNodeRef = node, node != null && (node.getScrollResponder = this.getScrollResponder, node.getInnerViewNode = this.getInnerViewNode, node.getInnerViewRef = this.getInnerViewRef, node.getNativeScrollRef = this.getNativeScrollRef, node.getScrollableNode = this.getScrollableNode, node.scrollTo = this.scrollTo, node.scrollToEnd = this.scrollToEnd, node.flashScrollIndicators = this.flashScrollIndicators, node.scrollResponderZoomTo = this.scrollResponderZoomTo, node.scrollResponderScrollNativeHandleToKeyboard = this.scrollResponderScrollNativeHandleToKeyboard), mergeRefs(this.props.forwardedRef)(node);
}
/**
* Invoke this from an `onScroll` event.
*/
scrollResponderHandleScrollShouldSetResponder() {
return this.isTouching;
}
/**
* Merely touch starting is not sufficient for a scroll view to become the
* responder. Being the "responder" means that the very next touch move/end
* event will result in an action/movement.
*
* Invoke this from an `onStartShouldSetResponder` event.
*
* `onStartShouldSetResponder` is used when the next move/end will trigger
* some UI movement/action, but when you want to yield priority to views
* nested inside of the view.
*
* There may be some cases where scroll views actually should return `true`
* from `onStartShouldSetResponder`: Any time we are detecting a standard tap
* that gives priority to nested views.
*
* - If a single tap on the scroll view triggers an action such as
* recentering a map style view yet wants to give priority to interaction
* views inside (such as dropped pins or labels), then we would return true
* from this method when there is a single touch.
*
* - Similar to the previous case, if a two finger "tap" should trigger a
* zoom, we would check the `touches` count, and if `>= 2`, we would return
* true.
*
*/
scrollResponderHandleStartShouldSetResponder() {
return !1;
}
/**
* There are times when the scroll view wants to become the responder
* (meaning respond to the next immediate `touchStart/touchEnd`), in a way
* that *doesn't* give priority to nested views (hence the capture phase):
*
* - Currently animating.
* - Tapping anywhere that is not the focused input, while the keyboard is
* up (which should dismiss the keyboard).
*
* Invoke this from an `onStartShouldSetResponderCapture` event.
*/
scrollResponderHandleStartShouldSetResponderCapture(e) {
return this.scrollResponderIsAnimating();
}
/**
* Invoke this from an `onResponderReject` event.
*
* Some other element is not yielding its role as responder. Normally, we'd
* just disable the `UIScrollView`, but a touch has already began on it, the
* `UIScrollView` will not accept being disabled after that. The easiest
* solution for now is to accept the limitation of disallowing this
* altogether. To improve this, find a way to disable the `UIScrollView` after
* a touch has already started.
*/
scrollResponderHandleResponderReject() {
warning(!1, "ScrollView doesn't take rejection well - scrolls anyway");
}
/**
* We will allow the scroll view to give up its lock iff it acquired the lock
* during an animation. This is a very useful default that happens to satisfy
* many common user experiences.
*
* - Stop a scroll on the left edge, then turn that into an outer view's
* backswipe.
* - Stop a scroll mid-bounce at the top, continue pulling to have the outer
* view dismiss.
* - However, without catching the scroll view mid-bounce (while it is
* motionless), if you drag far enough for the scroll view to become
* responder (and therefore drag the scroll view a bit), any backswipe
* navigation of a swipe gesture higher in the view hierarchy, should be
* rejected.
*/
scrollResponderHandleTerminationRequest() {
return !this.observedScrollSinceBecomingResponder;
}
/**
* Invoke this from an `onTouchEnd` event.
*
* @param {SyntheticEvent} e Event.
*/
scrollResponderHandleTouchEnd(e) {
const nativeEvent = e.nativeEvent;
this.isTouching = nativeEvent.touches.length !== 0, this.props.onTouchEnd && this.props.onTouchEnd(e);
}
/**
* Invoke this from an `onResponderRelease` event.
*/
scrollResponderHandleResponderRelease(e) {
this.props.onResponderRelease && this.props.onResponderRelease(e);
const currentlyFocusedTextInput = TextInputState.currentlyFocusedField();
!this.props.keyboardShouldPersistTaps && currentlyFocusedTextInput != null && e.target !== currentlyFocusedTextInput && !this.observedScrollSinceBecomingResponder && !this.becameResponderWhileAnimating && (this.props.onScrollResponderKeyboardDismissed && this.props.onScrollResponderKeyboardDismissed(e), TextInputState.blurTextInput(currentlyFocusedTextInput));
}
scrollResponderHandleScroll(e) {
this.observedScrollSinceBecomingResponder = !0, this.props.onScroll && this.props.onScroll(e);
}
/**
* Invoke this from an `onResponderGrant` event.
*/
scrollResponderHandleResponderGrant(e) {
this.observedScrollSinceBecomingResponder = !1, this.props.onResponderGrant && this.props.onResponderGrant(e), this.becameResponderWhileAnimating = this.scrollResponderIsAnimating();
}
/**
* Unfortunately, `onScrollBeginDrag` also fires when *stopping* the scroll
* animation, and there's not an easy way to distinguish a drag vs. stopping
* momentum.
*
* Invoke this from an `onScrollBeginDrag` event.
*/
scrollResponderHandleScrollBeginDrag(e) {
this.props.onScrollBeginDrag && this.props.onScrollBeginDrag(e);
}
/**
* Invoke this from an `onScrollEndDrag` event.
*/
scrollResponderHandleScrollEndDrag(e) {
this.props.onScrollEndDrag && this.props.onScrollEndDrag(e);
}
/**
* Invoke this from an `onMomentumScrollBegin` event.
*/
scrollResponderHandleMomentumScrollBegin(e) {
this.lastMomentumScrollBeginTime = Date.now(), this.props.onMomentumScrollBegin && this.props.onMomentumScrollBegin(e);
}
/**
* Invoke this from an `onMomentumScrollEnd` event.
*/
scrollResponderHandleMomentumScrollEnd(e) {
this.lastMomentumScrollEndTime = Date.now(), this.props.onMomentumScrollEnd && this.props.onMomentumScrollEnd(e);
}
/**
* Invoke this from an `onTouchStart` event.
*
* Since we know that the `SimpleEventPlugin` occurs later in the plugin
* order, after `ResponderEventPlugin`, we can detect that we were *not*
* permitted to be the responder (presumably because a contained view became
* responder). The `onResponderReject` won't fire in that case - it only
* fires when a *current* responder rejects our request.
*
* @param {SyntheticEvent} e Touch Start event.
*/
scrollResponderHandleTouchStart(e) {
this.isTouching = !0, this.props.onTouchStart && this.props.onTouchStart(e);
}
/**
* Invoke this from an `onTouchMove` event.
*
* Since we know that the `SimpleEventPlugin` occurs later in the plugin
* order, after `ResponderEventPlugin`, we can detect that we were *not*
* permitted to be the responder (presumably because a contained view became
* responder). The `onResponderReject` won't fire in that case - it only
* fires when a *current* responder rejects our request.
*
* @param {SyntheticEvent} e Touch Start event.
*/
scrollResponderHandleTouchMove(e) {
this.props.onTouchMove && this.props.onTouchMove(e);
}
scrollResponderHandleTerminate(e) {
this.props.onResponderTerminate && this.props.onResponderTerminate(e);
}
/**
* A helper function for this class that lets us quickly determine if the
* view is currently animating. This is particularly useful to know when
* a touch has just started or ended.
*/
scrollResponderIsAnimating() {
return Date.now() - this.lastMomentumScrollEndTime < IS_ANIMATING_TOUCH_START_THRESHOLD_MS || this.lastMomentumScrollEndTime < this.lastMomentumScrollBeginTime;
}
/**
* A helper function to scroll to a specific point in the scrollview.
* This is currently used to help focus on child textviews, but can also
* be used to quickly scroll to any element we want to focus. Syntax:
*
* scrollResponderScrollTo(options: {x: number = 0; y: number = 0; animated: boolean = true})
*
* Note: The weird argument signature is due to the fact that, for historical reasons,
* the function also accepts separate arguments as as alternative to the options object.
* This is deprecated due to ambiguity (y before x), and SHOULD NOT BE USED.
*/
scrollResponderScrollTo = (x, y, animated) => {
typeof x == "number" ? console.warn("`scrollResponderScrollTo(x, y, animated)` is deprecated. Use `scrollResponderScrollTo({x: 5, y: 5, animated: true})` instead.") : {
x,
y,
animated
} = x || emptyObject;
const node = this.getScrollableNode(),
left = x || 0,
top = y || 0;
node != null && (typeof node.scroll == "function" ? node.scroll({
top,
left,
behavior: animated ? "smooth" : "auto"
}) : (node.scrollLeft = left, node.scrollTop = top));
};
/**
* A helper function to zoom to a specific rect in the scrollview. The argument has the shape
* {x: number; y: number; width: number; height: number; animated: boolean = true}
*
* @platform ios
*/
scrollResponderZoomTo = (rect, animated) => {
Platform.OS !== "ios" && invariant("zoomToRect is not implemented");
};
/**
* Displays the scroll indicators momentarily.
*/
scrollResponderFlashScrollIndicators() {}
/**
* This method should be used as the callback to onFocus in a TextInputs'
* parent view. Note that any module using this mixin needs to return
* the parent view's ref in getScrollViewRef() in order to use this method.
* @param {any} nodeHandle The TextInput node handle
* @param {number} additionalOffset The scroll view's top "contentInset".
* Default is 0.
* @param {bool} preventNegativeScrolling Whether to allow pulling the content
* down to make it meet the keyboard's top. Default is false.
*/
scrollResponderScrollNativeHandleToKeyboard = (nodeHandle, additionalOffset, preventNegativeScrollOffset) => {
this.additionalScrollOffset = additionalOffset || 0, this.preventNegativeScrollOffset = !!preventNegativeScrollOffset, UIManager.measureLayout(nodeHandle, this.getInnerViewNode(), this.scrollResponderTextInputFocusError, this.scrollResponderInputMeasureAndScrollToKeyboard);
};
/**
* The calculations performed here assume the scroll view takes up the entire
* screen - even if has some content inset. We then measure the offsets of the
* keyboard, and compensate both for the scroll view's "contentInset".
*
* @param {number} left Position of input w.r.t. table view.
* @param {number} top Position of input w.r.t. table view.
* @param {number} width Width of the text input.
* @param {number} height Height of the text input.
*/
scrollResponderInputMeasureAndScrollToKeyboard = (left, top, width, height) => {
let keyboardScreenY = Dimensions.get("window").height;
this.keyboardWillOpenTo && (keyboardScreenY = this.keyboardWillOpenTo.endCoordinates.screenY);
let scrollOffsetY = top - keyboardScreenY + height + this.additionalScrollOffset;
this.preventNegativeScrollOffset && (scrollOffsetY = Math.max(0, scrollOffsetY)), this.scrollResponderScrollTo({
x: 0,
y: scrollOffsetY,
animated: !0
}), this.additionalScrollOffset = 0, this.preventNegativeScrollOffset = !1;
};
scrollResponderTextInputFocusError(e) {
console.error("Error measuring text field: ", e);
}
/**
* Warning, this may be called several times for a single keyboard opening.
* It's best to store the information in this method and then take any action
* at a later point (either in `keyboardDidShow` or other).
*
* Here's the order that events occur in:
* - focus
* - willShow {startCoordinates, endCoordinates} several times
* - didShow several times
* - blur
* - willHide {startCoordinates, endCoordinates} several times
* - didHide several times
*
* The `ScrollResponder` providesModule callbacks for each of these events.
* Even though any user could have easily listened to keyboard events
* themselves, using these `props` callbacks ensures that ordering of events
* is consistent - and not dependent on the order that the keyboard events are
* subscribed to. This matters when telling the scroll view to scroll to where
* the keyboard is headed - the scroll responder better have been notified of
* the keyboard destination before being instructed to scroll to where the
* keyboard will be. Stick to the `ScrollResponder` callbacks, and everything
* will work.
*
* WARNING: These callbacks will fire even if a keyboard is displayed in a
* different navigation pane. Filter out the events to determine if they are
* relevant to you. (For example, only if you receive these callbacks after
* you had explicitly focused a node etc).
*/
scrollResponderKeyboardWillShow = e => {
this.keyboardWillOpenTo = e, this.props.onKeyboardWillShow && this.props.onKeyboardWillShow(e);
};
scrollResponderKeyboardWillHide = e => {
this.keyboardWillOpenTo = null, this.props.onKeyboardWillHide && this.props.onKeyboardWillHide(e);
};
scrollResponderKeyboardDidShow = e => {
e && (this.keyboardWillOpenTo = e), this.props.onKeyboardDidShow && this.props.onKeyboardDidShow(e);
};
scrollResponderKeyboardDidHide = e => {
this.keyboardWillOpenTo = null, this.props.onKeyboardDidHide && this.props.onKeyboardDidHide(e);
};
}
const commonStyle = {
flexGrow: 1,
flexShrink: 1,
// Enable hardware compositing in modern browsers.
// Creates a new layer with its own backing surface that can significantly
// improve scroll performance.
transform: [{
translateZ: 0
}],
// iOS native scrolling
WebkitOverflowScrolling: "touch"
},
styles = {
baseVertical: {
...commonStyle,
flexDirection: "column",
overflowX: "hidden",
overflowY: "auto"
},
baseHorizontal: {
...commonStyle,
flexDirection: "row",
overflowX: "auto",
overflowY: "hidden"
},
contentContainerHorizontal: {
flexDirection: "row"
},
contentContainerCenterContent: {
justifyContent: "center",
flexGrow: 1
},
stickyHeader: {
position: "sticky",
top: 0,
zIndex: 10
},
pagingEnabledHorizontal: {
scrollSnapType: "x mandatory"
},
pagingEnabledVertical: {
scrollSnapType: "y mandatory"
},
pagingEnabledChild: {
scrollSnapAlign: "start"
}
},
ForwardedScrollView = React.forwardRef((props, forwardedRef) => /* @__PURE__ */jsx(ScrollView, {
...props,
forwardedRef
}));
ForwardedScrollView.displayName = "ScrollView";
var ScrollView_default = ForwardedScrollView;
export { ScrollView_default as default };
//# sourceMappingURL=index.mjs.map