17018 — migrate CheckboxWithLabel to the PressableWithFeeback component #18792

robertKozik · 2023-05-11T19:09:17Z

Details

This PR migrates the soon-to-be deprecated TouchableOpacity to the PressableWithFeedback component. Changes the AccessibilityLabel of BaseGenericPressable to be required only when component is set to be accessible.

Fixed Issues

$ #17018
PROPOSAL: #17018

Tests

Make sure that every instance of CheckboxWithLabel is working correctly (fe. enablePaymentPage when adding debit card as new payment method)

Access the screen with instance of CheckboxWithLabel
Click on the text next to the checkbox
Verify that state of checkbox has changed

Verify that no errors appear in the JS console

Offline tests

SAME AS TEST STEPS

QA Steps

SAME AS TEST STEPS

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Desktop.-.web.mov

Mobile Web - Chrome

Android.-.chrome.mov

Mobile Web - Safari

iOS.-.safari.mov

Desktop

Desktop.-.electron.mov

iOS

iOS.-.native.mov

Android

Android.-.native.mov

melvin-bot · 2023-05-11T19:09:21Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

melvin-bot · 2023-05-15T08:24:45Z

@Santhosh-Sellavel @marcaaron One of you needs to 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]

Santhosh-Sellavel · 2023-05-15T18:41:29Z

@robertKozik

Checkbox label gets cropped off

Before

Santhosh-Sellavel

Please address this

src/components/CheckboxWithLabel.js

…_label

robertKozik · 2023-05-15T21:32:42Z

I wasn't sure on which device you were testing but after changes I've checked it on web inside resonsive design tool:

test on responsivnes

Screen.Recording.2023-05-15.at.23.30.52.mov

Santhosh-Sellavel · 2023-05-17T00:53:15Z

Thanks, @robertKozik this was from the web/desktop.

On iOS/Android it is still broken.

Before

Now

Content is overflowing outside the padding on the right side.

…_label

robertKozik · 2023-05-17T13:25:58Z

I saw lint is not failing, I'll handle it asap

Santhosh-Sellavel · 2023-05-17T18:49:39Z

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 & Desktop

Screen.Recording.2023-05-17.at.11.45.55.PM.mov

Mobile Web - Chrome

Screen_Recording_20230518_000723_Chrome.mp4

Mobile Web - Safari & iOS

Simulator.Screen.Recording.-.iPhone.14.-.2023-05-18.at.00.08.54.mp4

Android

Screen_Recording_20230518_001843_New.Expensify.mp4

Santhosh-Sellavel

Looks good, and tests well.

It is not working on the storybook. Seems it's not been updated for a while. What should we do here @marcaaron

robertKozik · 2023-05-18T16:40:37Z

I checked the storybook problem, and it's easily solvable, so I'll include it in a sec

Santhosh-Sellavel · 2023-05-18T20:17:27Z

@robertKozik

Still IsChecked controls don't work as it works for Checkbox.

Screen.Recording.2023-05-19.at.1.43.07.AM.mov

cc: @marcaaron

robertKozik · 2023-05-18T20:30:50Z

CheckboxWithLabel due to some previous updates self manages its state. Passed isChecked prop is just kind of "default state" as I saw how its working

Santhosh-Sellavel · 2023-05-18T20:39:19Z

@marcaaron What should we do here?

…_label

roryabraham

Can we please:

Migrate CheckboxWithLabel to a function component.
Update isChecked state when the passed-in isChecked prop changes:

useEffect(() => setIsChecked(props.isChecked), [props.isChecked]);

robertKozik · 2023-05-24T07:32:35Z

Sure no problem, I'll do it today.

robertKozik · 2023-05-24T10:53:30Z

All requested changes are implemented, but when starting storybook I've encountered an error

ERR! Error: ENOENT: no such file or directory, open '/Users/robertkozik/sw-projects/Expensify_app_fork/assets/images/new-expensifyundefined.svg'

