17051 - migrated Checkbox to PressableWithFeedback #20257

Skalakid · 2023-06-06T11:45:28Z

Details

Fixed Issues

$ #17051
PROPOSAL: #17051

Tests

Log in
Enter Settings > Payments
Click Add payment method
Choose Debit card
Click the checkbox I accept the Expensify Terms of Service, verify styling and behavior

Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as Tests

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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 code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

mWeb-chrome.mov

Mobile Web - Safari

mWeb-safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

melvin-bot · 2023-06-06T11:46:02Z

@marcaaron 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]

abdulrahuman5196 · 2023-06-07T15:43:23Z

Will be working on C+ review

abdulrahuman5196

I will be working on C+ review

abdulrahuman5196 · 2023-06-08T15:21:11Z

@Skalakid Kindly fill the Offline test and QA Steps section. If its same as the test, then add "Same as Tests" in the section.

abdulrahuman5196 · 2023-06-08T15:34:54Z

src/components/Checkbox.js

@@ -45,6 +49,7 @@ const defaultProps = {
    forwardedRef: undefined,
    children: null,
    onMouseDown: undefined,
+    accessibilityLabel: 'checkbox',


Shouldn't the default accessibilityLabel be empty string? Since it will not be useful to read out checkbox without context in case of default is not useful?

Good point, I will change that

abdulrahuman5196 · 2023-06-08T15:38:00Z

src/components/Checkbox.js

                disabled={this.props.disabled}
                onPress={this.firePressHandlerOnClick}
                onMouseDown={this.props.onMouseDown}
                onFocus={this.onFocus}
                onBlur={this.onBlur}
                ref={this.props.forwardedRef}
                onPressOut={this.onBlur}
-                style={this.props.style}
+                style={[this.props.style, styles.userSelectNone]}


And any reason to not allow user to select the checkbox text?

Previously after double-clicking the checkbox icon was somehow selectable, now after I merged the latest main I can't reproduce it so I can remove it

abdulrahuman5196 · 2023-06-15T09:20:13Z

src/components/Checkbox.js

                style={this.props.style}
                onKeyDown={this.handleSpaceKey}
                accessibilityRole="checkbox"
                accessibilityState={{
                    checked: this.props.isChecked,
                }}
+                accessibilityLabel={this.props.accessibilityLabel}
+                hoverDimmingValue={1}


can we remove this? Since currently the default for hoverDimmingValue is 1?

abdulrahuman5196 · 2023-06-15T17:37:23Z

src/components/Checkbox.js

                disabled={this.props.disabled}
                onPress={this.firePressHandlerOnClick}
                onMouseDown={this.props.onMouseDown}
                ref={this.props.forwardedRef}
+                onPressOut={this.onBlur}


@Skalakid What is this this.onBlur? I always get undefined value for this?

@Skalakid any update on this?

@abdulrahuman5196 Hey, sorry for the late response, I just fixed this by merging with the main ;) I think it was added after merging with main, now it's gone

abdulrahuman5196 · 2023-06-20T16:25:24Z

@Skalakid The eye icon on the password entry field of pdf attachment is moved up due to this change.
Note: The eye also uses the Checkbox component.

Steps

Add password protected pdf to a chat
choose enter password
eye icon should be middle

main branch

this PR with PressableWithFeedback

abdulrahuman5196 · 2023-06-22T13:11:55Z

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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is 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 code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
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

Screen.Recording.2023-06-22.at.5.57.11.PM.mp4

Mobile Web - Chrome

az_recorder_20230622_175907.mp4

Mobile Web - Safari

ios.safari.1.mp4

Desktop

Screen.Recording.2023-06-22.at.6.16.26.PM.mp4

iOS

Screen.Recording.2023-06-22.at.6.11.21.PM.mp4

Android

az_recorder_20230622_182104.mp4

abdulrahuman5196 · 2023-06-22T13:13:49Z

src/components/Checkbox.js

