@react-navigation/stack
Version:
Stack navigator component for iOS and Android with animated transitions and gestures
484 lines (477 loc) • 22.7 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.CardStack = void 0;
var _elements = require("@react-navigation/elements");
var React = _interopRequireWildcard(require("react"));
var _reactNative = require("react-native");
var _CardStyleInterpolators = require("../../TransitionConfigs/CardStyleInterpolators.js");
var _TransitionPresets = require("../../TransitionConfigs/TransitionPresets.js");
var _findLastIndex = require("../../utils/findLastIndex.js");
var _getDistanceForDirection = require("../../utils/getDistanceForDirection.js");
var _getModalRoutesKeys = require("../../utils/getModalRoutesKeys.js");
var _Screens = require("../Screens.js");
var _CardContainer = require("./CardContainer.js");
var _jsxRuntime = require("react/jsx-runtime");
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
const NAMED_TRANSITIONS_PRESETS = {
default: _TransitionPresets.DefaultTransition,
fade: _TransitionPresets.ModalFadeTransition,
fade_from_bottom: _TransitionPresets.FadeFromBottomAndroid,
fade_from_right: _TransitionPresets.FadeFromRightAndroid,
none: _TransitionPresets.DefaultTransition,
reveal_from_bottom: _TransitionPresets.RevealFromBottomAndroid,
scale_from_center: _TransitionPresets.ScaleFromCenterAndroid,
slide_from_left: _TransitionPresets.SlideFromLeftIOS,
slide_from_right: _TransitionPresets.SlideFromRightIOS,
slide_from_bottom: _reactNative.Platform.select({
ios: _TransitionPresets.ModalSlideFromBottomIOS,
default: _TransitionPresets.BottomSheetAndroid
})
};
const EPSILON = 1e-5;
const STATE_INACTIVE = 0;
const STATE_TRANSITIONING_OR_BELOW_TOP = 1;
const STATE_ON_TOP = 2;
const FALLBACK_DESCRIPTOR = Object.freeze({
options: {}
});
const getInterpolationIndex = (scenes, index) => {
const {
cardStyleInterpolator
} = scenes[index].descriptor.options;
// Start from current card and count backwards the number of cards with same interpolation
let interpolationIndex = 0;
for (let i = index - 1; i >= 0; i--) {
const cardStyleInterpolatorCurrent = scenes[i]?.descriptor.options.cardStyleInterpolator;
if (cardStyleInterpolatorCurrent !== cardStyleInterpolator) {
break;
}
interpolationIndex++;
}
return interpolationIndex;
};
const getIsModalPresentation = cardStyleInterpolator => {
return cardStyleInterpolator === _CardStyleInterpolators.forModalPresentationIOS ||
// Handle custom modal presentation interpolators as well
cardStyleInterpolator.name === 'forModalPresentationIOS';
};
const getIsModal = (scene, interpolationIndex, isParentModal) => {
if (isParentModal) {
return true;
}
const {
cardStyleInterpolator
} = scene.descriptor.options;
const isModalPresentation = getIsModalPresentation(cardStyleInterpolator);
const isModal = isModalPresentation && interpolationIndex !== 0;
return isModal;
};
const getHeaderHeights = (scenes, insets, isParentHeaderShown, isParentModal, layout, previous) => {
return scenes.reduce((acc, curr, index) => {
const {
headerStatusBarHeight = isParentHeaderShown ? 0 : insets.top,
headerStyle
} = curr.descriptor.options;
const style = _reactNative.StyleSheet.flatten(headerStyle || {});
const height = 'height' in style && typeof style.height === 'number' ? style.height : previous[curr.route.key];
const interpolationIndex = getInterpolationIndex(scenes, index);
const isModal = getIsModal(curr, interpolationIndex, isParentModal);
acc[curr.route.key] = typeof height === 'number' ? height : (0, _elements.getDefaultHeaderHeight)(layout, isModal, headerStatusBarHeight);
return acc;
}, {});
};
const getDistanceFromOptions = (layout, descriptor, isRTL) => {
if (descriptor?.options.gestureDirection) {
return (0, _getDistanceForDirection.getDistanceForDirection)(layout, descriptor?.options.gestureDirection, isRTL);
}
const defaultGestureDirection = descriptor?.options.presentation === 'modal' ? _TransitionPresets.ModalTransition.gestureDirection : _TransitionPresets.DefaultTransition.gestureDirection;
const gestureDirection = descriptor?.options.animation ? NAMED_TRANSITIONS_PRESETS[descriptor?.options.animation]?.gestureDirection : defaultGestureDirection;
return (0, _getDistanceForDirection.getDistanceForDirection)(layout, gestureDirection, isRTL);
};
const getProgressFromGesture = (gesture, layout, descriptor, isRTL) => {
const distance = getDistanceFromOptions({
// Make sure that we have a non-zero distance, otherwise there will be incorrect progress
// This causes blank screen on web if it was previously inside container with display: none
width: Math.max(1, layout.width),
height: Math.max(1, layout.height)
}, descriptor, isRTL);
if (distance > 0) {
return gesture.interpolate({
inputRange: [0, distance],
outputRange: [1, 0]
});
}
return gesture.interpolate({
inputRange: [distance, 0],
outputRange: [0, 1]
});
};
class CardStack extends React.Component {
static getDerivedStateFromProps(props, state) {
if (props.routes === state.routes && props.descriptors === state.descriptors) {
return null;
}
const gestures = [...props.routes, ...props.state.preloadedRoutes].reduce((acc, curr) => {
const descriptor = props.descriptors[curr.key] || props.preloadedDescriptors[curr.key];
const {
animation
} = descriptor?.options || {};
acc[curr.key] = state.gestures[curr.key] || new _reactNative.Animated.Value(props.openingRouteKeys.includes(curr.key) && animation !== 'none' || props.state.preloadedRoutes.includes(curr) ? getDistanceFromOptions(state.layout, descriptor, props.direction === 'rtl') : 0);
return acc;
}, {});
const modalRouteKeys = (0, _getModalRoutesKeys.getModalRouteKeys)([...props.routes, ...props.state.preloadedRoutes], {
...props.descriptors,
...props.preloadedDescriptors
});
const scenes = [...props.routes, ...props.state.preloadedRoutes].map((route, index, self) => {
// For preloaded screens, we don't care about the previous and the next screen
const isPreloaded = props.state.preloadedRoutes.includes(route);
const previousRoute = isPreloaded ? undefined : self[index - 1];
const nextRoute = isPreloaded ? undefined : self[index + 1];
const oldScene = state.scenes[index];
const currentGesture = gestures[route.key];
const previousGesture = previousRoute ? gestures[previousRoute.key] : undefined;
const nextGesture = nextRoute ? gestures[nextRoute.key] : undefined;
const descriptor = (isPreloaded ? props.preloadedDescriptors : props.descriptors)[route.key] || state.descriptors[route.key] || (oldScene ? oldScene.descriptor : FALLBACK_DESCRIPTOR);
const nextDescriptor = nextRoute && (props.descriptors[nextRoute?.key] || state.descriptors[nextRoute?.key]);
const previousDescriptor = previousRoute && (props.descriptors[previousRoute?.key] || state.descriptors[previousRoute?.key]);
// When a screen is not the last, it should use next screen's transition config
// Many transitions also animate the previous screen, so using 2 different transitions doesn't look right
// For example combining a slide and a modal transition would look wrong otherwise
// With this approach, combining different transition styles in the same navigator mostly looks right
// This will still be broken when 2 transitions have different idle state (e.g. modal presentation),
// but the majority of the transitions look alright
const optionsForTransitionConfig = index !== self.length - 1 && nextDescriptor && nextDescriptor.options.presentation !== 'transparentModal' ? nextDescriptor.options : descriptor.options;
// Assume modal if there are already modal screens in the stack
// or current screen is a modal when no presentation is specified
const isModal = modalRouteKeys.includes(route.key);
// Disable screen transition animation by default on web, windows and macos to match the native behavior
const excludedPlatforms = _reactNative.Platform.OS !== 'web' && _reactNative.Platform.OS !== 'windows' && _reactNative.Platform.OS !== 'macos';
const animation = optionsForTransitionConfig.animation ?? (excludedPlatforms ? 'default' : 'none');
const isAnimationEnabled = animation !== 'none';
const transitionPreset = animation !== 'default' ? NAMED_TRANSITIONS_PRESETS[animation] : isModal || optionsForTransitionConfig.presentation === 'modal' ? _TransitionPresets.ModalTransition : optionsForTransitionConfig.presentation === 'transparentModal' ? _TransitionPresets.ModalFadeTransition : _TransitionPresets.DefaultTransition;
const {
gestureEnabled = _reactNative.Platform.OS === 'ios' && isAnimationEnabled,
gestureDirection = transitionPreset.gestureDirection,
transitionSpec = transitionPreset.transitionSpec,
cardStyleInterpolator = isAnimationEnabled ? transitionPreset.cardStyleInterpolator : _CardStyleInterpolators.forNoAnimation,
headerStyleInterpolator = transitionPreset.headerStyleInterpolator,
cardOverlayEnabled = _reactNative.Platform.OS !== 'ios' && optionsForTransitionConfig.presentation !== 'transparentModal' || getIsModalPresentation(cardStyleInterpolator)
} = optionsForTransitionConfig;
const headerMode = descriptor.options.headerMode ?? (!(optionsForTransitionConfig.presentation === 'modal' || optionsForTransitionConfig.presentation === 'transparentModal' || nextDescriptor?.options.presentation === 'modal' || nextDescriptor?.options.presentation === 'transparentModal' || getIsModalPresentation(cardStyleInterpolator)) && _reactNative.Platform.OS === 'ios' && descriptor.options.header === undefined ? 'float' : 'screen');
const isRTL = props.direction === 'rtl';
const scene = {
route,
descriptor: {
...descriptor,
options: {
...descriptor.options,
animation,
cardOverlayEnabled,
cardStyleInterpolator,
gestureDirection,
gestureEnabled,
headerStyleInterpolator,
transitionSpec,
headerMode
}
},
progress: {
current: getProgressFromGesture(currentGesture, state.layout, descriptor, isRTL),
next: nextGesture && nextDescriptor?.options.presentation !== 'transparentModal' ? getProgressFromGesture(nextGesture, state.layout, nextDescriptor, isRTL) : undefined,
previous: previousGesture ? getProgressFromGesture(previousGesture, state.layout, previousDescriptor, isRTL) : undefined
},
__memo: [state.layout, descriptor, nextDescriptor, previousDescriptor, currentGesture, nextGesture, previousGesture]
};
if (oldScene && scene.__memo.every((it, i) => {
// @ts-expect-error: we haven't added __memo to the annotation to prevent usage elsewhere
return oldScene.__memo[i] === it;
})) {
return oldScene;
}
return scene;
});
return {
routes: props.routes,
scenes,
gestures,
descriptors: props.descriptors,
headerHeights: getHeaderHeights(scenes, props.insets, props.isParentHeaderShown, props.isParentModal, state.layout, state.headerHeights)
};
}
constructor(props) {
super(props);
this.state = {
routes: [],
scenes: [],
gestures: {},
layout: _elements.SafeAreaProviderCompat.initialMetrics.frame,
descriptors: this.props.descriptors,
// Used when card's header is null and mode is float to make transition
// between screens with headers and those without headers smooth.
// This is not a great heuristic here. We don't know synchronously
// on mount what the header height is so we have just used the most
// common cases here.
headerHeights: {}
};
}
handleLayout = e => {
const {
height,
width
} = e.nativeEvent.layout;
const layout = {
width,
height
};
this.setState((state, props) => {
if (height === state.layout.height && width === state.layout.width) {
return null;
}
return {
layout,
headerHeights: getHeaderHeights(state.scenes, props.insets, props.isParentHeaderShown, props.isParentModal, layout, state.headerHeights)
};
});
};
handleHeaderLayout = ({
route,
height
}) => {
this.setState(({
headerHeights
}) => {
const previousHeight = headerHeights[route.key];
if (previousHeight === height) {
return null;
}
return {
headerHeights: {
...headerHeights,
[route.key]: height
}
};
});
};
getFocusedRoute = () => {
const {
state
} = this.props;
return state.routes[state.index];
};
getPreviousScene = ({
route
}) => {
const {
getPreviousRoute
} = this.props;
const {
scenes
} = this.state;
const previousRoute = getPreviousRoute({
route
});
if (previousRoute) {
const previousScene = scenes.find(scene => scene.descriptor.route.key === previousRoute.key);
return previousScene;
}
return undefined;
};
render() {
const {
insets,
state,
routes,
openingRouteKeys,
closingRouteKeys,
onOpenRoute,
onCloseRoute,
renderHeader,
isParentHeaderShown,
isParentModal,
onTransitionStart,
onTransitionEnd,
onGestureStart,
onGestureEnd,
onGestureCancel,
detachInactiveScreens = _reactNative.Platform.OS === 'web' || _reactNative.Platform.OS === 'android' || _reactNative.Platform.OS === 'ios'
} = this.props;
const {
scenes,
layout,
gestures,
headerHeights
} = this.state;
const focusedRoute = state.routes[state.index];
const focusedHeaderHeight = headerHeights[focusedRoute.key];
const isFloatHeaderAbsolute = this.state.scenes.slice(-2).some(scene => {
const options = scene.descriptor.options ?? {};
const {
headerMode,
headerTransparent,
headerShown = true
} = options;
if (headerTransparent || headerShown === false || headerMode === 'screen') {
return true;
}
return false;
});
let activeScreensLimit = 1;
for (let i = scenes.length - 1; i >= 0; i--) {
const {
options
} = scenes[i].descriptor;
const {
// By default, we don't want to detach the previous screen of the active one for modals
detachPreviousScreen = options.presentation === 'transparentModal' ? false : getIsModalPresentation(options.cardStyleInterpolator) ? i !== (0, _findLastIndex.findLastIndex)(scenes, scene => {
const {
cardStyleInterpolator
} = scene.descriptor.options;
return cardStyleInterpolator === _CardStyleInterpolators.forModalPresentationIOS || cardStyleInterpolator?.name === 'forModalPresentationIOS';
}) : true
} = options;
if (detachPreviousScreen === false) {
activeScreensLimit++;
} else {
// Check at least last 2 screens before stopping
// This will make sure that screen isn't detached when another screen is animating on top of the transparent one
// For example, (Opaque -> Transparent -> Opaque)
if (i <= scenes.length - 2) {
break;
}
}
}
const floatingHeader = /*#__PURE__*/(0, _jsxRuntime.jsx)(React.Fragment, {
children: renderHeader({
mode: 'float',
layout,
scenes,
getPreviousScene: this.getPreviousScene,
getFocusedRoute: this.getFocusedRoute,
onContentHeightChange: this.handleHeaderLayout,
style: [styles.floating, isFloatHeaderAbsolute && [
// Without this, the header buttons won't be touchable on Android when headerTransparent: true
{
height: focusedHeaderHeight
}, styles.absolute]]
})
}, "header");
return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_reactNative.View, {
style: styles.container,
children: [isFloatHeaderAbsolute ? null : floatingHeader, /*#__PURE__*/(0, _jsxRuntime.jsx)(_Screens.MaybeScreenContainer, {
enabled: detachInactiveScreens,
style: styles.container,
onLayout: this.handleLayout,
children: [...routes, ...state.preloadedRoutes].map((route, index) => {
const focused = focusedRoute.key === route.key;
const gesture = gestures[route.key];
const scene = scenes[index];
// It is possible that for a short period the route appears in both arrays.
// Particularly, if the screen is removed with `retain`, then it needs a moment to execute the animation.
// However, due to the router action, it immediately populates the `preloadedRoutes` array.
// Practically, the logic below takes care that it is rendered only once.
const isPreloaded = state.preloadedRoutes.includes(route) && !routes.includes(route);
if (state.preloadedRoutes.includes(route) && routes.includes(route) && index >= routes.length) {
return null;
}
// For the screens that shouldn't be active, the value is 0
// For those that should be active, but are not the top screen, the value is 1
// For those on top of the stack and with interaction enabled, the value is 2
// For the old implementation, it stays the same it was
let isScreenActive = 1;
if (index < routes.length - activeScreensLimit - 1 || isPreloaded) {
// screen should be inactive because it is too deep in the stack
isScreenActive = STATE_INACTIVE;
} else {
const sceneForActivity = scenes[routes.length - 1];
const outputValue = index === routes.length - 1 ? STATE_ON_TOP // the screen is on top after the transition
: index >= routes.length - activeScreensLimit ? STATE_TRANSITIONING_OR_BELOW_TOP // the screen should stay active after the transition, it is not on top but is in activeLimit
: STATE_INACTIVE; // the screen should be active only during the transition, it is at the edge of activeLimit
isScreenActive = sceneForActivity ? sceneForActivity.progress.current.interpolate({
inputRange: [0, 1 - EPSILON, 1],
outputRange: [1, 1, outputValue],
extrapolate: 'clamp'
}) : STATE_TRANSITIONING_OR_BELOW_TOP;
}
const {
headerShown = true,
headerTransparent,
freezeOnBlur,
autoHideHomeIndicator
} = scene.descriptor.options;
const safeAreaInsetTop = insets.top;
const safeAreaInsetRight = insets.right;
const safeAreaInsetBottom = insets.bottom;
const safeAreaInsetLeft = insets.left;
const headerHeight = headerShown !== false ? headerHeights[route.key] : 0;
// Start from current card and count backwards the number of cards with same interpolation
const interpolationIndex = getInterpolationIndex(scenes, index);
const isModal = getIsModal(scene, interpolationIndex, isParentModal);
const isNextScreenTransparent = scenes[index + 1]?.descriptor.options.presentation === 'transparentModal';
const detachCurrentScreen = scenes[index + 1]?.descriptor.options.detachPreviousScreen !== false;
return /*#__PURE__*/(0, _jsxRuntime.jsx)(_Screens.MaybeScreen, {
style: [_reactNative.StyleSheet.absoluteFill],
enabled: detachInactiveScreens,
active: isScreenActive,
freezeOnBlur: freezeOnBlur,
shouldFreeze: isScreenActive === STATE_INACTIVE && !isPreloaded,
homeIndicatorHidden: autoHideHomeIndicator,
pointerEvents: "box-none",
children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_CardContainer.CardContainer, {
index: index,
interpolationIndex: interpolationIndex,
modal: isModal,
active: index === routes.length - 1,
focused: focused,
opening: openingRouteKeys.includes(route.key),
closing: closingRouteKeys.includes(route.key),
layout: layout,
gesture: gesture,
scene: scene,
safeAreaInsetTop: safeAreaInsetTop,
safeAreaInsetRight: safeAreaInsetRight,
safeAreaInsetBottom: safeAreaInsetBottom,
safeAreaInsetLeft: safeAreaInsetLeft,
onGestureStart: onGestureStart,
onGestureCancel: onGestureCancel,
onGestureEnd: onGestureEnd,
headerHeight: headerHeight,
isParentHeaderShown: isParentHeaderShown,
onHeaderHeightChange: this.handleHeaderLayout,
getPreviousScene: this.getPreviousScene,
getFocusedRoute: this.getFocusedRoute,
hasAbsoluteFloatHeader: isFloatHeaderAbsolute && !headerTransparent,
renderHeader: renderHeader,
onOpenRoute: onOpenRoute,
onCloseRoute: onCloseRoute,
onTransitionStart: onTransitionStart,
onTransitionEnd: onTransitionEnd,
isNextScreenTransparent: isNextScreenTransparent,
detachCurrentScreen: detachCurrentScreen,
preloaded: isPreloaded
})
}, route.key);
})
}), isFloatHeaderAbsolute ? floatingHeader : null]
});
}
}
exports.CardStack = CardStack;
const styles = _reactNative.StyleSheet.create({
container: {
flex: 1
},
absolute: {
position: 'absolute',
top: 0,
start: 0,
end: 0
},
floating: {
zIndex: 1
}
});
//# sourceMappingURL=CardStack.js.map