rewrite BaseModal to a functional component #25672
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,17 @@ | ||
| import React, {forwardRef, useCallback, useEffect, useMemo} from 'react'; | ||
| import {View} from 'react-native'; | ||
| import PropTypes from 'prop-types'; | ||
| import ReactNativeModal from 'react-native-modal'; | ||
| import {useSafeAreaInsets} from 'react-native-safe-area-context'; | ||
| import styles from '../../styles/styles'; | ||
| import * as Modal from '../../libs/actions/Modal'; | ||
| import * as StyleUtils from '../../styles/StyleUtils'; | ||
| import themeColors from '../../styles/themes/default'; | ||
| import {propTypes as modalPropTypes, defaultProps as modalDefaultProps} from './modalPropTypes'; | ||
| import getModalStyles from '../../styles/getModalStyles'; | ||
| import useWindowDimensions from '../../hooks/useWindowDimensions'; | ||
| import variables from '../../styles/variables'; | ||
| import CONST from '../../CONST'; | ||
|
|
||
| const propTypes = { | ||
| ...modalPropTypes, | ||
|
|
@@ -23,166 +25,180 @@ const defaultProps = { | |
| forwardedRef: () => {}, | ||
| }; | ||
|
|
||
| function BaseModal({ | ||
| isVisible, | ||
| onClose, | ||
| shouldSetModalVisibility, | ||
| onModalHide, | ||
| type, | ||
| popoverAnchorPosition, | ||
| innerContainerStyle, | ||
| outerStyle, | ||
| onModalShow, | ||
| propagateSwipe, | ||
| fullscreen, | ||
| animationIn, | ||
| animationOut, | ||
| useNativeDriver, | ||
| hideModalContentWhileAnimating, | ||
| animationInTiming, | ||
| animationOutTiming, | ||
| statusBarTranslucent, | ||
| onLayout, | ||
| avoidKeyboard, | ||
| forwardedRef, | ||
| children, | ||
| }) { | ||
| const {windowWidth, windowHeight, isSmallScreenWidth} = useWindowDimensions(); | ||
|
|
||
| const safeAreaInsets = useSafeAreaInsets(); | ||
|
|
||
| /** | ||
| * Hides modal | ||
| * @param {Boolean} [callHideCallback=true] Should we call the onModalHide callback | ||
| */ | ||
| const hideModal = useCallback( | ||
| (callHideCallback = true) => { | ||
| if (shouldSetModalVisibility) { | ||
| Modal.setModalVisibility(false); | ||
| } | ||
| if (callHideCallback) { | ||
| onModalHide(); | ||
| } | ||
| Modal.onModalDidClose(); | ||
| }, | ||
| // eslint-disable-next-line react-hooks/exhaustive-deps -- adding onModalHide to the dependency array causes too many unnecessary rerenders | ||
| [shouldSetModalVisibility], | ||
| ); | ||
|
|
||
| useEffect(() => { | ||
| Modal.willAlertModalBecomeVisible(isVisible); | ||
|
|
||
| // To handle closing any modal already visible when this modal is mounted, i.e. PopoverReportActionContextMenu | ||
| Modal.setCloseModal(isVisible ? onClose : null); | ||
|
|
||
| return () => { | ||
| // Only trigger onClose and setModalVisibility if the modal is unmounting while visible. | ||
| if (isVisible) { | ||
| hideModal(true); | ||
| Modal.willAlertModalBecomeVisible(false); | ||
| } | ||
|
Comment on lines
+85
to
+89
There was a problem hiding this comment. This will cause a regression. We should not use the isVisible state here as this will be evaluated at the time of render and not when the component unmounts i.e. if you initially render the modal as visible (true) then on unmount this condition will always be true even if the state value change by then. What we should do instead is to use a ref const isVisibleRef = useRef(isVisible);
useEffect(() => {
isVisibleRef.current = isVisible;
}, [isVisible]); |
||
|
|
||
| // To prevent closing any modal already unmounted when this modal still remains as visible state | ||
| Modal.setCloseModal(null); | ||
| }; | ||
| }, [hideModal, isVisible, onClose]); | ||
|
Comment on lines
+78
to
+94
There was a problem hiding this comment. Seems like we have a regression from this change, when onClose callback changes, it will also hide the modal due to the cleanup logic of this effect. #25998 |
||
|
|
||
| const handleShowModal = () => { | ||
| if (shouldSetModalVisibility) { | ||
| Modal.setModalVisibility(true); | ||
| } | ||
| onModalShow(); | ||
| }; | ||
|
|
||
| const handleBackdropPress = (e) => { | ||
| if (e && e.key === CONST.KEYBOARD_SHORTCUTS.ENTER.shortcutKey) { | ||
| return; | ||
| } | ||
| onClose(); | ||
| }; | ||
|
|
||
| const { | ||
| modalStyle, | ||
| modalContainerStyle, | ||
| swipeDirection, | ||
| animationIn: modalStyleAnimationIn, | ||
| animationOut: modalStyleAnimationOut, | ||
| shouldAddTopSafeAreaMargin, | ||
| shouldAddBottomSafeAreaMargin, | ||
| shouldAddTopSafeAreaPadding, | ||
| shouldAddBottomSafeAreaPadding, | ||
| hideBackdrop, | ||
| } = useMemo( | ||
| () => | ||
| getModalStyles( | ||
| type, | ||
| { | ||
| windowWidth, | ||
| windowHeight, | ||
| isSmallScreenWidth, | ||
| }, | ||
| popoverAnchorPosition, | ||
| innerContainerStyle, | ||
| outerStyle, | ||
| ), | ||
| [innerContainerStyle, isSmallScreenWidth, outerStyle, popoverAnchorPosition, type, windowHeight, windowWidth], | ||
| ); | ||
|
|
||
| const { | ||
| paddingTop: safeAreaPaddingTop, | ||
| paddingBottom: safeAreaPaddingBottom, | ||
| paddingLeft: safeAreaPaddingLeft, | ||
| paddingRight: safeAreaPaddingRight, | ||
| } = StyleUtils.getSafeAreaPadding(safeAreaInsets); | ||
|
|
||
| const modalPaddingStyles = StyleUtils.getModalPaddingStyles({ | ||
| safeAreaPaddingTop, | ||
| safeAreaPaddingBottom, | ||
| safeAreaPaddingLeft, | ||
| safeAreaPaddingRight, | ||
| shouldAddBottomSafeAreaMargin, | ||
| shouldAddTopSafeAreaMargin, | ||
| shouldAddBottomSafeAreaPadding, | ||
| shouldAddTopSafeAreaPadding, | ||
| modalContainerStyleMarginTop: modalContainerStyle.marginTop, | ||
| modalContainerStyleMarginBottom: modalContainerStyle.marginBottom, | ||
| modalContainerStylePaddingTop: modalContainerStyle.paddingTop, | ||
| modalContainerStylePaddingBottom: modalContainerStyle.paddingBottom, | ||
| insets: safeAreaInsets, | ||
| }); | ||
|
|
||
| return ( | ||
| <ReactNativeModal | ||
| onBackdropPress={handleBackdropPress} | ||
| // Note: Escape key on web/desktop will trigger onBackButtonPress callback | ||
| // eslint-disable-next-line react/jsx-props-no-multi-spaces | ||
| onBackButtonPress={onClose} | ||
| onModalShow={handleShowModal} | ||
| propagateSwipe={propagateSwipe} | ||
| onModalHide={hideModal} | ||
| onSwipeComplete={onClose} | ||
| swipeDirection={swipeDirection} | ||
| isVisible={isVisible} | ||
| backdropColor={themeColors.overlay} | ||
| backdropOpacity={hideBackdrop ? 0 : variables.overlayOpacity} | ||
| backdropTransitionOutTiming={0} | ||
| hasBackdrop={fullscreen} | ||
| coverScreen={fullscreen} | ||
| style={modalStyle} | ||
| deviceHeight={windowHeight} | ||
| deviceWidth={windowWidth} | ||
| animationIn={animationIn || modalStyleAnimationIn} | ||
| animationOut={animationOut || modalStyleAnimationOut} | ||
| useNativeDriver={useNativeDriver} | ||
| hideModalContentWhileAnimating={hideModalContentWhileAnimating} | ||
| animationInTiming={animationInTiming} | ||
| animationOutTiming={animationOutTiming} | ||
| statusBarTranslucent={statusBarTranslucent} | ||
| onLayout={onLayout} | ||
| avoidKeyboard={avoidKeyboard} | ||
| > | ||
| <View | ||
| style={[styles.defaultModalContainer, modalContainerStyle, modalPaddingStyles, !isVisible && styles.pointerEventsNone]} | ||
| ref={forwardedRef} | ||
| nativeID="no-drag-area" | ||
| > | ||
| {children} | ||
| </View> | ||
| </ReactNativeModal> | ||
| ); | ||
| } | ||
|
|
||
| BaseModal.propTypes = propTypes; | ||
| BaseModal.defaultProps = defaultProps; | ||
| BaseModal.displayName = 'BaseModal'; | ||
|
|
||
| export default forwardRef((props, ref) => ( | ||
| <BaseModal | ||
| // eslint-disable-next-line react/jsx-props-no-spreading | ||
| {...props} | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This caused a regression #27359. Previously on component mount Modal.setCloseModal was only called if the modal was rendered visible.