Improve UX of modifying single line text inputs #40757

nkdengineer · 2024-04-23T07:59:24Z

Details

Improve UX of modifying single line text inputs

Fixed Issues

$ #40313
PROPOSAL: #40313 (comment)

Tests

Create a group
Go to group settings
Click the name of group
Verify that: Clear button is displayed in the right
Click this button and verify that it works well

Verify that no errors appear in the JS console

Offline tests

QA Steps

Create a group
Go to group settings
Click the name of group
Verify that: Clear button is displayed in the right
Click this button and verify that it works well

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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.

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

android-mweb.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-mweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-04-23T07:59:28Z

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

melvin-bot · 2024-04-23T08:03:32Z

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

shawnborton · 2024-04-24T12:18:41Z

Let us know when you have updated screenshots and when this is ready for review.

shawnborton · 2024-04-24T12:19:01Z

I'll run a test build now though!

github-actions · 2024-04-24T12:51:11Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/40757/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/40757/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/40757/NewExpensify.dmg	https://40757.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

dannymcclain · 2024-04-24T13:23:37Z

It's looking good to me! Just for my own knowledge, is this a feature/prop that can be enabled on any text input?

eh2077 · 2024-04-25T02:36:41Z

It's looking good to me! Just for my own knowledge, is this a feature/prop that can be enabled on any text input?

@dannymcclain Yes, it's a complement to our basic text input component. While it's hidden by default, we can use the flag to enable it if needed.

nkdengineer · 2024-04-25T07:58:44Z

@shawnborton i updated code, and here is result

icon size = 18	icon size = 20

shawnborton · 2024-04-25T11:56:44Z

Cool, my vote would be 20px since that's a standard icon size for us, but let's see what Danny thinks.

shawnborton · 2024-04-25T11:56:58Z

Or 16 could work too.

dannymcclain · 2024-04-25T13:23:06Z

Cool, my vote would be 20px since that's a standard icon size for us, but let's see what Danny thinks.

I think we should just stick with 20px. I don't see any great reasons to change the icon size here.

src/components/TextInput/BaseTextInput/index.native.tsx

src/components/TextInput/BaseTextInput/types.ts

eh2077 · 2024-04-25T15:32:29Z

src/components/TextInput/BaseTextInput/types.ts

+    shouldShowClearButton?: boolean;
+
+    /** Callback to handle clear the value on Form when input is used in the Form component. */
+    onClearInput?: (value: string | undefined) => void;


I can't imagine a good reason to add this callback now. I'm not sure if it's better to have it when we have a real use case.

I removed onClearInput

Co-authored-by: Eric Han <[email protected]>

eh2077 · 2024-04-26T14:20:04Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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

Android: Native

android.mov

Android: mWeb Chrome

mobile-chrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

mobile-safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

eh2077

LGTM

src/components/TextInput/BaseTextInput/index.tsx

marcaaron · 2024-04-26T20:11:25Z

src/languages/es.ts

@@ -315,6 +315,7 @@ export default {
            subtitleText3: '.',
        },
        businessName: 'Nombre de la empresa',
+        clear: 'Clara',


Did we get this copy approved ?

@marcaaron not yet, how can i get it correctly.

Ask for the copy in Slack in #expensify-open-source like this.

@marcaaron I updated according to approval here

marcaaron · 2024-04-29T19:26:22Z

src/components/TextInput/TextInputClearButton/index.tsx

+
+TextInputClearButton.displayName = 'TextInputClearButton';
+
+export default forwardRef(TextInputClearButton);


Awesome thanks! ❤️

OSBotify · 2024-05-09T02:10:16Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.71-6 🚀

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

Improve UX of modifying single line text inputs

f4d7bd2

nkdengineer marked this pull request as ready for review April 23, 2024 08:03

nkdengineer requested a review from a team as a code owner April 23, 2024 08:03

melvin-bot bot requested review from eh2077 and removed request for a team April 23, 2024 08:03