as I check its related with choosing the splashLogo inside webpack.common.js in mapEnvToLogoSuffix function. Does it occur for you too, or it's problem on my side? if not I can create the bug report for it

Regardless, after coping with that problem CheckboxWithLabel is working fine in the storybook.

Santhosh-Sellavel · 2023-05-24T18:22:35Z

@robertKozik Conflicts here, please resolve when you get a chance! I'll get through the checklist tomorrow!

…_label

…ste it directly

Santhosh-Sellavel · 2023-05-25T19:16:08Z

All requested changes are implemented, but when starting storybook I've encountered an error
ERR! Error: ENOENT: no such file or directory, open '/Users/robertkozik/sw-projects/Expensify_app_fork/assets/images/new-expensifyundefined.svg'
as I check its related with choosing the splashLogo inside webpack.common.js in mapEnvToLogoSuffix function. Does it occur for you too, or it's problem on my side? if not I can create the bug report for it

Regardless, after coping with that problem CheckboxWithLabel is working fine in the storybook.

This occurs to me, please report it. And yes CheckboxWithLabel looks good on the storybook after fixing the error!

Santhosh-Sellavel

LGTM tests well!

Santhosh-Sellavel · 2023-05-25T19:49:37Z

All your @roryabraham!

OSBotify · 2023-05-31T19:17:45Z

✋ 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-01T03:49:55Z

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

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

OSBotify · 2023-06-02T12:39:59Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.22-1 🚀

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

OSBotify · 2023-06-02T13:14:43Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.22-1 🚀

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

OSBotify · 2023-06-02T14:01:41Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.22-1 🚀

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

aimane-chnaif · 2023-06-05T06:53:38Z

src/components/CheckboxWithLabel.js

+                />
+                <PressableWithFeedback
+                    focusable={false}
+                    accessible={false}


Coming from #20153:

accessible={false}

@robertKozik Is this intentional or temporary solution to fix console error?

It's intentional, we have checkbox accessible and focusable itself. I wanted to remove two accessible views one next to another, which are doing the same

hungvu193 · 2025-11-14T10:30:51Z

src/components/CheckboxWithLabel.js

