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

Fix/48736 fix settings header #48829

Conversation

ChavdaSachin
Copy link
Contributor

Details

Fixed Issues

$ #48736
PROPOSAL: #48736 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

  1. Open Settings
  2. Scroll the Settings page.
  3. Verify Header stays in place and scrollbar is hidden.
  • 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
Screen.Recording.2024-09-10.at.1.45.19.AM.mov
Android: mWeb Chrome
Screen.Recording.2024-09-10.at.1.52.21.AM.mov
iOS: Native
Screen.Recording.2024-09-10.at.1.11.13.AM.mov
iOS: mWeb Safari
Screen.Recording.2024-09-10.at.1.13.08.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-09-10.at.12.55.05.AM.mov
MacOS: Desktop
Screen.Recording.2024-09-10.at.12.58.11.AM.mov

@ChavdaSachin ChavdaSachin requested a review from a team as a code owner September 9, 2024 20:40
@melvin-bot melvin-bot bot requested a review from ikevin127 September 9, 2024 20:40
Copy link

melvin-bot bot commented Sep 9, 2024

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

@melvin-bot melvin-bot bot removed the request for review from a team September 9, 2024 20:40
Copy link
Contributor

github-actions bot commented Sep 9, 2024

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

@ChavdaSachin
Copy link
Contributor Author

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

@ChavdaSachin
Copy link
Contributor Author

Tagging @Expensify/design for design review.

@ChavdaSachin
Copy link
Contributor Author

recheck

@ikevin127
Copy link
Contributor

Tagging @Expensify/design for design review.

@ChavdaSachin I think we're good in terms of design as that was already determined in the issue. Regarding the CLA check failing, you're all good - that's expected. I'm working on the PR Reviewer Checklist as we speak 👍

Copy link
Contributor

@ikevin127 ikevin127 left a comment

Choose a reason for hiding this comment

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

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.webm
Android: mWeb Chrome
android-mweb.webm
iOS: Native
ios.mp4
iOS: mWeb Safari
ios-mweb.mp4
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@melvin-bot melvin-bot bot requested a review from marcochavezf September 9, 2024 22:03
@ChavdaSachin ChavdaSachin changed the title Chavda sachin fix/48736 fix settings header Fix/48736 fix settings header Sep 9, 2024
@dubielzyk-expensify
Copy link
Contributor

This is mostly looking good, but the top header seems to be too big:
CleanShot 2024-09-10 at 10 24 30@2x

I think it should follow the same height as all other page headers which is 80px

There also seem to be a padded top instead of the whole page header being padded:
CleanShot 2024-09-10 at 10 22 38@2x
CleanShot 2024-09-10 at 10 25 09@2x

Other page header for comparison:
CleanShot 2024-09-10 at 10 23 15@2x

cc @Expensify/design for gutcheck here

@shawnborton
Copy link
Contributor

I agree with those points Jon. It might be more difficult to get the height the same size here since the avatar we're using on settings is 52x52 instead of 40x40. That being said, we could probably just make the top area use a fixed height of 80px and vertically center everything? Or reduce the avatar down to 40x40. Thoughts?

@dubielzyk-expensify
Copy link
Contributor

That being said, we could probably just make the top area use a fixed height of 80px and vertically center everything? Or reduce the avatar down to 40x40. Thoughts?

I like that idea

@ChavdaSachin
Copy link
Contributor Author

@dubielzyk-expensify check this screenshot with header height 80px with avatar size 52*52 and removed top padding from page wrapper.
Does it look good to you?
Screenshot 2024-09-10 at 3 13 27 PM

Screenshot 2024-09-10 at 3 16 57 PM

@shawnborton
Copy link
Contributor

I think that feels okay to me. Would love to see a quick video of jumping between Inbox, Search, and then Settings to see how that top part feels as you change pages.

@ChavdaSachin
Copy link
Contributor Author

Here's the video you asked for.

Screen.Recording.2024-09-10.at.3.41.55.PM.mov

@shawnborton
Copy link
Contributor

Cool, I do think that feels okay, but again that does make me slightly curious about what a 40x40 avatar would look like in the header for Settings. I know I had pitched that idea to @dannymcclain at one point but I think we decided to just stick with 52x52.

@ChavdaSachin
Copy link
Contributor Author

Check this

Screenshot 2024-09-10 at 4 00 44 PM
Screen.Recording.2024-09-10.at.4.00.03.PM.mov

@shawnborton
Copy link
Contributor

Dang, it does feel kinda nice that the avatar stays in exactly the same spot across the app pages. Let's see what the rest of the @Expensify/design gang thinks though!

@ChavdaSachin
Copy link
Contributor Author

ChavdaSachin commented Sep 10, 2024

If we decide to go with Avatar size 40*40, we additionally have to modify skeleton view for the same.
Heres what I came up with,

before changes Screenshot 2024-09-10 at 4 45 22 PM Screenshot 2024-09-10 at 4 45 36 PM
after changes Screenshot 2024-09-10 at 4 29 12 PM Screenshot 2024-09-10 at 4 33 28 PM

Code changes

  • from
<Rect
    x={startPositionX + avatarPlaceholderRadius + styles.gap3.gap}
    y="11"
    width="45%"
    height="8"
/>
<Rect
    x={startPositionX + avatarPlaceholderRadius + styles.gap3.gap}
    y="31"
    width="55%"
    height="8"
/>
  • To
<Rect
    x={startPositionX + avatarPlaceholderRadius + styles.gap3.gap}
    y="6"
    width="45%"
    height="8"
