Default badge style #40101

dragnoir · 2024-04-11T11:11:33Z

Details

This PR will remove additional styling to badge component, make the square style as default, add error and success props.

Changes for the badge component:

always uses the "bordered" style as a default
has a prop for error/danger that turns the border red
has a prop for success that turns the border green

Fixed Issues

$ #38471
PROPOSAL: #38471 (comment)

Tests

Click on profile
Check the badge on the right of Wallet menu item

Verify that no errors appear in the JS console

Offline tests

QA Steps

Click on profile
Check the badge on the right of Wallet menu item

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

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

dragnoir · 2024-04-11T11:12:57Z

Screenshots from the UI where all styles props are removed:

dragnoir · 2024-04-11T16:02:16Z

Error:

Success:

shawnborton · 2024-04-11T16:39:24Z

Looking good! When the badge has an icon and is state=error, we want the icon to use the danger red color as the icon fill. And when the badge has an icon and is state=success, we want the icon to use the success green color as the icon fill.

dragnoir · 2024-04-11T16:42:18Z

Badge default light:

Badge default dark:

Badge success light:

Badge sucess dark:

Badge error light:

Badge error dark:

shawnborton · 2024-04-11T17:17:23Z

Nice, can you do that same line up but show them with icons too?

dragnoir · 2024-04-11T17:21:01Z

Badge with icon default light:

Badge with icon default dark:

Badge with icon success light:

Badge with icon sucess dark:

Badge with icon error light:

Badge with icon error dark:

melvin-bot · 2024-04-11T17:27:51Z

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

dragnoir · 2024-04-11T17:28:08Z

@shawnborton if you want to assign a reviewer!

shawnborton · 2024-04-11T17:43:17Z

I'll give it a review, going to run a test build now. cc @Expensify/design as well.

shawnborton · 2024-04-11T18:18:11Z

Looks like this broke the environment labels we use:

I think we could keep those environment labels as separate one-off styles since they are only used near the wordmark logo, to my knowledge at least.

arosiclair · 2024-04-11T19:26:32Z

@Santhosh-Sellavel you're the reviewer for the other PR. Can you also review this one?

github-actions · 2024-04-12T08:38:20Z

🧪🧪 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/40101/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/40101/index.html

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

👀 View the workflow run that generated this build 👀

shawnborton · 2024-04-12T08:51:12Z

Badge shape looks better, but colors are incorrect - adhoc uses a darker shade of pink:

dragnoir · 2024-04-12T09:53:14Z

fixed:

shawnborton · 2024-04-12T12:35:45Z

Looks good, let's get this one into final review? cc @arosiclair @Santhosh-Sellavel

Santhosh-Sellavel · 2024-04-15T18:40:00Z

Resolve Conflicts please

dragnoir · 2024-04-16T14:38:02Z

@shawnborton just for info.

The badge component supports a pressable prop, that makes it clickable and then support hover effect.

App/src/components/Badge.tsx

Line 52 in c75c85f

pressable = false,

when the component seeks for the style here

App/src/styles/utils/index.ts

Lines 1246 to 1263 in c75c85f

    
           getBadgeColorStyle: (isSuccess: boolean, isError: boolean, isPressed = false, isAdHoc = false): ViewStyle => { 
        
               if (isSuccess) { 
        
                   if (isAdHoc) { 
        
                       // TODO: Remove this "eslint-disable-next" once the theme switching migration is done and styles are fully typed (GH Issue: https://github.com/Expensify/App/issues/27337) 
        
                       // eslint-disable-next-line @typescript-eslint/no-unsafe-return 
        
                       return isPressed ? styles.badgeAdHocSuccessPressed : styles.badgeAdHocSuccess; 
        
                   } 
        
                   // TODO: Remove this "eslint-disable-next" once the theme switching migration is done and styles are fully typed (GH Issue: https://github.com/Expensify/App/issues/27337) 
        
                   // eslint-disable-next-line @typescript-eslint/no-unsafe-return 
        
                   return isPressed ? styles.badgeSuccessPressed : styles.badgeSuccess; 
        
               } 
        
               if (isError) { 
        
                   // TODO: Remove this "eslint-disable-next" once the theme switching migration is done and styles are fully typed (GH Issue: https://github.com/Expensify/App/issues/27337) 
        
                   // eslint-disable-next-line @typescript-eslint/no-unsafe-return 
        
                   return isPressed ? styles.badgeDangerPressed : styles.badgeDanger; 
        
               } 
        
               return {}; 
        
           },

