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

Removing focus style on blur - Web/Desktop #8765

Merged

Conversation

LucioChavezFuentes
Copy link
Contributor

@LucioChavezFuentes LucioChavezFuentes commented Apr 25, 2022

Details

Pickers onClose is not executed on Web and Desktop, so props.onClose has to be called with onBlur callback.

Fixed Issues

$ #7535 (especifaclly to this regression)

Tests

Web, Desktop, Android / Chrome

  1. Go to Settings --> Preferences. (or any other page with Picker)
  2. Select any Picker, a blue outline focus should appear around it .
    image

( options should also appear, of course)
image

  1. Close the menu options by choosing any element or click out of it.
  2. Click another element or click outside of previoulsy selected Picker.
  3. The blue outline focus of previoulsy selected Pickershould be removed.
    image

iOS, Android, iOS / Safari

Same steps as previous, just make sure the focus style disappear as soon as the menu is closed.

  • Verify that no errors appear in the JS console

PR Review Checklist

Contributor (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 tagging the marketing team 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 */
    • Any functional components have the displayName property
    • 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
  • 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.

PR Reviewer Checklist

  • 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 verified tests pass on all platforms & I tested again 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 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 tagging the marketing team 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 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 */
    • Any functional components have the displayName property
    • 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.

QA Steps

Same steps as Tests section.

  • Verify that no errors appear in the JS console

Screenshots

Web

Screen.Recording.2022-04-29.at.22.14.50.720.mov

Mobile Web / Safari

Screen.Recording.2022-04-29.at.23.10.48.mov

Desktop

Screen.Recording.2022-04-29.at.23.26.32.mov

iOS

Screen.Recording.2022-04-29.at.23.19.22.mov

Android

Screen.Recording.2022-04-29.at.23.32.50.mov

Android/ Chrome

Screen.Recording.2022-04-29.at.23.41.21.mov

@LucioChavezFuentes LucioChavezFuentes requested a review from a team as a code owner April 25, 2022 16:39
@melvin-bot
Copy link

melvin-bot bot commented Apr 25, 2022

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

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Tests well, but I wonder why can't we just standardize on onFocus and onBlur and rename those props in BasePicker?

@LucioChavezFuentes
Copy link
Contributor Author

Tests well, but I wonder why can't we just standardize on onFocus and onBlur and rename those props in BasePicker?

Let me check the scope of these props on Picker component and see if can simplify.

@LucioChavezFuentes
Copy link
Contributor Author

@luacmartins Picker's on onClose and onOpen are used only for native mobile. onFocus and onBlur are used for Web and Desktop. I made a refactor for onFocus and onBlur event so anyone using Picker could use these props independently of platform been developed.
Just think onFocus when you click or tap on Picker and onBlur when you select your option or simply exit with a click or tap out.
If you pass a callback onFocus or onPicker, not only they behave like they currently do (setting or removing the blue outline focus) but also execute the callback passed (like the Form's onBlur callback). Of course, if you pass nothing they just do their current behaviour.

What do you think?

@luacmartins
Copy link
Contributor

@LucioChavezFuentes let's see what you got.

@rushatgabhane
Copy link
Member

rushatgabhane commented Apr 26, 2022

@stitesExpensify @luacmartins
Sorry for the mess I'd like to unassign myself because I'm really slacking off here. And I'm OOO

@luacmartins luacmartins requested review from Santhosh-Sellavel and removed request for rushatgabhane April 26, 2022 18:11
@LucioChavezFuentes
Copy link
Contributor Author

LucioChavezFuentes commented Apr 26, 2022

@luacmartins I made my changes in this PR, take a look on my refactoring onFocus and onBlur .

@luacmartins
Copy link
Contributor

@LucioChavezFuentes I didn't realize how much refactoring and how confusing standardizing on onFocus and onBlur would be when I suggested it. I think it's best to revert the changes from your last commit and go with the simpler approach here. Sorry about the extra work!

@LucioChavezFuentes
Copy link
Contributor Author

No problem. Reverting...

This reverts commit 0dbb44d.

Signed-off-by: LucioChavezFuentes <luciobertinchavez@gmail.com>
@LucioChavezFuentes LucioChavezFuentes force-pushed the remove-focus-style-on-blur branch from ec56e6b to d30e03e Compare April 27, 2022 18:30
@LucioChavezFuentes
Copy link
Contributor Author

PR updated. Ready to be reviewed.

luacmartins
luacmartins previously approved these changes Apr 27, 2022
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for the fix.

@Santhosh-Sellavel
Copy link
Collaborator

I'll check this today.

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Apr 29, 2022

@LucioChavezFuentes

Can you update the PR Screenshots with videos performing the steps?

@LucioChavezFuentes
Copy link
Contributor Author

Can you update the PR Screenshots with videos performing the steps?

Sure, give me a moment.

@LucioChavezFuentes
Copy link
Contributor Author

@Santhosh-Sellavel PR updated with videos. You can review them now.

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Apr 30, 2022

PR Reviewer Checklist

  • 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 verified tests pass on all platforms & I tested again 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 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 tagging the marketing team 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 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 */
    • Any functional components have the displayName property
    • 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.

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

Looks good, tests well!

@luacmartins,

The props onBlur, onClose, onFocus are not defined basePickerPropTypes.
Are we okay with this?

@LucioChavezFuentes
Copy link
Contributor Author

PR updated and ready to reviewed, but I'm having a Lint problem, looks like someone is working on an urgent problem.

@LucioChavezFuentes
Copy link
Contributor Author

PR updated and ready to be reviewed. No more lint problems.

luacmartins
luacmartins previously approved these changes May 11, 2022
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM and tests well! Thanks for the fix! All yours @Santhosh-Sellavel and @stitesExpensify!

Copy link
Contributor

@stitesExpensify stitesExpensify left a comment

Choose a reason for hiding this comment

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

Looks good! Just one question

src/components/Picker/BasePicker/index.js Outdated Show resolved Hide resolved
@Santhosh-Sellavel
Copy link
Collaborator

Will review this today.

@Santhosh-Sellavel
Copy link
Collaborator

@luacmartins Are the new copies verified by the marketing team?

@luacmartins
Copy link
Contributor

Are the new copies verified by the marketing team?

I don't believe so. However, I think this should be ok given that they are in line with our other messages. @stitesExpensify what do you think?

@stitesExpensify
Copy link
Contributor

If it was copied from previously approved copy then I think it's fine

@parasharrajat
Copy link
Member

Any update on this PR? This PR also resolves #9015

Copy link
Contributor

@stitesExpensify stitesExpensify left a comment

Choose a reason for hiding this comment

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

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM and tests well! Thanks for the fix!

@luacmartins
Copy link
Contributor

Seems like all concerns have been addressed. Merging...

@luacmartins luacmartins merged commit 82b97bf into Expensify:main May 16, 2022
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by @luacmartins in version: 1.1.61-2 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by @AndrewGable in version: 1.1.61-3 🚀

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

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.

7 participants