fix: change field style colors when input is not editable

[himanshuragi456]

Details

A separate(dull/disabled-looking) style will be provided to fields that are not editable, to provide clear understanding to the user that the field is disabled.

Fixed Issues

$ #25577
PROPOSAL: #25577 (comment)

Tests

1. Go to Settings > Workspaces
2. Select a workspace and access "Connect Bank Account."
3. Click Connect Manually
4. Enter Valid Routing Number & Account Number and click continue
5. Fill all required Details and click continue
6. Return to the Connect bank account(Step 1).
7. Observe disabled/dull colors of fields that are not editable.

• Verify that no errors appear in the JS console

Offline tests

same as online steps

QA Steps

• 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
  • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  • 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
• 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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[melvin-bot]

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

[melvin-bot]

@Santhosh-Sellavel 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]

[github-actions]

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

[github-actions]

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.

---

I have read the CLA Document and I hereby sign the CLA

---

_{You can retrigger this bot by commenting recheck in this Pull Request}

[himanshuragi456]

I have read the CLA Document and I hereby sign the CLA

[himanshuragi456]

@shawnborton have a look at the attached videos in the PR, ALL DISABLED INPUTS will have no border and will have cursor: disabled. Looks good to me, what are your views? (especially in step 2 where some fields are disabled and others are not. there must other forms in the app too, where we have a mix of enabled and disabled fields.)
cc: @hayata-suenaga @Santhosh-Sellavel

[shawnborton]

Hmm I don't know that we should use the disabled cursor there. They aren't technically disabled inputs, they are just read-only text. So I think I would opt to do nothing here.

[himanshuragi456]

@shawnborton okay! removing the disabled cursor.

[himanshuragi456]

@Santhosh-Sellavel please review now

[himanshuragi456]

@shawnborton removed cursor: disabled, have a look at the updated videos!

[shawnborton]

Looks good, thanks!

[hayata-suenaga]

if you have time, could provide screenshots that shows the difference when we have this line and not?

[himanshuragi456]

Before:

After:

[shawnborton]

Rather than messing with the text input component, is there a way to reuse the global styles we're using for this elsewhere, like the profile page?

[himanshuragi456]

@shawnborton This needs to be implemented in the text input component only. because we not only want this to happen in bank details, we want to provide this UX to all the disabled inputs globally.

[hayata-suenaga]

@himanshuragi456 I'd like to ask a clarifying question here 🙇

What issue are we trying to solve now?

No sign is shown to indicating the account number and routing number can't be changed on Connect bank account

This was the original issue. Now because we don't have to use disabled cursors now, what are we tying to do in this PR?

[himanshuragi456]

@hayata-suenaga Yes, we don't have to use a disabled cursor now, but the basic idea still remains that we need to help the user identify that the particular field is not editable. I'll edit the Title.
cc: @Santhosh-Sellavel

[himanshuragi456]

Done! do we need any other changes? please review @Santhosh-Sellavel @hayata-suenaga @shawnborton

[shawnborton]

Good on my end. Thanks!

[Santhosh-Sellavel]

@himanshuragi456 What to test & verify here. Can you update the test steps here thanks!

[Santhosh-Sellavel]

@shawnborton This would affect the date picker are we fine with this?

Left side New & Right Side old

[himanshuragi456]

@Santhosh-Sellavel just need to observe that the fields that are not editable, don't have a border bottom anymore. I've updated the same in the test steps.

[Santhosh-Sellavel]

@himanshuragi456 What are the pages that do have uneditable fields, please list them down. So it will be helpful for QA to test them.

[shawnborton]

We should not be touching the datepicker dropdown. That's why I suggested to not use a disabled input for this, we should just make it read-only text instead.

…

On Tue, Aug 29, 2023 at 3:29 PM Santhosh Sellavel ***@***.***> wrote: @himanshuragi456 <https://github.com/himanshuragi456> What are the pages that do have uneditable fields, please list them down. So it will be helpful for QA to test them. — Reply to this email directly, view it on GitHub <#25991 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AARWH5XQW5ABKXPSQSZ3NWTXXY7H5ANCNFSM6AAAAAA37THCBA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[himanshuragi456]

@Santhosh-Sellavel it is the base text input we are dealing with, so that will affect a lot of forms, difficult to list all of them. For testing, bank account form step 1 and step 2 are good enough for testing here.

[Santhosh-Sellavel]

@shawnborton

We should not be touching the datepicker dropdown. That's why I suggested to not use a disabled input for this, we should just make it read-only text instead.

I think it makes sense to make it read-only text. Only on the page where it's meant to be read-only Ex: Profile page. There are flows where it will be both editable & disabled. There we just continue using TextInput and just disable it whenever required. If we try to make it a read-only pattern while temporarily disabled that would be over-engineering.

In this case, we just add a disabled cursor style or just do nothing!

cc: @hayata-suenaga

[shawnborton]

Hmm I am not following your suggestion, mind rephrasing?

[Santhosh-Sellavel]

@himanshuragi456While performing tests on native apps this console Warnings occurs please resolve this.

[himanshuragi456]

@Santhosh-Sellavel @shawnborton @hayata-suenaga This issue has already taken a lot of effort and will still take more effort to resolve the console warning. I request to remove the penalty that will be applied due to the late merging of this PR and increase the bounty for this issue.

[Santhosh-Sellavel]

@himanshuragi456

Penalties are waived when a delay happens because of something beyond our control. Here we had one such case, i.e. we just deviated from the expected outcome here on the PR.

It will still take more effort to resolve the console warning.

IMO this is something which within our control, this could have been caught just running through the checklist conciously.
The console error occurs due to the changes made recently to fix this issue. It's straightforward not a complex issue and does not take more time either.

WebkitTextFillColor style is not available on native platforms, so we should apply this style to Safari Web. We have examples already in the repo.

Please try to complete the requested changes soon, thanks!

cc: @hayata-suenaga

[hayata-suenaga]

@himanshuragi456 I answered your payment question on the GH issue.

[himanshuragi456]

@Santhosh-Sellavel solved the console error and added comments. please review.

[Santhosh-Sellavel]

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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
• 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-09-08.at.11.51.23.PM.mov

Mobile Web - Chrome

Mobile Web - Safari

iOS

Android

[Santhosh-Sellavel]

@hayata-suenaga Please verify workflow checks are good, otherwise LGTM, tests well!
Also, I think this could wait for Merge Freeze, I let you make the final call though thanks!

cc: @shawnborton Please verify screenshots!

[shawnborton]

Screenshots generally look good but I noticed that web has a bottom-border on the inputs but iOS does not. Why is there an inconsistency there?

[hayata-suenaga]

@himanshuragi456 could you check this ⬆️

[himanshuragi456]

Just checked, and the border-bottom did not have a width, that's why it was invisible.
Here's the updated Screenshot:

[shawnborton]

Everything is good on my end.

[himanshuragi456]

@hayata-suenaga I think we can move forward now. Let me know if there are any further changes required!

[himanshuragi456]

@hayata-suenaga gently bump here

[hayata-suenaga]

sorryyy I missed this one thank you for letting me know 😄

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.69-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.69-2 🚀

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

[OSBotify]

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.70-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.70-8 🚀

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