/>
<Rect
    x={startPositionX + avatarPlaceholderRadius + styles.gap3.gap}
    y="26"
    width="55%"
    height="8"
/>

and changed Avatar size passed for skeleton view, tell me what you think about it.

@dannymcclain
Copy link
Contributor

Dang, it does feel kinda nice that the avatar stays in exactly the same spot across the app pages.

Yeah I agree, this does actually feel pretty nice.

I think I was originally kind of against the 40x40 avatar there, but seeing it in this video looks pretty good. I think it feels a little small next to the type lockup next to it, but I'm definitely down to give it a go!

That would once again simplify the amount of avatar sizes we're using in the app, and I agree that switching between tabs feels nice with the avatar always staying in the exact same spot.


🫣 I'm curious what @Expensify/design thinks of these #tweaker ideas...

Before After
CleanShot 2024-09-10 at 08 23 26@2x CleanShot 2024-09-10 at 08 23 15@2x

Basically I'm:

  • making the avatar 40x40
  • updating the name text to be 15px instead of 17px
  • decreasing the gap between the name and the email address to be 0 instead of 4px

This might be going too far, so just tell me to go away if that's the case 😂. Just trying to create more of a tight little lockup for the avatar/profile info in that top corner.

CleanShot.2024-09-10.at.08.27.22.mp4

@shawnborton
Copy link
Contributor

Hmm actually... should the name use our h2 styles to match other pages where we use New Kansas to say Inbox, Search, etc?!

Otherwise I feel like I like 17px font size as that's our "page header" font size, and this feels like a page header to me. Super down with 40x40 though!

@dannymcclain
Copy link
Contributor

Interesting Shawn! I kinda like that idea, but I do worry we might be straying from the path of this PR a little bit 😅

Here's a little mock showing that idea with the rest of the headers:

CleanShot 2024-09-10 at 08 46 57@2x

@shawnborton
Copy link
Contributor

Hmm yeah, I think I like just the good ol' Page Header 17px the best, with a 40px avatar. That gives us a smaller amount of changes in this PR too as you mention (since we're startin' to cruise down some side streets)

@dannymcclain
Copy link
Contributor

dannymcclain commented Sep 10, 2024

Yeah totally. Sounds good to me!

So to bring us back from my psychotic tangent:

All we want to do is update the avatar size to be 40x40px. No changes needed to the text lockup or anything like that. 👍

@ChavdaSachin
Copy link
Contributor Author

So a quick summary of changes

  • Use default 40*40px avatar for the header.
  • Center header content and fix header content height to 80px.
  • remove top padding from page wrapper.
  • fix skeleton view for the header to match new style.

@dannymcclain
Copy link
Contributor

That sounds right to me.

@ChavdaSachin
Copy link
Contributor Author

Changes are committed according to design team inputs.
Commit ready for review.
cc. @marcochavezf , @ikevin127

@ikevin127
Copy link
Contributor

ikevin127 commented Sep 10, 2024

I will look into this once again to confirm everything works and looks as expected 👍

@dubielzyk-expensify
Copy link
Contributor

I vastly prefer the avatar at 40x40 also due to the fact that the vertical alignment feels better:
CleanShot 2024-09-11 at 09 28 57@2x

@dubielzyk-expensify
Copy link
Contributor

dubielzyk-expensify commented Sep 10, 2024

Checked it out locally and it looks great! Thanks for sweating the details with us here @ChavdaSachin 😄

@ChavdaSachin
Copy link
Contributor Author

Pleasure is all mine.
Despite the fact - working with design team shoulder to shoulder is a quite rare opportunity 😄.

@ChavdaSachin
Copy link
Contributor Author

idea

In order to keep app layout more consistent I propose to hide scrollbar from remaining 2 LHN pages as well

  • LHN search page
  • Workspace switcher
Screenshots Screenshot 2024-09-11 at 5 46 18 AM Screenshot 2024-09-11 at 5 46 34 AM

if @expensify/design think this idea appropriate, feel free to raise an issue and assign me.

@ikevin127
Copy link
Contributor

In order to keep app layout more consistent I propose to hide scrollbar from remaining 2 LHN pages as well

I think we've already gone out of the scope enough with this PR, let's keep it contained for now and revisit if needed.

@marcochavezf 🟢 I just double checked the PR after the latest design adjustments and everything works and looks as expected - we're good to merge here from my side!

@dubielzyk-expensify
Copy link
Contributor

dubielzyk-expensify commented Sep 11, 2024

idea
In order to keep app layout more consistent I propose to hide scrollbar from remaining 2 LHN pages as well

Love that you're coming to the table with ideas! 😄

I think for this one, there's quite a few considerations into accessibility as each platform does different things to the scroll bar. MacOS hides them by default, while some browsers override this etc. So I think we'll take this back and have a think, but not implement this for now cause we need to look at the ripple effects here. Again, love the idea and if we do it, we'll reach out 👍 For now let's move on without this

@shawnborton
Copy link
Contributor

Agree that we can discuss the scrolling issues as a separate issue/follow up. Glad we resolved the avatar size and fixed header area though, LGTM.

Copy link
Contributor

@marcochavezf marcochavezf 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!

@marcochavezf marcochavezf merged commit 10bac1b into Expensify:main Sep 11, 2024
15 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.33-4 🚀

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

@ChavdaSachin ChavdaSachin deleted the ChavdaSachin-fix/48736-Fix-Settings-Header branch September 24, 2024 08:52
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