[Wave8] Search Input component #32439

MaciejSWM · 2023-12-04T17:41:39Z

Details

This PR creates a new <Search /> component and it's storybook. It's not used in the cody. To render it, use:

<Search placeholder={translate('sidebarScreen.buttonSearch')} />

Change the bg color of the sidebar for proper testing:

sidebar: colors.productDark200,

becomes

sidebar: colors.productDark100,

Storybook:

Fixed Issues

$ #31766
PROPOSAL:

Tests

Test in Storybook or render somewhere in the app.
Compare with Figma's designs.

Offline tests

Same as Tests

QA Steps

Not used in the app, thus no QA

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 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 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.

No screenshots - usage only in Storybook.

melvin-bot · 2023-12-05T12:29:39Z

@aimane-chnaif 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]

MaciejSWM · 2023-12-05T12:30:04Z

@aimane-chnaif ready for review. This PR is an extracted Search Input from #32103

aimane-chnaif · 2023-12-05T14:36:44Z

src/styles/styles.ts

@@ -3017,6 +3017,25 @@ const styles = (theme: ThemeColors) =>
            flex: 1,
        },

+        searchContainer: {
+            backgroundColor: theme.highlightBG,
+            borderRadius: 999,


why not just be 20?

aimane-chnaif · 2023-12-05T14:37:04Z

src/styles/styles.ts

+            minHeight: 40,
+            maxHeight: 40,


Why minHeight, maxHeight needed?

Investigating. Having only height: 40 renders like this:

The minHeight alone is enough to have the following effect:

Adding height on parent Pressable works nicely though. Going for it.

aimane-chnaif · 2023-12-05T14:37:57Z

src/components/Search.tsx

+                onPress={onPress}
+            >
+                {({hovered}) => (
+                    <View style={[styles.flex1, styles.flexRow, styles.gap2, styles.ph6, styles.alignItemsCenter, styles.searchContainer, hovered && styles.searchContainerHovered, style]}>


seems like lots of style definition. can we define new style name in styles.ts?

Moving everything to styles.searchContainer. I thought reusing the existing styles is good though.

Is this a good combo?

<View style={[styles.gap2, styles.ph6, styles.searchContainer, hovered && styles.searchContainerHovered, style]}>

searchContainer: { flex: 1, flexDirection: 'row', alignItems: 'center', backgroundColor: theme.highlightBG, borderRadius: variables.componentBorderRadiusRounded, },

Or everything moved to styles?

<View style={[styles.searchContainer, hovered && styles.searchContainerHovered, style]}>

searchContainer: { flex: 1, flexDirection: 'row', alignItems: 'center', gap: 8, paddingHorizontal: 24, backgroundColor: theme.highlightBG, borderRadius: variables.componentBorderRadiusRounded, },

aimane-chnaif · 2023-12-05T14:38:32Z

src/components/Search.tsx

+    onPress: (event?: GestureResponderEvent | KeyboardEvent) => void;
+
+    // Text explaining what the user can search for
+    prompt: string;


I prefer title to prompt

placeholder ot title

aimane-chnaif · 2023-12-05T14:43:54Z

src/components/Search.tsx

+
+    return (
+        <Tooltip text={tooltip ?? translate('common.search')}>
+            <PressableWithFeedback


no background color when press/long press on mobile. Is it expected?

ios.hover.mov

Hey @aimane-chnaif . If you change the sidebar background color from sidebar: colors.productDark200, to sidebar: colors.productDark100, you will see the touchable feedback in action. It's visible on onPress. There's no style change when onPress becomes onLongPress.

@dannymcclain @shawnborton LMK if this looks good.

Screen.Recording.2023-12-13.at.16.07.48.mov

Ah yeah a couple of things here:

At some point we need to change this entire sidebar to use the same color100 (appBG) color. Not sure when or where we plan to do that.

The search input should technically be using color300 (same as rowHover) as the background color. I don't think we've decided anything for the search inputs :hover or :active but I suppose it could be color400 for hover and color500 for active/press?

Same concern on light theme. There's no visual feedback on background color on press/long press. (not blocker)

light.mov

Asked Maciej to address this in the follow up PRs

Oh, the color of the search input from figma (#07271F) seems to be gone from the repo after recent changes in the theme. So I'll do 300/400/500 @shawnborton. Although our app now suggests something like that:

componentBG: colors.productDark100, hoverComponentBG: colors.productDark200, activeComponentBG: colors.productDark400,

But I know it can change as currently we have the wrong background color in the sidebar, while ideal-nav will have bg200 if I remember correctly

While on the buttons currently we have:

buttonDefaultBG: colors.productDark400, buttonHoveredBG: colors.productDark500, buttonPressedBG: colors.productDark600,

@shawnborton

300/400/500:

Screen.Recording.2023-12-15.at.17.20.54.mov

Screen.Recording.2023-12-15.at.17.24.20.mov

mountiny · 2023-12-05T21:41:26Z

src/components/Search.tsx

+    onPress: (event?: GestureResponderEvent | KeyboardEvent) => void;
+
+    // Text explaining what the user can search for
+    prompt: string;


placeholder ot title

src/stories/Search.stories.js

MaciejSWM · 2023-12-13T15:11:08Z

@aimane-chnaif ready for re-review

mountiny · 2023-12-14T11:04:57Z

@aimane-chnaif Could you please rereview this PR? Thanks!

aimane-chnaif · 2023-12-15T14:29:14Z

reviewing

aimane-chnaif · 2023-12-15T15:00:33Z

Code looks good.
@MaciejSWM One minor thing: (NAB)

aimane-chnaif · 2023-12-15T15:01:18Z

src/components/Search.tsx

+        <Tooltip text={tooltip ?? translate('common.search')}>
+            <PressableWithFeedback
+                accessibilityLabel={tooltip ?? translate('common.search')}
+                role={CONST.ACCESSIBILITY_ROLE.BUTTON}


Suggested change

role={CONST.ACCESSIBILITY_ROLE.BUTTON}

role={CONST.ROLE.BUTTON}

aimane-chnaif · 2023-12-15T15:03:19Z

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 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(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 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

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

mountiny

This is not used anywhere yet so I think we can go ahead and merge, all yours @hayata-suenaga

mountiny · 2023-12-15T15:43:18Z

src/components/Search.tsx

+
+    return (
+        <Tooltip text={tooltip ?? translate('common.search')}>
+            <PressableWithFeedback


Asked Maciej to address this in the follow up PRs

hayata-suenaga

LGTM!

OSBotify · 2023-12-15T18:03:48Z

✋ 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 · 2023-12-19T02:43:15Z

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

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

OSBotify · 2023-12-19T03:46:36Z

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

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

OSBotify · 2023-12-21T05:14:11Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.14-6 🚀

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

MaciejSWM added 3 commits December 4, 2023 18:34

Translations for Search Input

3e6b99a

Create Search component

ddd3152

Storybook for Search component

f569b7b

MaciejSWM mentioned this pull request Dec 4, 2023

[HOLD merge of main PR] [Wave8] Top Bar Search - Search Input and clickable Logo with arrow down icon #32103

Closed

45 tasks

MaciejSWM added 2 commits December 5, 2023 13:18

Merge branch 'main' into wave8/top-bar-search-no-usage

4d23fbc

Drop spaces around brackets

4608493

MaciejSWM marked this pull request as ready for review December 5, 2023 12:29

MaciejSWM requested a review from a team as a code owner December 5, 2023 12:29

melvin-bot bot requested review from aimane-chnaif and removed request for a team December 5, 2023 12:29

aimane-chnaif reviewed Dec 5, 2023

View reviewed changes

hayata-suenaga requested review from hayata-suenaga and mountiny December 5, 2023 16:39

mountiny reviewed Dec 5, 2023

View reviewed changes

MaciejSWM added 8 commits December 13, 2023 13:28

Rename prompt to placeholder

0521050

Default placeholder and tooltip texts

68aeaf2

Use predefined value for borderRadius

145f1b4

Fix height of search bar

aad68bc

Create style for search input instead of reusing existing styles

cdea74e

Migrate Search.stories to TypeScript

371ce8f

Merge branch 'main' into wave8/top-bar-search-no-usage

0e88819

Adjust color after merge

9a8b385

MaciejSWM requested a review from aimane-chnaif December 13, 2023 15:11

BartoszGrajdek approved these changes Dec 14, 2023

View reviewed changes

MaciejSWM added 2 commits December 14, 2023 17:47

Merge branch 'main' into wave8/top-bar-search-no-usage

0f0d235

Change import path

a620689

aimane-chnaif reviewed Dec 15, 2023

View reviewed changes

aimane-chnaif approved these changes Dec 15, 2023

View reviewed changes

melvin-bot bot requested a review from mountiny December 15, 2023 15:07

MaciejSWM added 2 commits December 15, 2023 16:36

Merge branch 'main' into wave8/top-bar-search-no-usage

83094a8

Adjust NAB

d1dac19

mountiny approved these changes Dec 15, 2023

View reviewed changes

hayata-suenaga approved these changes Dec 15, 2023

View reviewed changes

hayata-suenaga merged commit 668af1c into Expensify:main Dec 15, 2023
22 checks passed

github-actions bot mentioned this pull request Dec 19, 2023

Deploy Checklist: New Expensify 2023-12-19 #33264

Closed

98 tasks

melvin-bot bot mentioned this pull request Dec 21, 2023

[HOLD for payment 2023-12-29] [HOLD for payment 2023-12-28] [Ideal Nav] Create components for the ideal nav #31766

Closed

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Wave8] Search Input component #32439

[Wave8] Search Input component #32439

MaciejSWM commented Dec 4, 2023 •

edited

Loading

melvin-bot bot commented Dec 5, 2023

MaciejSWM commented Dec 5, 2023

aimane-chnaif Dec 5, 2023

aimane-chnaif Dec 5, 2023

MaciejSWM Dec 13, 2023

MaciejSWM Dec 13, 2023

MaciejSWM Dec 13, 2023

aimane-chnaif Dec 5, 2023

MaciejSWM Dec 13, 2023

MaciejSWM Dec 13, 2023

aimane-chnaif Dec 5, 2023

mountiny Dec 5, 2023

aimane-chnaif Dec 5, 2023

MaciejSWM Dec 13, 2023

shawnborton Dec 13, 2023

aimane-chnaif Dec 15, 2023

mountiny Dec 15, 2023

MaciejSWM Dec 15, 2023

MaciejSWM Dec 15, 2023

MaciejSWM Dec 15, 2023 •

edited

Loading

mountiny Dec 5, 2023

MaciejSWM commented Dec 13, 2023

mountiny commented Dec 14, 2023

aimane-chnaif commented Dec 15, 2023

aimane-chnaif commented Dec 15, 2023 •

edited

Loading

aimane-chnaif Dec 15, 2023

aimane-chnaif commented Dec 15, 2023

mountiny left a comment

mountiny Dec 15, 2023

hayata-suenaga left a comment

OSBotify commented Dec 15, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 21, 2023

	role={CONST.ACCESSIBILITY_ROLE.BUTTON}
	role={CONST.ROLE.BUTTON}

[Wave8] Search Input component #32439

[Wave8] Search Input component #32439

Conversation

MaciejSWM commented Dec 4, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

melvin-bot bot commented Dec 5, 2023

MaciejSWM commented Dec 5, 2023

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

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

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

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

Choose a reason for hiding this comment

MaciejSWM Dec 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MaciejSWM commented Dec 13, 2023

mountiny commented Dec 14, 2023

aimane-chnaif commented Dec 15, 2023

aimane-chnaif commented Dec 15, 2023 • edited Loading

Choose a reason for hiding this comment

aimane-chnaif commented Dec 15, 2023

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hayata-suenaga left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 15, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 21, 2023

MaciejSWM commented Dec 4, 2023 •

edited

Loading

MaciejSWM Dec 15, 2023 •

edited

Loading

aimane-chnaif commented Dec 15, 2023 •

edited

Loading