Add a button to expand the composer to full screen when the input has 3+ lines

[neil-marcellini]

Details

When a user has typed 3+ lines into the composer (chat text input), show an expand button that will expand the composer to be full screen. The user can also collapse the composer if they like. The composer will automatically collapse when the message is sent. If the composer is full screen and the user deletes lines until there are less than 3, the composer will remain expanded until they press the collapse button.

Fixed Issues

$ #8423

Tests / QA Steps

• Verify that no errors appear in the JS console
• Make sure everything looks ok

All platforms:

Sign into NewDot with any account

• A

1. Go to a chat and enter 3 lines into the composer (text input)
2. Make sure that the expand button shows up when you enter the 3rd line

• B

1. Delete a line
2. Verify that the expand button is hidden

• C

1. Add a line
2. Click the expand button
3. Make sure that the composer goes full screen
4. Click the collapse button
5. Make sure that the composer collapses back to it's original size.

• D

1. Expand the composer
2. Delete until there is 1 line
3. Verify that the composer is still expanded
4. collapse the composer
5. Verify that the expand button is not shown

• E

1. Paste a lot of text into the composer (this PR description works)
2. Verify that the composer is not full screen
3. Expand the composer
4. Verify that the text fills the full composer
5. Collapse the composer
6. Verify that the composer is not full screen

• F

1. Expand the composer
2. Send the message
3. Verify that the composer collapses after sending

• G

1. Enter 3+ lines in the composer
2. Make sure you can hit the emoji button and select and emoji
3. Expand the composer
4. Make sure you can hit the emoji button and select and emoji

Native Mobile only:

• Mobile A

1. Enter 3+ lines into the composer and ensure the keyboard shows
2. Expand the composer
3. Dismiss the keyboard by swiping it down
4. Verify that the composer expands downward to fill the whole screen
5. Collapse the composer
6. Verify that it collapses at the bottom of the screen.

PR Review Checklist

Contributor (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 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 included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • iOS / native
  • Android / native
  • iOS / Safari
  • Android / Chrome
  • MacOS / Chrome
  • 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 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 was added in all src/languages/* files
  • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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
• 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 */
  • Any functional components have the displayName property
  • 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
• 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 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.

PR Reviewer Checklist

• 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 verified tests pass on all platforms & I tested again on:
  • iOS / native
  • Android / native
  • iOS / Safari
  • Android / Chrome
  • MacOS / Chrome
  • 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 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 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 was added in all src/languages/* files
  • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 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 */
  • Any functional components have the displayName property
  • 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 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 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.

Screenshots

Web

web.mp4

Mobile Web

Android / Chrome

Android-Chrome.mp4

**iOS / Safari **

iOS-Safari.mp4

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

[neil-marcellini]

Currently, expanding and collapsing the composer only works after refreshing the page, so I'll focus on fixing that. Please let me know what you think of my solution so far.

[neil-marcellini]

Expanding and collapsing the composer works now. Next I want to automatically collapse the composer when a message is sent. Then I need to fix a bug where the composer doesn't reduce size when deleting lines from 3 to 0.

[neil-marcellini]

iOS and Web are working well right now. Next I'll add support for Android and then I'll check to make sure that the other uses of the Composer (editing, emojis) still function correctly.

[neil-marcellini]

Re-rolling PullerBear since I'm eager to get this merged and Luke is OOO for today.

OOO

[PauloGasparSv]

LGTM!

[OSBotify]

✋ 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]

🚀 Deployed to staging by @stitesExpensify in version: 1.1.78-0 🚀

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

[OSBotify]

🚀 Deployed to production by @sketchydroide in version: 1.1.78-8 🚀

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

[marcaaron]

@neil-marcellini nice work on this PR and feature. I came across this use of window in a cross-platform component and wanted to call out this section of the README.

We really shouldn't be seeing window unless we are in an index.js file and there's an index.native.js that is doing a no-op.

[neil-marcellini]

Ok, got it. Is it worth making an index.native.js version of this component to fix this? Or could I make a withViewportOffsetTop HOC that would have a web and native version?

[marcaaron]

Both could work. Though, this component is pretty important and having two might get confusing. I would create a small lib that returns something like VisualViewport we can call addEventListener() on and for mobile it would just return an empty function.

[marcaaron]

Could also return a cleanup method something like

index.js

function addResizeListener(callback) {
    if (!window.visualViewport) {
        return () => {};
    }

    window.visualViewport.addEventListener('resize', callback);
    return () => window.visualViewport.removeEventListener('resize', callback);
}

index.native.js

function addResizeListener(callback) {
    return () => {};
}

I feel like I've used this pattern before elsewhere to get around the cross-platform guidance.

[trjExpensify]

👋 Heads up! As per the BugZero checklist, commenting to surface that this introduced a regression on Android outlined here.

CC: @Julesssss @Santhosh-Sellavel @fedirjh

[neil-marcellini]

Thanks for the heads up. From the videos in the PR I'm pretty sure everything was aligned when this was merged, but I guess my changes were fragile.