it will check if it's isPressed to load another style.
You can see it when you keep clicking in the small badge under the logo

20240416_153341.mp4

The new design will need a style for the isPressed, However, we currently don't have any cases where we're using the isPressed state in our styles.

Just wanted to give you a heads up about this. Let me know if you have any questions or need this to be considered now.

shawnborton · 2024-04-17T10:10:38Z

Sounds good, I don't think any badges need to be able to be pressable at the moment though but we can just leave this as-is.

What else do we need to do to get this one over the finish line? Would love to wrap this up so we can also get the report next steps banner PR merged as well. Thanks Rachid!

dragnoir · 2024-04-17T11:03:13Z

Thank you @shawnborton solving conflicts now.

dragnoir · 2024-04-18T12:58:56Z

@Santhosh-Sellavel conflicts solved. Please review.

dragnoir · 2024-04-19T08:08:36Z

@Santhosh-Sellavel friendly pumb!

Santhosh-Sellavel · 2024-04-19T18:55:39Z

Thanks will try to get this today or by this weekend.

Santhosh-Sellavel · 2024-04-21T18:59:45Z

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

Screen.Recording.2024-04-22.at.12.26.26.AM.mov

Santhosh-Sellavel

LGTM, Thanks!

melvin-bot · 2024-04-21T20:04:51Z

🎯 @Santhosh-Sellavel, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #40663.

dragnoir · 2024-04-21T21:34:31Z

@shawnborton do you think I can get paid too here? 😅

shawnborton · 2024-04-22T12:26:36Z

@dragnoir yup, requested that here

shawnborton · 2024-04-22T12:30:21Z

Can we try to get this one merged soon? This way we can unblock the PR here. Thanks!

dragnoir · 2024-04-22T16:24:41Z

@arosiclair I think we need your review here!

OSBotify · 2024-04-23T17:20:50Z

✋ 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 · 2024-04-24T00:07:08Z

🚀 Deployed to staging by https://github.com/arosiclair in version: 1.4.65-0 🚀

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

OSBotify · 2024-04-25T13:45:27Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.65-5 🚀

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

dragnoir added 2 commits April 9, 2024 23:46

Fix: default style

8b76bd7

clean additional style

57b6c66

add error and success style

6a58d37

fix lint

642e5cd

add icon style

da19ac7

dragnoir marked this pull request as ready for review April 11, 2024 17:27

dragnoir requested review from a team as code owners April 11, 2024 17:27

Merge branch 'Expensify:main' into 38471-badge

19934c7

melvin-bot bot requested review from arosiclair and removed request for a team April 11, 2024 17:27

shawnborton self-requested a review April 11, 2024 17:42

shawnborton added the Ready To Build label Apr 11, 2024

This comment has been minimized.

Sign in to view

dragnoir added 3 commits April 11, 2024 23:17

fix: enviroment badge

007afde

update text style for env badge

3296c5d

fix one pixel + on env

b984493

fix adhoc bg color

b3b7b59

arosiclair requested a review from Santhosh-Sellavel April 12, 2024 13:42

dragnoir added 3 commits April 18, 2024 13:40

Merge remote-tracking branch 'upstream/main' into 38471-badge

6271340

clean badges after conflicts

7a6112b

fix ts

