Caret position on WEB #17331

perunt · 2023-04-12T09:51:27Z

Details

Fixed Issues

$ #16078
PROPOSAL: GH_LINK_ISSUE(COMMENT)

This PR adds caret tracking for web and desktop platforms, which is an essential step in bringing inline suggestions to the text input

Verify that no errors appear in the JS console

In this pull request, the methods of the TextInput were expanded, which should not affect any existing functionality. However, to test this pull request, you can use the text inputs anywhere.

For more detailed testing, you can check the value of the onSelectionChange event(in a chat screen). Check the new positionX and positionY properties, which show the coordinates of the caret.

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

Apr-17-2023.11-45-38.mp4

Mobile Web - Chrome

\

Apr-17-2023.12-05-54.mp4

Mobile Web - Safari

Apr-17-2023.12-28-45.mp4

Desktop

iOS

Android

…if `shouldCalculateCaretPosition` is true

…eb-caret-position

MelvinBot · 2023-04-17T11:07:06Z

@hayata-suenaga 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]

hayata-suenaga · 2023-04-17T16:01:24Z

@perunt could you paste the link to the issue on your comment next to GH_LINK?

src/components/Composer/index.js

hayata-suenaga · 2023-04-17T16:41:41Z

@puneetlath since you have the context, if you have time, could you also review this PR?

puneetlath · 2023-04-18T21:29:15Z

Yes, I'll take a look!

src/components/Composer/index.js

…into perunt/web-caret-position

…eb-caret-position

puneetlath

Looks good to me.

hayata-suenaga

LGTM!

0xmiros · 2023-04-28T20:08:36Z

@perunt please fill all checklist

Unchecked:

The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone

Updated:

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.

New:

I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.

Also link issue correctly, should be like this:
$ https://github.com/Expensify/App/issues/16078
And should we support edit composer as well?

perunt · 2023-05-01T11:40:23Z

@0xmiroslav thanks for letting me know about the missed and new checkbox! Right now, it only works with the main input, but it can be easily transferred to the edit input soon.

puneetlath · 2023-05-01T17:25:00Z

Right now, it only works with the main input, but it can be easily transferred to the edit input soon.

@perunt so is your plan to do that in a separate PR?

perunt · 2023-05-02T08:44:01Z

Splitting this PR and merging the one in question would help me save time, enabling me to work on the Emoji Suggestion task simultaneously. So yeah, if you don't mind, I would love to split it.

puneetlath · 2023-05-02T15:19:28Z

Ok sounds good. @0xmiroslav will you be able to complete the checklist today?

0xmiros · 2023-05-16T15:03:46Z

reviewing in an hr

0xmiros · 2023-05-16T20:08:25Z

src/components/Composer/index.js

@@ -192,6 +201,57 @@ class Composer extends React.Component {
        this.textInput.removeEventListener('wheel', this.handleWheel);
    }

