Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix green outline at checkbox #13181

Merged
merged 6 commits into from
Dec 7, 2022
Merged

Fix green outline at checkbox #13181

merged 6 commits into from
Dec 7, 2022

Conversation

hungvu193
Copy link
Contributor

@hungvu193 hungvu193 commented Nov 30, 2022

Fix: Green outline at checkbox

Details

Fixed Issues

$ #11283
PROPOSAL: #11283 (comment)

Tests

  1. Open the web, navigate to Settings => Workspaces, choose any Workspace => Manage Members.
  2. Press any checkbox to select it then press again to unselect.
  3. Verify that the checkbox doesn't have the green outline after being unselected.
  4. Check all the checkbox except Select All, unselect one of them (except Select All) to make Select All's unselected.
  5. Verify that the Select All checkbox doesn't have green outline after being unselected.
  • Verify that no errors appear in the JS console

QA Steps

  1. Open the web, navigate to Settings => Workspaces, choose any Workspace => Manage Members.
  2. Press any checkbox to select it then press again to unselect.
  3. Verify that the checkbox doesn't have the green outline after being unselected.
  4. Check all the checkbox except Select All, unselect one of them (except Select All) to make Select All's unselected.
  5. Verify that the Select All checkbox doesn't have green outline after being unselected.
  • Verify that no errors appear in the JS console

PR Review Checklist

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 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 included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • 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 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
  • 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 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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

  • 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:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 was added in all src/languages/* files
    • 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots

Web

Screen.Recording.2022-11-30.at.10.24.17.mov

Mobile Web - Chrome

Screen.Recording.2022-11-30.at.10.38.45.mov

Mobile Web - Safari

Screen.Recording.2022-11-30.at.10.39.27.mov

Desktop

Screen.Recording.2022-11-30.at.10.42.26.mov

iOS

Screen.Recording.2022-11-30.at.10.49.08.mov

Android

Screen.Recording.2022-11-30.at.10.50.25.mov

@hungvu193 hungvu193 requested a review from a team as a code owner November 30, 2022 03:52
@melvin-bot melvin-bot bot requested review from Luke9389 and parasharrajat and removed request for a team November 30, 2022 03:52
@melvin-bot
Copy link

melvin-bot bot commented Nov 30, 2022

@Luke9389 @parasharrajat 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]

src/components/Checkbox.js Outdated Show resolved Hide resolved
src/components/Checkbox.js Outdated Show resolved Hide resolved
src/components/Checkbox.js Outdated Show resolved Hide resolved
src/components/Checkbox.js Outdated Show resolved Hide resolved
Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hungvu193 Could you please help me understand the flow of checkbox states with your changes? what change is responsible for which behavior?

for example, calling onBlur in onPress will do this when.....

@hungvu193
Copy link
Contributor Author

@hungvu193 Could you please help me understand the flow of checkbox states with your changes? what change is responsible for which behavior?

for example, calling onBlur in onPress will do this when.....

@parasharrajat Sure.

        if (this.state.isFocused && this.props.isChecked) {
            this.onBlur();
        }

This piece of code to make sure checkbox is unfocused when checkbox is unselected.
But we also want to make sure it can handle edge cases like long press on checkbox (but don't release the mouse) then move mouse to other place..etc, so I use onPressOut to make sure it will unfocused in this case.

onPressOut={this.onBlur}

And finally to make sure when checkbox is checked, the border turned green:

 (this.state.isFocused || this.props.isChecked) && styles.borderColorFocus,

@parasharrajat
Copy link
Member

This piece of code makes sure the checkbox is unfocused when the checkbox is unselected.

Let me think about this part a bit. I am confusing its use with onPressOut. Basically, onPressOut is always called after onPress.

@hungvu193
Copy link
Contributor Author

hungvu193 commented Nov 30, 2022

This piece of code makes sure the checkbox is unfocused when the checkbox is unselected.

Let me think about this part a bit. I am confusing its use with onPressOut. Basically, onPressOut is always called after onPress.

In this case onClick isn't fired and only onPressOut is fired, that's the edge case that I mentioned.

Screen.Recording.2022-11-30.at.23.18.01.mov

Here's the normal case:

Screen.Recording.2022-11-30.at.23.19.14.mov

@parasharrajat
Copy link
Member

Yeah, so why do we need to call onBlur on both onPress and onPressOut if onPressOut can handle both.

@hungvu193
Copy link
Contributor Author

@parasharrajat there was another edge case with onPressOut, when you press the checkbox at very edge of the border, it won't get called, so the outline still green, that's why I still need handle it inside onClick.
Here's the video about it:

Screen.Recording.2022-12-01.at.00.06.41.mov

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshots

🔲 iOS / native

screen-2022-12-02_21.46.06.mp4

🔲 iOS / Safari

screen-2022-12-02_18.11.11.mp4

🔲 MacOS / Desktop

screen-2022-12-02_18.10.50.mp4

🔲 MacOS / Chrome

screen-2022-12-02_18.05.48.mp4

🔲 Android / Chrome

screen-2022-12-02_22.10.30.mp4

🔲 Android / native

screen-2022-12-02_23.06.02.mp4

@hungvu193
Copy link
Contributor Author

Wait for #13271 to be merged, since the main branch has a regression with current checkbox.

@hungvu193
Copy link
Contributor Author

@parasharrajat Seem like it's merged, we are good to go now :D

parasharrajat
parasharrajat previously approved these changes Dec 2, 2022
Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 was added in all src/languages/* files
    • 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

cc: @Luke9389

🎀 👀 🎀 C+ reviewed

@parasharrajat
Copy link
Member

@hungvu193 Please merge main.

@hungvu193
Copy link
Contributor Author

@hungvu193 Please merge main.

I've just merged with main again :)

parasharrajat
parasharrajat previously approved these changes Dec 2, 2022
arosiclair
arosiclair previously approved these changes Dec 6, 2022
Copy link
Contributor

@arosiclair arosiclair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jumping on this to move it along. LGTM

@Luke9389 Luke9389 merged commit cbe3b1e into Expensify:main Dec 7, 2022
@OSBotify
Copy link
Contributor

OSBotify commented Dec 7, 2022

✋ 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
Copy link
Contributor

🚀 Deployed to production by @chiragsalian in version: 1.2.38-6 🚀

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

Comment on lines +88 to +90
if (this.state.isFocused && wasChecked) {
this.onBlur();
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This caused a regression #18801. The onBlur should not be called explicitly, it should be called only when indeed the checkbox is blurred. This PR is trying to achieve focus-visible styles using focus state which won't work correctly due to the nature of how focus-visible style is maintained in browsers.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it was an intentional change. I am sure you will find a lot of discussion over it in the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants