Refactor the error text style + add new hint prop to MenuItem component #41670

narefyev91 · 2024-05-06T13:07:06Z

Details

Refactor the error text style and add hint text inside menu item

Fixed Issues

$ #40697
PROPOSAL:

Tests

Open any workspace profile as admin - hover over currency menu item
Verify that hint will be inside hover area
Open User profile
Go to address
Change country to USA
Click save - verify that error is shown under the main row

Verify that no errors appear in the JS console

Offline tests

Open any workspace profile as admin - hover over currency menu item
Verify that hint will be inside hover area
Open User profile
Go to address
Change country to USA
Click save - verify that error is shown under the main row

QA Steps

Open any workspace profile as admin - hover over currency menu item
Verify that hint will be inside hover area
Open User profile
Go to address
Change country to USA
Click save - verify that error is shown under the main row

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

android-web.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-05-06T13:07:12Z

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

narefyev91 · 2024-05-06T13:11:33Z

@shawnborton I prepared a first look based on this #40697 discussions. Will be really helpful - if you can check - in which places we need to put hints inside the menu items - probably most of them are coming from QBO project. Reference from design works as well. Thanks!

shawnborton · 2024-05-06T13:52:30Z

I think the rows found on expense views need to be fixed too, like this one for instance:

Should look more like this one:

Also, we have a similar project ongoing with Xero right now, so we should make sure those get updated too, cc @lakchote

shawnborton · 2024-05-06T13:53:33Z

src/styles/index.ts

            marginBottom: 4,
        },

        formError: {
            color: theme.textError,
            fontSize: variables.fontSizeLabel,
-            lineHeight: variables.formErrorLineHeight,
+            lineHeight: variables.lineHeightNormal,


What is the value of this out of curiosity?

@shawnborton
formErrorLineHeight - getValueUsingPixelRatio(18, 23),
lineHeightNormal: getValueUsingPixelRatio(16, 21),

what does getValuesUsingPixelRatio does:

Calculate the fontSize, lineHeight and padding when the device font size is changed, In most cases users do not change their device font size so PixelRatio.getFontScale() = 1 and this method always returns the defaultValue (first param). When the device font size increases/decreases, the PixelRatio.getFontScale() value increases/decreases as well. This means that if you have text and its 'fontSize' is 19, the device font size changed to the 5th level on the iOS slider and the actual fontSize is 19 * PixelRatio.getFontScale() = 19 * 1.11 = 21.09. Since we are disallowing font scaling we need to calculate it manually. We calculate it with: PixelRatio.getFontScale() * defaultValue > maxValue ? maxValue : defaultValue * PixelRatio.getFontScale() This means that the fontSize is increased/decreased when the device font size changes up to maxValue (second param)

Got it. I mostly just think the naming convention feels strange, but that's a separate conversation I suppose.

For example, our "normal" font size is 15px, and it should have a line height of 20px. But it's strange that we call the 20px line height lineHeightLarge

Our "label" font size is 13px, and it should have a line height of 16px. But it's strange that we call the 16px line height lineHeightNormal

yeah lol - some namings looks strange:

Oof, that hurts to look at. Anyways, nothing we need to worry about here, as long as we are using the right one for now.

narefyev91 · 2024-05-07T13:18:41Z

@shawnborton updated expenses flow:

@getusha can you please start checking PR. Thanks!

shawnborton · 2024-05-07T13:20:33Z

updated expenses flow:

Nice, and just to confirm, that's for all of the rows on that screen and not just merchant, right?

narefyev91 · 2024-05-07T13:38:08Z

updated expenses flow:

Nice, and just to confirm, that's for all of the rows on that screen and not just merchant, right?

yeah - it's using the same component

shawnborton · 2024-05-07T13:39:07Z

Awesome, thank you for confirming

getusha · 2024-05-07T15:24:08Z

@s77rt will start reviewing this, since he has a context from the related PR.

s77rt · 2024-05-07T17:08:56Z

The arrow position changes on error, is that expected?

s77rt · 2024-05-07T17:11:40Z

src/components/MenuItem.tsx

Do we still need both error and errorText? This is redundant, can we remove one of these props?

yeah i will remove error props - it's not in correct position for menu item

shawnborton · 2024-05-07T18:18:21Z

The arrow position changes on error, is that expected?

That doesn't feel correct to me. I would think everything maintains it's same alignment, but the row becomes taller because now the error message is attached to the bottom.

narefyev91 · 2024-05-08T09:58:50Z

The arrow position changes on error, is that expected?

That doesn't feel correct to me. I would think everything maintains it's same alignment, but the row becomes taller because now the error message is attached to the bottom.

Yeah! Good point!
Probably i need your help here @shawnborton
This is how generic menu item looks like (you can see - that both left and right items has min heigh: 40px:

When we have an error shown - we remove that min-height: 40px - because the menu item row - will be extremely big:

That's why i remove that min-height to just allow menu item occupy needed space:

Probably potential fix here can be - I can add padding top = 10px for chevron and red dot container (calculation min-height 40 px, each icon 20 px: 40 - 20 / 2 = 10px above and below.)
Such change will move icon container just on the same place as before - but will push error text a little bit lower:

Just let me know if that works - and i will apply this change!

# Conflicts: # src/components/MenuItem.tsx

shawnborton · 2024-05-08T12:48:36Z

When we have an error shown - we remove that min-height: 40px - because the menu item row - will be extremely big:

So we actually do want the previous size, the adjustments you made are not correct.

This is what it would ideally look like:

cc @Expensify/design for confirmation

narefyev91 · 2024-05-08T12:49:38Z

When we have an error shown - we remove that min-height: 40px - because the menu item row - will be extremely big:

So we actually do want the previous size, the adjustments you made are not correct.

This is what it would ideally look like:

cc @Expensify/design for confirmation

Does it mean that min height of 40px should stay?

shawnborton · 2024-05-08T12:50:07Z

Correct, it should remain.

narefyev91 · 2024-05-08T12:53:10Z

Correct, it should remain.

Cool! that's how it will be look like @shawnborton :

shawnborton · 2024-05-08T12:57:37Z

This is what we have in Figma:

So the error message part is 16px tall, and it has a 4px margin above it. Then the push row is a min-height of 40px.

shawnborton · 2024-05-08T13:14:36Z

Perfect, thanks for confirming!

s77rt · 2024-05-08T22:23:24Z

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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

src/components/AmountPicker/index.tsx

src/components/MenuItem.tsx

hayata-suenaga · 2024-05-09T22:07:18Z

Do you know if we have a StoryBook component setup for MenuItem?

hayata-suenaga · 2024-05-09T22:18:54Z

@narefyev91, could you add more details on these steps? I didn't see any error when I change the country to USA

narefyev91 · 2024-05-10T06:35:29Z

3. Open User profile

@hayata-suenaga hey! In the point 3 of QA steps - it says that you need to go to User profile - but not to profile of workspace.
Like here:

Screen.Recording.2024-05-10.at.09.33.14.mov

narefyev91 · 2024-05-10T06:37:23Z

Do you know if we have a StoryBook component setup for MenuItem?

Yeah we already have it. src/stories/MenuItem.stories.tsx

hayata-suenaga · 2024-05-10T21:52:17Z

ah we just want to confirm the This field is required error?

s77rt · 2024-05-11T11:38:30Z

@hayata-suenaga Yes but for the MenuItems not the inputs, i.e. for the country field and state field if country is US (see screenshots in #41670 (comment))

hayata-suenaga · 2024-05-13T22:27:41Z

okay now I see it 👍

hayata-suenaga

🟢

OSBotify · 2024-05-13T22:35:47Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

ishpaul777 · 2024-05-14T20:52:18Z

src/components/MenuItem.tsx

-                                                    isHovered && !pressed && interactive ? StyleUtils.getBackgroundAndBorderStyle(theme.border) : undefined,
-                                                ]}
-                                            />
+                            <View style={[styles.flexColumn, styles.flex1]}>


this caused a regression #42171, there's a extra view wrapping the content, @narefyev91 was this intentional ?

Raised a fix here #42178

OSBotify · 2024-05-15T10:14:02Z

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

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

Beamanator · 2024-05-16T09:39:23Z

src/styles/index.ts

        menuItemError: {
-            position: 'absolute',
-            bottom: -4,
-            left: 20,
-            right: 20,
+            marginTop: 4,
+            marginBottom: 0,
        },


Looks like this may have caused this error: #42209

OSBotify · 2024-05-22T23:59:03Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.74-6 🚀

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

narefyev91 added 4 commits April 30, 2024 13:26

Menu item changes

7fd48ee

updates for styles

f8f536c

Merge branch 'refs/heads/main' into menu-item-changes

232163f

Refactoring all places to use errorText instead of error for menu items

bd6595f

narefyev91 requested review from a team as code owners May 6, 2024 13:07

melvin-bot bot requested review from getusha and removed request for a team May 6, 2024 13:07

shawnborton reviewed May 6, 2024

View reviewed changes

update after design review

fc6455c

s77rt reviewed May 7, 2024

View reviewed changes

narefyev91 added 3 commits May 8, 2024 13:00

remove redundant error prop

c96c61a

Merge branch 'refs/heads/main' into menu-item-changes

505a1a6

# Conflicts: # src/components/MenuItem.tsx

updates after merge conflicts

22556b5

narefyev91 requested a review from s77rt May 8, 2024 13:15

s77rt suggested changes May 8, 2024

View reviewed changes

src/components/AmountPicker/index.tsx Outdated Show resolved Hide resolved

src/components/MenuItem.tsx Outdated Show resolved Hide resolved

src/components/MenuItem.tsx Outdated Show resolved Hide resolved

narefyev91 added 2 commits May 9, 2024 10:41

Merge branch 'refs/heads/main' into menu-item-changes

3abce2c

updates after c+ review

730f272

narefyev91 requested a review from s77rt May 9, 2024 07:58

s77rt approved these changes May 9, 2024

View reviewed changes

melvin-bot bot requested a review from hayata-suenaga May 9, 2024 13:41

shawnborton mentioned this pull request May 9, 2024

Display error messages for Xero Import page #41917

Merged

48 tasks

s77rt mentioned this pull request May 9, 2024

Implement offline behavior and error handling for UpdateGroupChatName #41826

Merged

50 tasks

hayata-suenaga approved these changes May 13, 2024

View reviewed changes

hayata-suenaga merged commit f9abf1e into Expensify:main May 13, 2024
16 checks passed

ishpaul777 reviewed May 14, 2024

View reviewed changes

ishpaul777 mentioned this pull request May 14, 2024

[DEV] FAB menu items broken #42171

Closed

6 tasks

s77rt mentioned this pull request May 14, 2024

Fix MenuItem flex style #42178

Merged

50 tasks

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

Deploy Checklist: New Expensify 2024-05-15 #42185

Closed

neonbhai mentioned this pull request May 16, 2024

Web - Chat - Scan - Extra padding above the error "Enter an amount" #42209

Closed

6 tasks

Beamanator reviewed May 16, 2024

View reviewed changes

hayata-suenaga mentioned this pull request May 29, 2024

[$250] [Wave Collect][QBO] Refactor the error text style #40697

Closed

Refactor the error text style + add new hint prop to MenuItem component #41670

Refactor the error text style + add new hint prop to MenuItem component #41670

Conversation

narefyev91 commented May 6, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 6, 2024

narefyev91 commented May 6, 2024

shawnborton commented May 6, 2024

Choose a reason for hiding this comment

narefyev91 May 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

narefyev91 commented May 7, 2024

shawnborton commented May 7, 2024

narefyev91 commented May 7, 2024

shawnborton commented May 7, 2024

getusha commented May 7, 2024

s77rt commented May 7, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shawnborton commented May 7, 2024

narefyev91 commented May 8, 2024

shawnborton commented May 8, 2024

narefyev91 commented May 8, 2024

shawnborton commented May 8, 2024

narefyev91 commented May 8, 2024 • edited Loading

shawnborton commented May 8, 2024

shawnborton commented May 8, 2024

s77rt commented May 8, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

hayata-suenaga commented May 9, 2024

hayata-suenaga commented May 9, 2024

narefyev91 commented May 10, 2024

narefyev91 commented May 10, 2024

hayata-suenaga commented May 10, 2024

s77rt commented May 11, 2024

hayata-suenaga commented May 13, 2024

hayata-suenaga left a comment

Choose a reason for hiding this comment

OSBotify commented May 13, 2024

ishpaul777 May 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented May 15, 2024

Choose a reason for hiding this comment

OSBotify commented May 22, 2024

narefyev91 commented May 6, 2024 •

edited

Loading

narefyev91 May 6, 2024 •

edited

Loading

narefyev91 commented May 8, 2024 •

edited

Loading

s77rt commented May 8, 2024 •

edited

Loading

ishpaul777 May 14, 2024 •

edited

Loading