+const CheckboxWithLabel = (props) => {
+    // We need to pick the first value that is strictly a boolean
+    // https://github.com/Expensify/App/issues/16885#issuecomment-1520846065
+    const [isChecked, setIsChecked] = useState(_.find([props.value, props.defaultValue, props.isChecked], (value) => _.isBoolean(value)));


We also need to check the case when the checkbox is controlled or uncontrolled.

More details here:

#73894 (comment)

robertKozik added 2 commits May 11, 2023 21:01

make accessibilityLabel required only when Pressable is accessible

9b68730

migrate CheckboxWithLabel from TouchableOpacity to PressableWithFeedback

beb8268

robertKozik mentioned this pull request May 12, 2023

[$1000] [HOLD for payment 2023-06-09] [Group 2][Accessible Pressable] Migrate CheckboxWithLabel #17018

Closed

robertKozik marked this pull request as ready for review May 15, 2023 08:24

robertKozik requested a review from a team as a code owner May 15, 2023 08:24

melvin-bot bot requested review from Santhosh-Sellavel and marcaaron and removed request for a team May 15, 2023 08:24

Santhosh-Sellavel suggested changes May 15, 2023

View reviewed changes

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

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

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

robertKozik added 3 commits May 15, 2023 21:29

Merge remote-tracking branch 'upstream/main' into 17018_checkbox_with…

c6fa14f

…_label

split CheckboxWithLabel styles into wrapperStyle and normal style

72939ee

change the way Pressables components are imported in CheckboxWithLabel

c80d5f9

robertKozik requested a review from Santhosh-Sellavel May 16, 2023 10:00

robertKozik added 2 commits May 17, 2023 12:31

update styles to on Checkbox label to cover all platforms

3ad0928

Merge remote-tracking branch 'upstream/main' into 17018_checkbox_with…

e90c244

…_label

fix custom propType test for accessibilityLabel

7f5a642

Santhosh-Sellavel reviewed May 17, 2023

View reviewed changes

fix storybook for CheckboxWithLabel

6e98e55

Merge remote-tracking branch 'upstream/main' into 17018_checkbox_with…

c522d60

…_label

marcaaron removed their request for review May 22, 2023 21:29

roryabraham requested changes May 23, 2023

View reviewed changes

migrate CheckboxWithLabel to functionalComponent

5e345c8

robertKozik requested review from Santhosh-Sellavel and roryabraham May 24, 2023 10:53

robertKozik added 4 commits May 24, 2023 20:41

Merge remote-tracking branch 'upstream/main' into 17018_checkbox_with…

f887784

…_label

set inner checked state when props.isChecked changes

79b87ab

prettier did honest job on CheckboxWithLabel

eb0c8ee

remove function getCheckedStateFromProps as it has only one usage, pa…

fb6f822

…ste it directly

Santhosh-Sellavel approved these changes May 25, 2023

View reviewed changes

Skalakid mentioned this pull request May 31, 2023

17027 - migrated CollapsibleSection to PressableWithFeedback #19753

Merged

57 tasks

roryabraham approved these changes May 31, 2023

View reviewed changes

roryabraham merged commit 2f9cc6d into Expensify:main May 31, 2023

OSBotify mentioned this pull request Jun 1, 2023

Deploy Checklist: New Expensify 2023-06-01 #19928

Closed

13 tasks

aimane-chnaif reviewed Jun 5, 2023

View reviewed changes

This was referenced Jun 5, 2023

adding accessibleLabel to checkboxLabel component #20153

Closed

[HOLD for payment 2023-06-08][$1000] Dev: Console error on reload page in Connect bank account page #19757

Closed

NikkiWines mentioned this pull request Jun 5, 2023

[$250] Migrate CheckboxWithLabel.js to function component #16124

Closed

1 task

luacmartins mentioned this pull request Jun 12, 2023

Fix Form useEffect #20091

Merged

57 tasks

hungvu193 reviewed Nov 14, 2025

View reviewed changes

17018 — migrate CheckboxWithLabel to the PressableWithFeeback component #18792

17018 — migrate CheckboxWithLabel to the PressableWithFeeback component #18792

Uh oh!

Conversation

robertKozik commented May 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented May 11, 2023

Uh oh!

melvin-bot bot commented May 15, 2023

Uh oh!

Santhosh-Sellavel commented May 15, 2023

Checkbox label gets cropped off

Before

Uh oh!

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

robertKozik commented May 15, 2023

Uh oh!

Santhosh-Sellavel commented May 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before

Now

Uh oh!

robertKozik commented May 17, 2023

Uh oh!

Santhosh-Sellavel commented May 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

Uh oh!

robertKozik commented May 18, 2023

Uh oh!

Santhosh-Sellavel commented May 18, 2023

Uh oh!

robertKozik commented May 18, 2023

Uh oh!

Santhosh-Sellavel commented May 18, 2023

Uh oh!

roryabraham left a comment

Choose a reason for hiding this comment

Uh oh!

robertKozik commented May 24, 2023

Uh oh!

robertKozik commented May 24, 2023

Uh oh!

Santhosh-Sellavel commented May 24, 2023

Uh oh!

Santhosh-Sellavel commented May 25, 2023

Uh oh!

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

Uh oh!

Santhosh-Sellavel commented May 25, 2023

Uh oh!

OSBotify commented May 31, 2023

Uh oh!

OSBotify commented Jun 1, 2023

Uh oh!

OSBotify commented Jun 2, 2023

Uh oh!

OSBotify commented Jun 2, 2023

Uh oh!

OSBotify commented Jun 2, 2023

Uh oh!

aimane-chnaif Jun 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

robertKozik commented May 11, 2023 •

edited

Loading

Santhosh-Sellavel commented May 17, 2023 •

edited

Loading

Santhosh-Sellavel commented May 17, 2023 •

edited

Loading

aimane-chnaif Jun 5, 2023 •

edited

Loading