nkdengineer added 3 commits April 24, 2024 10:21

resolve conflict

25af916

add clear icon

ef96598

add cicler svg

d141a51

nkdengineer requested a review from a team as a code owner April 24, 2024 04:23

shawnborton added the Ready To Build label Apr 24, 2024

fix icon size

12e7820

eh2077 reviewed Apr 25, 2024

View reviewed changes

nkdengineer and others added 4 commits April 26, 2024 10:41

Update src/components/TextInput/BaseTextInput/types.ts

d9b34bf

Co-authored-by: Eric Han <[email protected]>

add translation

82e1c2d

fix conflict

84fa2ce

fix remove onClearInput

3b098fe

eh2077 approved these changes Apr 26, 2024

View reviewed changes

melvin-bot bot requested a review from marcaaron April 26, 2024 14:28

marcaaron requested changes Apr 26, 2024

View reviewed changes

marcaaron assigned nkdengineer Apr 26, 2024

fix: add TextInputClearButton component

5ceb448

marcaaron reviewed Apr 29, 2024

View reviewed changes

Merge branch 'main' into fix/40313

30c3847

marcaaron self-requested a review May 3, 2024 01:15

marcaaron approved these changes May 3, 2024

View reviewed changes

marcaaron merged commit aa8aace into Expensify:main May 3, 2024
16 checks passed

github-actions bot mentioned this pull request May 7, 2024

Deploy Checklist: New Expensify 2024-05-07 #41716

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve UX of modifying single line text inputs #40757

Improve UX of modifying single line text inputs #40757

nkdengineer commented Apr 23, 2024

melvin-bot bot commented Apr 23, 2024

melvin-bot bot commented Apr 23, 2024

shawnborton commented Apr 24, 2024

shawnborton commented Apr 24, 2024

github-actions bot commented Apr 24, 2024

dannymcclain commented Apr 24, 2024

eh2077 commented Apr 25, 2024

nkdengineer commented Apr 25, 2024

shawnborton commented Apr 25, 2024

shawnborton commented Apr 25, 2024

dannymcclain commented Apr 25, 2024

eh2077 Apr 25, 2024

nkdengineer Apr 26, 2024

eh2077 commented Apr 26, 2024 •

edited

Loading

eh2077 left a comment

marcaaron Apr 26, 2024

nkdengineer Apr 29, 2024

marcaaron Apr 29, 2024

nkdengineer May 2, 2024

marcaaron Apr 29, 2024

OSBotify commented May 9, 2024


		TextInputClearButton.displayName = 'TextInputClearButton';

		export default forwardRef(TextInputClearButton);

Improve UX of modifying single line text inputs #40757

Improve UX of modifying single line text inputs #40757

Conversation

nkdengineer commented Apr 23, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 23, 2024

melvin-bot bot commented Apr 23, 2024

shawnborton commented Apr 24, 2024

shawnborton commented Apr 24, 2024

github-actions bot commented Apr 24, 2024

dannymcclain commented Apr 24, 2024

eh2077 commented Apr 25, 2024

nkdengineer commented Apr 25, 2024

shawnborton commented Apr 25, 2024

shawnborton commented Apr 25, 2024

dannymcclain commented Apr 25, 2024

eh2077 Apr 25, 2024

Choose a reason for hiding this comment

nkdengineer Apr 26, 2024

Choose a reason for hiding this comment

eh2077 commented Apr 26, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

eh2077 left a comment

Choose a reason for hiding this comment

marcaaron Apr 26, 2024

Choose a reason for hiding this comment

nkdengineer Apr 29, 2024

Choose a reason for hiding this comment

marcaaron Apr 29, 2024

Choose a reason for hiding this comment

nkdengineer May 2, 2024

Choose a reason for hiding this comment

marcaaron Apr 29, 2024

Choose a reason for hiding this comment

OSBotify commented May 9, 2024

eh2077 commented Apr 26, 2024 •

edited

Loading