3323b34

Santhosh-Sellavel approved these changes Apr 21, 2024

View reviewed changes

melvin-bot bot mentioned this pull request Apr 21, 2024

Payment issue for E/App PR#40101 #40663

Closed

arosiclair approved these changes Apr 23, 2024

View reviewed changes

arosiclair merged commit 3a3cef6 into Expensify:main Apr 23, 2024
16 checks passed

github-actions bot mentioned this pull request Apr 23, 2024

Deploy Checklist: New Expensify 2024-04-23 #40843

Closed

74 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Default badge style #40101

Default badge style #40101

dragnoir commented Apr 11, 2024 •

edited

Loading

dragnoir commented Apr 11, 2024

dragnoir commented Apr 11, 2024

shawnborton commented Apr 11, 2024

dragnoir commented Apr 11, 2024

shawnborton commented Apr 11, 2024

dragnoir commented Apr 11, 2024

melvin-bot bot commented Apr 11, 2024

dragnoir commented Apr 11, 2024

shawnborton commented Apr 11, 2024

This comment has been minimized.

shawnborton commented Apr 11, 2024

arosiclair commented Apr 11, 2024

github-actions bot commented Apr 12, 2024

shawnborton commented Apr 12, 2024

dragnoir commented Apr 12, 2024

shawnborton commented Apr 12, 2024

Santhosh-Sellavel commented Apr 15, 2024

dragnoir commented Apr 16, 2024

shawnborton commented Apr 17, 2024

dragnoir commented Apr 17, 2024

dragnoir commented Apr 18, 2024

dragnoir commented Apr 19, 2024

Santhosh-Sellavel commented Apr 19, 2024 •

edited

Loading

Santhosh-Sellavel commented Apr 21, 2024 •

edited

Loading

Santhosh-Sellavel left a comment

melvin-bot bot commented Apr 21, 2024

dragnoir commented Apr 21, 2024

shawnborton commented Apr 22, 2024

shawnborton commented Apr 22, 2024

dragnoir commented Apr 22, 2024

OSBotify commented Apr 23, 2024

OSBotify commented Apr 24, 2024

OSBotify commented Apr 25, 2024

Default badge style #40101

Default badge style #40101

Conversation

dragnoir commented Apr 11, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

dragnoir commented Apr 11, 2024

dragnoir commented Apr 11, 2024

shawnborton commented Apr 11, 2024

dragnoir commented Apr 11, 2024

shawnborton commented Apr 11, 2024

dragnoir commented Apr 11, 2024

melvin-bot bot commented Apr 11, 2024

dragnoir commented Apr 11, 2024

shawnborton commented Apr 11, 2024

This comment has been minimized.

shawnborton commented Apr 11, 2024

arosiclair commented Apr 11, 2024

github-actions bot commented Apr 12, 2024

shawnborton commented Apr 12, 2024

dragnoir commented Apr 12, 2024

shawnborton commented Apr 12, 2024

Santhosh-Sellavel commented Apr 15, 2024

dragnoir commented Apr 16, 2024

shawnborton commented Apr 17, 2024

dragnoir commented Apr 17, 2024

dragnoir commented Apr 18, 2024

dragnoir commented Apr 19, 2024

Santhosh-Sellavel commented Apr 19, 2024 • edited Loading

Santhosh-Sellavel commented Apr 21, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Apr 21, 2024

dragnoir commented Apr 21, 2024

shawnborton commented Apr 22, 2024

shawnborton commented Apr 22, 2024

dragnoir commented Apr 22, 2024

OSBotify commented Apr 23, 2024

OSBotify commented Apr 24, 2024

OSBotify commented Apr 25, 2024

dragnoir commented Apr 11, 2024 •

edited

Loading

Santhosh-Sellavel commented Apr 19, 2024 •

edited

Loading

Santhosh-Sellavel commented Apr 21, 2024 •

edited

Loading