Don't hide picker on esc key press or tap outside #16941

hayata-suenaga · 2023-04-04T22:13:24Z

Details

As per this slack convo, we decided to not to hide the calendar when the click event happens outside or the ESC key is pressed. With this PR, the calendar doesn't hide itself anymore on web (on mobile native platforms, the calendar already doesn't hide when tapped outside.).

Fixed Issues

$ #16422

Tests / QA Steps

Login to NewDot
Settings (click or tap the profile avatar) > Profile > Personal details > Date of birth
Check the date picker (calendar) opens up
Click or tap outside the date picker. Make sure that the calendar does NOT close
Select a date on the date picker. Make sure that the calendar does NOT close
On a device with a keyboard (laptop chrome or safari), do the same thing though step 1 - step 3
Press the Escape key. Make sure that the calendar does NOT close
Verify that no errors appear in the JS console throughout the process

PR Author Checklist

Screenshots/Videos

Web

chrome.mov

safari.mov

Mobile Web - Chrome

mobile.chrome.mov

Mobile Web - Safari

mobile.safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

MelvinBot · 2023-04-04T22:37:46Z

@MonilBhavsar Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

src/components/NewDatePicker/index.js

mountiny

Looking good, thanks for the changes, agree with the suggestion from @s77rt

@hayata-suenaga wanted to note to make sure you link the issues correctly, it should just be a dollar sign followed by the actual github link which will allow for our automation for reviewers and deploy to work.

Also one more suggestion, can you please always try to add some info to the details section? I know it might be repeating whats in the issue but its great to have some context there on a first line "doing this because we decided that this is better than that"

Thank you very much 🙇

hayata-suenaga · 2023-04-05T15:36:01Z

@mountiny updated the OP. thank you for the advice 🙇🏻‍♂️

mountiny

@s77rt or @rushatgabhane who has time to run through the checklist?

s77rt · 2023-04-05T15:40:31Z

@rushatgabhane Was auto-assigned here #16422 but will take this PR if @rushatgabhane didn't.

s77rt · 2023-04-05T15:44:34Z

src/components/NewDatePicker/index.js

+        this.showPicker();
+        this.textInputRef.focus();


Since we both show the picker and focus the input on component mount. Shouldn't we do the same on DOB? As suggested here #16779 (comment) just for consistency. (whenever the calendar is shown, the input is also focused)

mountiny · 2023-04-05T16:46:00Z

I think this will be updated that we wont close the picker after selection so hold on testing @s77rt thanks!

mountiny

@hayata-suenaga I think we need to update the test a little bit, it says the picker should be closed when user selects the date, but we concluded it should never close.

cc @s77rt are you able to run tests on this, the picker should basically never close.

s77rt

