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

Update Styling for Suggestion Pagination section of Search Feature #24598

Merged

Conversation

studentofcoding
Copy link
Contributor

@studentofcoding studentofcoding commented Aug 15, 2023

Details

This is Minor Follow-up PR to address Pagination Styling on Help Expensify Search Feature

cc: @marcochavezf @shawnborton @johncschuster

Fixed Issues

$ #23978
PROPOSAL: #23978 (comment)

Tests

  • Verify that no errors appear in the JS console

Offline tests

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 Screenshot 2023-08-16 at 02 24 55

https://www.loom.com/share/fe93f1a310cc423f9c757f13a66d7ccb?sid=3a6de312-82b1-40a3-882f-67d02a9175a5

Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@studentofcoding studentofcoding requested a review from a team as a code owner August 15, 2023 19:26
@shawnborton
Copy link
Contributor

For pagination, what if we just did something like this that follows our standard button styles?
image

cc @Expensify/design

@melvin-bot melvin-bot bot requested review from sobitneupane and removed request for a team August 15, 2023 19:49
@melvin-bot
Copy link

melvin-bot bot commented Aug 15, 2023

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

@studentofcoding
Copy link
Contributor Author

studentofcoding commented Aug 16, 2023

For pagination, what if we just did something like this that follows our standard button styles? image

cc @Expensify/design

Hmm it's more appealing and aligns with the style, the styling is implemented now :
Screenshot 2023-08-16 at 15 41 32

For the 2nd Page's background color, I take a reference from these sections below with the same hover effect. If it's wrong and needs change, do let me know @shawnborton

Screenshot 2023-08-16 at 15 43 36

@shawnborton
Copy link
Contributor

Can you double check the button colors and styling you are using? You should be able to get these directly from the App. But ideally:

  • the buttons are our "small" varient, which are 28px tall
  • the font size is 11 and bold, aka "Micro Strong"
  • double check the background color of the default buttons, it looks too dark in your mockup

Here is a Figma file in case that is helpful.

@shawnborton
Copy link
Contributor

Also another quick detail - it looks like you have the paragraph text in white (#FFFFFF) - can you change that to match our default text color? We should have a CSS var for that in colors.scss.

@studentofcoding
Copy link
Contributor Author

Figma file

  • Double-check the background color of the default buttons, it looks too dark in your mockup

You mean this one?
Screenshot 2023-08-16 at 20 46 09

Also, can you share again the figma file? It can't be accessed

@shawnborton
Copy link
Contributor

Correct, that button. Try refreshing the Figma link.

@studentofcoding
Copy link
Contributor Author

Correct, that button. Try refreshing the Figma link.

Noted, how about the hover color, is it already correct?

@studentofcoding
Copy link
Contributor Author

Done it all @shawnborton
Screenshot 2023-08-16 at 22 47 37

shawnborton
shawnborton previously approved these changes Aug 16, 2023
@marcochavezf marcochavezf self-requested a review August 16, 2023 18:21
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.

Thanks for addressing the changes, the code looks good to me

docs/_sass/_search-bar.scss Outdated Show resolved Hide resolved
@marcochavezf
Copy link
Contributor

@roryabraham would you like to review the follow-up changes for the search function?

Co-authored-by: Marco Chávez <marcochavezf@gmail.com>
@studentofcoding
Copy link
Contributor Author

Please re-approve again guys,, @shawnborton @marcochavezf

shawnborton
shawnborton previously approved these changes Aug 16, 2023
@sobitneupane
Copy link
Contributor

@marcochavezf Looks like it is a follow-up PR. Should I review the PR?

@marcochavezf
Copy link
Contributor

Hi @sobitneupane, yeah C+ review is not necessary given that this is a follow-up PR and some minor changes, thanks!

@marcochavezf
Copy link
Contributor

marcochavezf commented Aug 17, 2023

@studentofcoding it looks great, thank you! Just two minor issues that we got from internal feedback:

  1. Can we hide the scrollbar in the search bar? It looks a bit off with the style of the site. You can see, for example, on the left-hand panel of this page we don't show the scroll bar, but the content is scrollable.
Screenshot 2023-08-17 at 13 33 55
  1. Can we close the search bar when the user clicks outside of the search bar (like we do in new.expensify.com)?

@studentofcoding
Copy link
Contributor Author

studentofcoding commented Aug 18, 2023

Your welcome @marcochavezf, glad you guys like it!

Sure here below is the updated version of it

https://www.loom.com/share/fe93f1a310cc423f9c757f13a66d7ccb?sid=3a6de312-82b1-40a3-882f-67d02a9175a5

Dummy playground: https://xml-docs.vercel.app/#gsc.tab=0

@studentofcoding
Copy link
Contributor Author

All updated guys, Please re-approved again @marcochavezf @shawnborton

@marcochavezf
Copy link
Contributor

marcochavezf commented Aug 19, 2023

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 Screenshot 2023-08-18 at 19 48 17
Mobile Web - Chrome Screenshot 2023-08-18 at 19 59 54
Mobile Web - Safari Screenshot 2023-08-18 at 19 59 50
Desktop
iOS
Android

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.

Looks great, thanks @studentofcoding!

@marcochavezf marcochavezf merged commit 03cf0b1 into Expensify:main Aug 19, 2023
12 checks passed
@studentofcoding
Copy link
Contributor Author

studentofcoding commented Aug 19, 2023 via email

@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 staging by https://github.com/marcochavezf in version: 1.3.56-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.56-24 🚀

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

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.

5 participants