@@ -34,6 +35,9 @@ const propTypes = {

    /** A ref to forward to the Pressable */
    forwardedRef: PropTypes.oneOfType([PropTypes.func, PropTypes.shape({current: PropTypes.instanceOf(React.Component)})]),
+
+    /** A ref to forward to the Pressable */


@Skalakid Wrong type comment here. Could you update this?

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours @marcaaron

🎀👀🎀
C+ Reviewed

src/components/TextInput/BaseTextInput.js

src/components/Checkbox.js

marcaaron · 2023-06-27T20:24:01Z

Gonna unassign myself from reviews here as @roryabraham is managing this project and I think as the assignee to the original issue is the "correct reviewer". That said, if you need an extra set of eyes let me know and I'll be happy to jump back in!

roryabraham · 2023-06-28T23:07:51Z

@Skalakid Can you resolve conflicts here please?

melvin-bot · 2023-06-29T18:21:48Z

@roryabraham looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

roryabraham · 2023-06-29T18:22:17Z

Not an emergency, was just too trigger-happy with the merge button and my approval kicked off a new check for the checklist

OSBotify · 2023-06-29T18:25:53Z

✋ 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-06-29T20:37:09Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.35-0 🚀

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

OSBotify · 2023-07-03T14:35:00Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.35-5 🚀

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

OSBotify · 2023-07-03T15:17:35Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.35-5 🚀

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

eVoloshchak · 2023-07-26T18:54:39Z

src/components/Checkbox.js

@@ -67,7 +71,7 @@ function Checkbox(props) {
    };

    return (
-        <Pressable
+        <PressableWithFeedback
            disabled={props.disabled}


👋 Just a heads-up that this has caused a small regression in #22413
BaseGenericPressable didn't have the logic to disable onKeyDown handler when disabled prop is true
We resolved this by adding the following condition

onKeyDown={!isDisabled ? onKeyDown : undefined}

migrated Checkbox to PressableWithFeedback

ac6b7d7

Skalakid requested a review from a team as a code owner June 6, 2023 11:45

melvin-bot bot requested review from marcaaron and removed request for a team June 6, 2023 11:46

abdulrahuman5196 reviewed Jun 7, 2023

View reviewed changes

abdulrahuman5196 reviewed Jun 8, 2023

View reviewed changes

Skalakid added 2 commits June 12, 2023 11:32

Merge branch 'main' into 17051-migrate-Checkbox

73859b7

Review changes

0690682

Skalakid requested a review from abdulrahuman5196 June 12, 2023 09:54

abdulrahuman5196 suggested changes Jun 15, 2023

View reviewed changes

Skalakid added 2 commits June 15, 2023 12:10

Merge branch 'main' into 17051-migrate-Checkbox

d16f038

removed hoverDimmingValue as it is set to 1 by default

46c4130

Skalakid requested a review from abdulrahuman5196 June 15, 2023 10:11

abdulrahuman5196 reviewed Jun 15, 2023

View reviewed changes

Merge branch 'main' into 17051-migrate-Checkbox

d25865e

Skalakid requested a review from abdulrahuman5196 June 19, 2023 09:52

Skalakid added 2 commits June 21, 2023 10:18

Merge branch 'main' into 17051-migrate-Checkbox

5d1e5ed

fixed bug with password text input eye icon

4917bf7

abdulrahuman5196 suggested changes Jun 22, 2023

View reviewed changes

updated comment

56b01f4

Skalakid requested a review from abdulrahuman5196 June 23, 2023 13:51

abdulrahuman5196 approved these changes Jun 23, 2023

View reviewed changes

melvin-bot bot requested a review from roryabraham June 23, 2023 14:49

Skalakid mentioned this pull request Jun 26, 2023

[HOLD for payment 2023-07-10] [$250] [Group 5][Accessible Pressable] Migrate Checkbox #17051

Closed

roryabraham requested changes Jun 26, 2023

View reviewed changes

src/components/TextInput/BaseTextInput.js Show resolved Hide resolved

src/components/Checkbox.js Outdated Show resolved Hide resolved

Skalakid force-pushed the 17051-migrate-Checkbox branch from 8c250cf to 56b01f4 Compare June 27, 2023 08:21

review changes + added accessibility labels

a63eee4

Skalakid requested a review from roryabraham June 27, 2023 09:34

marcaaron removed their request for review June 27, 2023 20:24

Merge branch 'main' into 17051-migrate-Checkbox

0426c25

roryabraham approved these changes Jun 29, 2023

View reviewed changes

roryabraham merged commit 8ba6e0b into Expensify:main Jun 29, 2023

melvin-bot bot added the Emergency label Jun 29, 2023

roryabraham removed the Emergency label Jun 29, 2023

roryabraham mentioned this pull request Jun 29, 2023

False emergency label due to repeated checklist check #21886

Closed

OSBotify mentioned this pull request Jun 29, 2023

Deploy Checklist: New Expensify 2023-06-29 #21911

Closed

51 tasks

eVoloshchak reviewed Jul 26, 2023

View reviewed changes

eVoloshchak mentioned this pull request Jul 26, 2023

[HOLD for payment 2023-07-26] [$1000] Web - Admin of a workspace is selected and the remove button is activated by Pressing the space key #22413

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

17051 - migrated Checkbox to PressableWithFeedback #20257

17051 - migrated Checkbox to PressableWithFeedback #20257

Skalakid commented Jun 6, 2023 •

edited

Loading

melvin-bot bot commented Jun 6, 2023

abdulrahuman5196 commented Jun 7, 2023

abdulrahuman5196 left a comment

abdulrahuman5196 commented Jun 8, 2023

abdulrahuman5196 Jun 8, 2023

Skalakid Jun 12, 2023

abdulrahuman5196 Jun 8, 2023

Skalakid Jun 12, 2023

abdulrahuman5196 Jun 15, 2023

abdulrahuman5196 Jun 15, 2023

abdulrahuman5196 Jun 17, 2023

Skalakid Jun 19, 2023

abdulrahuman5196 commented Jun 20, 2023

abdulrahuman5196 commented Jun 22, 2023 •

edited

Loading

abdulrahuman5196 Jun 22, 2023

abdulrahuman5196 left a comment

marcaaron commented Jun 27, 2023

roryabraham commented Jun 28, 2023

melvin-bot bot commented Jun 29, 2023

roryabraham commented Jun 29, 2023

OSBotify commented Jun 29, 2023

OSBotify commented Jun 29, 2023

OSBotify commented Jul 3, 2023

OSBotify commented Jul 3, 2023

eVoloshchak Jul 26, 2023

17051 - migrated Checkbox to PressableWithFeedback #20257

17051 - migrated Checkbox to PressableWithFeedback #20257

Conversation

Skalakid commented Jun 6, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 6, 2023

abdulrahuman5196 commented Jun 7, 2023

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

abdulrahuman5196 commented Jun 8, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abdulrahuman5196 commented Jun 20, 2023

abdulrahuman5196 commented Jun 22, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

marcaaron commented Jun 27, 2023

roryabraham commented Jun 28, 2023

melvin-bot bot commented Jun 29, 2023

roryabraham commented Jun 29, 2023

OSBotify commented Jun 29, 2023

OSBotify commented Jun 29, 2023

OSBotify commented Jul 3, 2023

OSBotify commented Jul 3, 2023

Choose a reason for hiding this comment

Skalakid commented Jun 6, 2023 •

edited

Loading

abdulrahuman5196 commented Jun 22, 2023 •

edited

Loading