diff --git a/src/components/NewDatePicker/datePickerPropTypes.js b/src/components/NewDatePicker/datePickerPropTypes.js
index 0c3906e3c6..514a77a6c2 100644
--- a/src/components/NewDatePicker/datePickerPropTypes.js
+++ b/src/components/NewDatePicker/datePickerPropTypes.js
@@ -29,9 +29,6 @@ const propTypes = {
 
     /** Default year to be set in the calendar picker */
     selectedYear: PropTypes.string,
-
-    /** A function called when picked is closed */
-    onHidePicker: PropTypes.func,
 };
 
 const defaultProps = {
@@ -39,7 +36,6 @@ const defaultProps = {
     minDate: moment().year(CONST.CALENDAR_PICKER.MIN_YEAR).toDate(),
     maxDate: moment().year(CONST.CALENDAR_PICKER.MAX_YEAR).toDate(),
     value: undefined,
-    onHidePicker: () => {},
 };
 
 export {propTypes, defaultProps};
diff --git a/src/components/NewDatePicker/index.js b/src/components/NewDatePicker/index.js
index e117eaf9f2..77f061d95b 100644
--- a/src/components/NewDatePicker/index.js
+++ b/src/components/NewDatePicker/index.js
@@ -47,14 +47,6 @@ class NewDatePicker extends React.Component {
             return;
         }
         this.showPicker();
-        this.textInputRef.focus();
-    }
-
-    componentWillUnmount() {
-        if (!this.unsubscribeEscapeKey) {
-            return;
-        }
-        this.unsubscribeEscapeKey();
     }
 
     /**
@@ -73,7 +65,6 @@ class NewDatePicker extends React.Component {
     setDate(selectedDate) {
         this.setState({selectedDate}, () => {
             this.props.onInputChange(moment(selectedDate).format(CONST.DATE.MOMENT_FORMAT_STRING));
-            this.textInputRef.blur();
         });
     }
 
@@ -96,7 +87,6 @@ class NewDatePicker extends React.Component {
                 <View style={[this.props.isSmallScreenWidth ? styles.flex2 : {}]}>
                     <TextInput
                         forceActiveLabel
-                        ref={el => this.textInputRef = el}
                         icon={Expensicons.Calendar}
                         onPress={this.showPicker}
                         label={this.props.label}
@@ -112,13 +102,7 @@ class NewDatePicker extends React.Component {
                 </View>
                 {
                     this.state.isPickerVisible && (
-                    <Animated.View
-                        onMouseDown={(e) => {
-                            // To prevent focus stealing
-                            e.preventDefault();
-                        }}
-                        style={[styles.datePickerPopover, styles.border, {opacity: this.opacity}]}
-                    >
+                    <Animated.View style={[styles.datePickerPopover, styles.border, {opacity: this.opacity}]}>
                         <CalendarPicker
                             minDate={this.props.minDate}
                             maxDate={this.props.maxDate}
diff --git a/src/pages/settings/Profile/PersonalDetails/DateOfBirthPage.js b/src/pages/settings/Profile/PersonalDetails/DateOfBirthPage.js
index 4983c2cc5f..3174c8d6e9 100644
--- a/src/pages/settings/Profile/PersonalDetails/DateOfBirthPage.js
+++ b/src/pages/settings/Profile/PersonalDetails/DateOfBirthPage.js
@@ -39,7 +39,6 @@ class DateOfBirthPage extends Component {
 
         this.validate = this.validate.bind(this);
         this.updateDateOfBirth = this.updateDateOfBirth.bind(this);
-        this.clearSelectedYear = this.clearSelectedYear.bind(this);
         this.getYearFromRouteParams = this.getYearFromRouteParams.bind(this);
         this.minDate = moment().subtract(CONST.DATE_BIRTH.MAX_AGE, 'Y').toDate();
         this.maxDate = moment().subtract(CONST.DATE_BIRTH.MIN_AGE, 'Y').toDate();
@@ -65,9 +64,6 @@ class DateOfBirthPage extends Component {
         const {params} = this.props.route;
         if (params && params.year) {
             this.setState({selectedYear: params.year});
-            if (this.datePicker) {
-                this.datePicker.showPicker();
-            }
         }
     }
 
@@ -82,13 +78,6 @@ class DateOfBirthPage extends Component {
         );
     }
 
-    /**
-     * A function to clear selected year
-     */
-    clearSelectedYear() {
-        this.setState({selectedYear: ''});
-    }
-
     /**
      * @param {Object} values
      * @param {String} values.dob - date of birth
@@ -131,14 +120,12 @@ class DateOfBirthPage extends Component {
                 >
                     <NewDatePicker
                         autoFocus
-                        ref={ref => this.datePicker = ref}
                         inputID="dob"
                         label={this.props.translate('common.date')}
                         defaultValue={privateDetails.dob || ''}
                         minDate={this.minDate}
                         maxDate={this.maxDate}
                         selectedYear={this.state.selectedYear}
-                        onHidePicker={this.clearSelectedYear}
                     />
                 </Form>
             </ScreenWrapper>

NewDatePicker

onHidePicker callback is no longer needed: calendar won't hide.
textInputRef is no longer needed: we no longer need to focus/blur that was used in combination with hiding the calendar.
unsubscribeEscapeKey is never set since we won't hide the calendar on ESC.
Animated.View no longer need to handle the onMouseDown, this was only used for focus management (prevent focus stealing).

DateOfBirthPage

clearSelectedYear is redundant as we removed the onHidePicker callback.
datePicker.showPicker() is redundant, the picker is already shown since we didn't hide it in the first place.

Sorry I had to include this in one diff. I can't suggest changes on code beyond the PR.

hayata-suenaga · 2023-04-06T16:17:14Z

I think we need to update the test a little bit, it says the picker should be closed when user selects the date, but we concluded it should never close.

I updated the test steps

@s77rt thank you for the astute PR review. I pushed the new commit.

s77rt · 2023-04-06T17:18:42Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mp4

Mobile Web - Chrome

mweb-chrome.mp4

Mobile Web - Safari

mweb-safari.mp4

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

s77rt

LGTM! 🚀

rushatgabhane · 2023-04-06T20:46:33Z

thanks for the review @s77rt, i won't be reviewing this because of ⌚ 😢

rushatgabhane · 2023-04-06T20:49:30Z

~~Wait what, the expected result of the issue is - on tap outside, the calendar should be closed.~~

~~@hayata-suenaga why are we doing the opposite?~~

Edit: nvm, i read the slack convo

hayata-suenaga · 2023-04-07T17:47:17Z

sorry @s77rt i realized you already approved this PR

s77rt

No problem @hayata-suenaga. Approving again 😁

mountiny

Thanks @hayata-suenaga and @s77rt!

OSBotify · 2023-04-11T17:57:37Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-04-11T21:25:46Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.2.99-0 🚀

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2023-04-13T03:01:47Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.2.99-6 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

don't hide picker on esc key press or tap outside

928e600

hayata-suenaga marked this pull request as ready for review April 4, 2023 22:37

hayata-suenaga requested a review from a team as a code owner April 4, 2023 22:37

melvin-bot bot requested review from MonilBhavsar and removed request for a team April 4, 2023 22:37

hayata-suenaga requested a review from rushatgabhane April 4, 2023 22:41

s77rt reviewed Apr 4, 2023

View reviewed changes

src/components/NewDatePicker/index.js Outdated Show resolved Hide resolved

mountiny reviewed Apr 5, 2023

View reviewed changes

remove unused ref assignment

2351b32

mountiny assigned hayata-suenaga Apr 5, 2023

mountiny previously approved these changes Apr 5, 2023

View reviewed changes

s77rt reviewed Apr 5, 2023

View reviewed changes

don't hide calendar at all

748f960

hayata-suenaga dismissed mountiny’s stale review via 748f960 April 5, 2023 18:01

s77rt mentioned this pull request Apr 5, 2023

[HOLD for payment 2023-03-31] Implement New Date Picker Design #14322

Closed

mountiny reviewed Apr 6, 2023

View reviewed changes

s77rt suggested changes Apr 6, 2023

View reviewed changes

remove unnecessary or redundant code

a6f0df1

hayata-suenaga requested review from mountiny and s77rt April 6, 2023 16:50

s77rt approved these changes Apr 6, 2023

View reviewed changes

s77rt mentioned this pull request Apr 7, 2023

[HOLD for payment 2023-06-07] [$1000] Personal details - DOB field does not get updated if year only changed. #16514

Closed

6 tasks

hayata-suenaga requested a review from s77rt April 7, 2023 17:46

s77rt approved these changes Apr 7, 2023

View reviewed changes

mountiny approved these changes Apr 11, 2023

View reviewed changes

mountiny merged commit 7458fe3 into main Apr 11, 2023

mountiny deleted the hayata-don'tCloseCalendarOnTapOutside branch April 11, 2023 17:50

OSBotify mentioned this pull request Apr 11, 2023

Deploy Checklist: New Expensify 2023-04-11 #17298

Closed

26 tasks

kavimuru mentioned this pull request Apr 12, 2023

Desktop - "ESC" key closes the calendar data #17354

Closed

6 tasks

MelvinBot mentioned this pull request Apr 13, 2023

[HOLD for payment 2023-04-20] Calendar closes on click outside and on date selection although it should never close #16422

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Don't hide picker on esc key press or tap outside #16941

Don't hide picker on esc key press or tap outside #16941

hayata-suenaga commented Apr 4, 2023 •

edited

Loading

MelvinBot commented Apr 4, 2023

mountiny left a comment

hayata-suenaga commented Apr 5, 2023

mountiny left a comment

s77rt commented Apr 5, 2023

s77rt Apr 5, 2023

mountiny commented Apr 5, 2023

mountiny left a comment

s77rt left a comment

hayata-suenaga commented Apr 6, 2023

s77rt commented Apr 6, 2023

s77rt left a comment

rushatgabhane commented Apr 6, 2023

rushatgabhane commented Apr 6, 2023 •

edited

Loading

hayata-suenaga commented Apr 7, 2023

s77rt left a comment

mountiny left a comment

OSBotify commented Apr 11, 2023

OSBotify commented Apr 11, 2023

OSBotify commented Apr 13, 2023

Don't hide picker on esc key press or tap outside #16941

Don't hide picker on esc key press or tap outside #16941

Conversation

hayata-suenaga commented Apr 4, 2023 • edited Loading

Details

Fixed Issues

Tests / QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 4, 2023

mountiny left a comment

Choose a reason for hiding this comment

hayata-suenaga commented Apr 5, 2023

mountiny left a comment

Choose a reason for hiding this comment

s77rt commented Apr 5, 2023

s77rt Apr 5, 2023

Choose a reason for hiding this comment

mountiny commented Apr 5, 2023

mountiny left a comment

Choose a reason for hiding this comment

s77rt left a comment

Choose a reason for hiding this comment

hayata-suenaga commented Apr 6, 2023

s77rt commented Apr 6, 2023

Reviewer Checklist

Screenshots/Videos

s77rt left a comment

Choose a reason for hiding this comment

rushatgabhane commented Apr 6, 2023

rushatgabhane commented Apr 6, 2023 • edited Loading

hayata-suenaga commented Apr 7, 2023

s77rt left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Apr 11, 2023

OSBotify commented Apr 11, 2023

OSBotify commented Apr 13, 2023

hayata-suenaga commented Apr 4, 2023 •

edited

Loading

rushatgabhane commented Apr 6, 2023 •

edited

Loading