+    // Get characters from the cursor to the next space or new line
+    getNextChars(str, cursorPos) {


need jsDoc for params

0xmiros · 2023-05-16T21:23:31Z

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

web.mov

Mobile Web - Chrome

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

N/A

Android

N/A

0xmiros · 2023-05-16T21:24:55Z

Web, desktop, mSafari look good but android chrome failing

mchrome.mov

perunt · 2023-05-17T14:27:57Z

This PR doesn't handle the scrolling and height restriction for the text input. Right now, it works fine until you reach the scroll in the input field. The same issue would occur on other platforms too. I'm not sure if we face the same problem in the native environment. If we do, it would make sense to create a separate PR and synchronize it across all platforms. If not, then it would be better to include it in this PR.

0xmiros · 2023-05-17T14:31:53Z

This PR doesn't handle the scrolling and height restriction for the text input. Right now, it works fine until you reach the scroll in the input field. The same issue would occur on other platforms too. I'm not sure if we face the same problem in the native environment. If we do, it would make sense to create a separate PR and synchronize it across all platforms. If not, then it would be better to include it in this PR.

@puneetlath what do you suggest?

puneetlath · 2023-05-17T21:14:44Z

I'm not sure if we face the same problem in the native environment. If we do, it would make sense to create a separate PR and synchronize it across all platforms. If not, then it would be better to include it in this PR.

Sounds like we need to figure out whether it's also a problem on native devices in order to decide.

puneetlath · 2023-05-18T15:12:03Z

@perunt is that a question that you're going to investigate?

perunt · 2023-05-18T15:17:03Z

@puneetlath absolutely! I'll definitely check it out and make sure to mention you. I apologize for the delay as I've had to prioritize a more urgent task. I'll make sure to get to it sometime during the day.

puneetlath · 2023-05-18T15:23:23Z

No worries! Just making sure.

hayata-suenaga · 2023-05-22T16:36:17Z

@perunt did you have a chance to investigate the problem?

perunt · 2023-05-22T18:33:40Z

i just checked it , and it works the same on Android and IOS

May-22-2023.20-31-30.mp4

May-22-2023.20-15-55.mp4

perunt · 2023-05-23T11:59:19Z

@hayata-suenaga @puneetlath what do you think, can we handle this measuring and connect all platforms in the separate PR?

puneetlath · 2023-05-23T19:23:11Z

That works for me. @hayata-suenaga @0xmiroslav good with you?

0xmiros · 2023-05-23T19:24:16Z

I am good. Happy to review that follow-up PR as well 🙂

puneetlath · 2023-05-23T19:27:04Z

Ok cool. @0xmiroslav The reviewer checklist check is failing for some reason.

hayata-suenaga

🚀

OSBotify · 2023-05-23T19:53:49Z

✋ 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-05-25T00:34:42Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.18-0 🚀

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

OSBotify · 2023-05-25T01:08:14Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.18-0 🚀

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

OSBotify · 2023-05-25T01:30:10Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.18-0 🚀

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

OSBotify · 2023-05-26T07:07:22Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.18-2 🚀

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

narefyev91 · 2023-09-20T09:13:34Z

src/components/Composer/index.js

+            <View
+                style={{
+                    position: 'absolute',
+                    bottom: -2000,


this changes made a regression - #26535

perunt added 3 commits April 12, 2023 11:49

calculates the position of the caret and updates the component state …

98ad44a

…if `shouldCalculateCaretPosition` is true

eslint

b452aa8

Merge branch 'main' of https://github.com/Expensify/App into perunt/w…

d35ea9b

…eb-caret-position

perunt mentioned this pull request Apr 17, 2023

[HOLD for payment 2024-06-28] MEDIUM: Make auto-complete component work inline #16078

Closed

perunt marked this pull request as ready for review April 17, 2023 11:06

perunt requested a review from a team as a code owner April 17, 2023 11:06

melvin-bot bot requested review from hayata-suenaga and removed request for a team April 17, 2023 11:07

hayata-suenaga reviewed Apr 17, 2023

View reviewed changes

src/components/Composer/index.js Show resolved Hide resolved

src/components/Composer/index.js Outdated Show resolved Hide resolved

hayata-suenaga requested a review from puneetlath April 17, 2023 16:41

hayata-suenaga reviewed Apr 19, 2023

View reviewed changes

src/components/Composer/index.js Show resolved Hide resolved

hayata-suenaga reviewed Apr 19, 2023

View reviewed changes

src/components/Composer/index.js Show resolved Hide resolved

mczernek previously approved these changes Apr 20, 2023

View reviewed changes

src/components/Composer/index.js Show resolved Hide resolved

perunt added 2 commits April 21, 2023 11:08

Merge branch 'main' of https://github.com/margelo/expensify-app-fork …

c33ef11

…into perunt/web-caret-position

change func name to addCursorPositionToSelectionChange

23472c3

perunt dismissed mczernek’s stale review via 23472c3 April 21, 2023 09:46

perunt added 2 commits April 24, 2023 14:03

Merge branch 'main' of https://github.com/Expensify/App into perunt/w…

70903e7

…eb-caret-position

add optional statement

b855615

puneetlath previously approved these changes Apr 25, 2023

View reviewed changes

hayata-suenaga previously approved these changes Apr 27, 2023

View reviewed changes

puneetlath requested a review from 0xmiros April 28, 2023 19:15

0xmiros reviewed May 16, 2023

View reviewed changes

0xmiros approved these changes May 23, 2023

View reviewed changes

puneetlath approved these changes May 23, 2023

View reviewed changes

hayata-suenaga self-requested a review May 23, 2023 19:42

hayata-suenaga approved these changes May 23, 2023

View reviewed changes

puneetlath merged commit 2d9a209 into Expensify:main May 23, 2023

OSBotify mentioned this pull request May 25, 2023

Deploy Checklist: New Expensify 2023-05-25 #19565

Closed

53 tasks

Christinadobrzyn mentioned this pull request Jun 2, 2023

[HOLD for payment 2024-07-24] Chat - Mentions popup doesn't appear when editing message #19643

Closed

6 tasks

narefyev91 reviewed Sep 20, 2023

View reviewed changes

narefyev91 mentioned this pull request Sep 20, 2023

[HOLD for payment 2023-09-18] [$500] Chat - Scroll and image click is disabled when composer limit is triggered and we paste more text #26535

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Caret position on WEB #17331

Caret position on WEB #17331

perunt commented Apr 12, 2023 •

edited

Loading

MelvinBot commented Apr 17, 2023

hayata-suenaga commented Apr 17, 2023

hayata-suenaga commented Apr 17, 2023

puneetlath commented Apr 18, 2023

puneetlath left a comment

hayata-suenaga left a comment

0xmiros commented Apr 28, 2023 •

edited

Loading

perunt commented May 1, 2023

puneetlath commented May 1, 2023

perunt commented May 2, 2023

puneetlath commented May 2, 2023

0xmiros commented May 16, 2023

0xmiros May 16, 2023

0xmiros commented May 16, 2023

0xmiros commented May 16, 2023

perunt commented May 17, 2023

0xmiros commented May 17, 2023

puneetlath commented May 17, 2023

puneetlath commented May 18, 2023

perunt commented May 18, 2023

puneetlath commented May 18, 2023

hayata-suenaga commented May 22, 2023

perunt commented May 22, 2023

perunt commented May 23, 2023

puneetlath commented May 23, 2023

0xmiros commented May 23, 2023

puneetlath commented May 23, 2023

hayata-suenaga left a comment

OSBotify commented May 23, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 26, 2023

narefyev91 Sep 20, 2023

Caret position on WEB #17331

Caret position on WEB #17331

Conversation

perunt commented Apr 12, 2023 • edited Loading

Details

Fixed Issues

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 17, 2023

hayata-suenaga commented Apr 17, 2023

hayata-suenaga commented Apr 17, 2023

puneetlath commented Apr 18, 2023

puneetlath left a comment

Choose a reason for hiding this comment

hayata-suenaga left a comment

Choose a reason for hiding this comment

0xmiros commented Apr 28, 2023 • edited Loading

perunt commented May 1, 2023

puneetlath commented May 1, 2023

perunt commented May 2, 2023

puneetlath commented May 2, 2023

0xmiros commented May 16, 2023

0xmiros May 16, 2023

Choose a reason for hiding this comment

0xmiros commented May 16, 2023

Reviewer Checklist

Screenshots/Videos

0xmiros commented May 16, 2023

perunt commented May 17, 2023

0xmiros commented May 17, 2023

puneetlath commented May 17, 2023

puneetlath commented May 18, 2023

perunt commented May 18, 2023

puneetlath commented May 18, 2023

hayata-suenaga commented May 22, 2023

perunt commented May 22, 2023

perunt commented May 23, 2023

puneetlath commented May 23, 2023

0xmiros commented May 23, 2023

puneetlath commented May 23, 2023

hayata-suenaga left a comment

Choose a reason for hiding this comment

OSBotify commented May 23, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 26, 2023

narefyev91 Sep 20, 2023

Choose a reason for hiding this comment

perunt commented Apr 12, 2023 •

edited

Loading

0xmiros commented Apr 28, 2023 •

edited

Loading