suppressHighlighting on Text components with onPress #24244

c3024 · 2023-08-08T01:34:44Z

Details

In iOS, Text components with onPress highlight like a button on pressing down. For uniformity, this effect has been removed in all Text components having onPress with suppressHighlighting prop.

Fixed Issues

$ #22103
PROPOSAL: #22103 (comment)

Tests

Test 1 for ReportWelcomeText

Open any chat in iOS native app.
Scroll up to the welcome message.
Press on the user name in the welcome message.
Verify that there is no highlighting effect when pressed on the user name.

Verify that no errors appear in the JS console

Test 2 for BaseAnchorForCommentsOnly and HTMLEngineProvider

Open any chat in iOS native app
Enter an email in the composer and send
Press on the email in the message
Verify that there is no highlighting effect when pressed on the email.

Verify that no errors appear in the JS console

Test 3 for AnchorRenderer

Open any workspace in iOS native app
Press on Bills
Press on email in the Manage your bills section
Verify that there is no highlighting effect when pressed.

Verify that no errors appear in the JS console

Test 4 for Banner

Open a chat with Conceirge with account manager id
Press on chat with account manager
Verify that there is no highlighting effect when pressed.

Verify that no errors appear in the JS console

Offline tests

Test 1 for ReportWelcomeText

Open any chat in iOS native app.
Scroll up to the welcome message.
Press on the user name in the welcome message.
Verify that there is no highlighting effect when pressed on the user name.

Test 2 for BaseAnchorForCommentsOnly and HTMLEngineProvider

Open any chat in iOS native app
Enter an email in the composer and send
Press on the email in the message
Verify that there is no highlighting effect when pressed on the email.

Test 3 for AnchorRenderer

Open any workspace in iOS native app
Press on Bills
Press on email in the Manage your bills section
Verify that there is no highlighting effect when pressed.

Test 4 for Banner

Open a chat with Conceirge with account manager id
Press on chat with account manager
Verify that there is no highlighting effect when pressed.

QA Steps

Test 1 for ReportWelcomeText

Open any chat in iOS native app.
Scroll up to the welcome message.
Press on the user name in the welcome message.
Verify that there is no highlighting effect when pressed on the user name.

Verify that no errors appear in the JS console

Test 2 for BaseAnchorForCommentsOnly and HTMLEngineProvider

Open any chat in iOS native app
Enter an email in the composer and send
Press on the email in the message
Verify that there is no highlighting effect when pressed on the email.

Verify that no errors appear in the JS console

Test 3 for AnchorRenderer

Open any workspace in iOS native app
Press on Bills
Press on email in the Manage your bills section
Verify that there is no highlighting effect when pressed.

Verify that no errors appear in the JS console

Test 4 for Banner

Open a chat with Conceirge with account manager id
Press on chat with account manager
Verify that there is no highlighting effect when pressed.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Test 1
https://github.com/Expensify/App/assets/102477862/21827ed8-4f77-4523-88f8-bef7bb4568b5

Test 2

htmlRenderer.mov

Test 3

billsTextLink.mov

Test 4

I have no access to account with account manager ID nor access to a archived defaulted report because Banner is used only in ReportScreen with Concierge chat with account manager and ArchivedReportFooter with default. Since this is a simple suppression of highlighting with no effect other than suppressing highlighting, this would be fine. Test steps can be followed to check with accounts which have access to these specific cases.

Android

melvin-bot · 2023-08-08T01:34:49Z

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

c3024 · 2023-08-08T17:26:36Z

Bump @abdulrahuman5196

abdulrahuman5196 · 2023-08-08T18:25:21Z

src/components/AnchorForCommentsOnly/BaseAnchorForCommentsOnly.js

@@ -88,6 +88,7 @@ function BaseAnchorForCommentsOnly({onPressIn, onPressOut, href = '', rel = '',
                        event.preventDefault();
                        linkProps.onPress();
                    }}
+                    suppressHighlighting


We shouldn't suppress here. Its already wrapped under PressableWithSecondaryInteraction which means its expecting to have opacity change on press. @c3024

This component is used in ReportActionFragment and if we don't suppress the highlighting this still remains inconsistent in iOS native compared to other platforms.
Please check this video.

Screen.Recording.2023-08-09.at.8.48.17.AM.mov

Extra highlighting for Text components in iOS is only suppressed here. The other interactions of the wrapped components are unaffected. So, I think we should add suppressHighlighting here as well.
@abdulrahuman5196

abdulrahuman5196 · 2023-08-08T18:26:36Z

src/components/TextLink.js

@@ -71,6 +71,7 @@ function TextLink(props) {
            onMouseDown={props.onMouseDown}
            onKeyDown={openLinkIfEnterKeyPressed}
            ref={props.forwardedRef}
+            suppressHighlighting


Same goes here

TextLink is used in Bills section of Workspace page.
Here as well if we do not suppress, the difference remains in iOS native.
Here is the video.
https://github.com/Expensify/App/assets/102477862/0c264cfa-e347-41ae-bef5-b7253d72d46a

abdulrahuman5196 · 2023-08-08T18:27:29Z

@c3024 We shouldn't suppress everywhere. On some cases it is expected to show pressable kindly of opacity change. For example links inside comment text.

c3024 · 2023-08-09T03:26:39Z

Please check the videos attached at the review comments. We should suppressHighlighting in these components as well. Otherwise the inconsistency remains in these places. @abdulrahuman5196

abdulrahuman5196 · 2023-08-09T05:15:30Z

@danieldoglas @zanyrenney What do we want to do on the above? We only confirmed the behaviour of email during the GH review.
Should we remove highlighting for the above mentioned components as well as suggested by @c3024 ? Should we confirm?

c3024 · 2023-08-09T13:52:43Z

@danieldoglas could you clarify if we'd like to fix this bug at the welcome message only in this issue?

danieldoglas · 2023-08-09T21:42:44Z

Let's fix for the others as well!

c3024 · 2023-08-10T22:10:46Z

With this confirmation above, could you finish the review? @abdulrahuman5196

abdulrahuman5196 · 2023-08-11T09:10:01Z

@c3024 Since we are updating other components, kindly update the test videos for the cases and add test cases on other components as well.

c3024 · 2023-08-11T15:26:12Z

@abdulrahuman5196 Updated the tests and test videos. But for the Banner it needs very specific cases to test (it needs a Concierge chat with account manager ID or a ArchivedReportFooter with a report archived due to default). So I have given the test steps but could not make a video for this test. Since it is simple suppression of highlighting, I think it would be fine. Please review.

c3024 · 2023-08-13T06:38:17Z

Please review and suggest if it still requires any changes. @abdulrahuman5196

abdulrahuman5196 · 2023-08-13T16:12:37Z

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

N/A

Mobile Web - Chrome

N/A

Mobile Web - Safari

N/A

Desktop

N/A

iOS

Screen.Recording.2023-08-13.at.9.32.45.PM.mp4

Screen.Recording.2023-08-13.at.9.34.03.PM.mp4

Screen.Recording.2023-08-13.at.9.35.14.PM.mp4

Android

N/A

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @danieldoglas

🎀 👀 🎀
C+ Reviewed

OSBotify · 2023-08-14T20:03:52Z

🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.3.54-0 🚀

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

OSBotify · 2023-08-14T21:04:08Z

🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.3.54-0 🚀

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

OSBotify · 2023-08-17T02:54:44Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.54-13 🚀

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

c3024 added 2 commits August 8, 2023 06:40

onpress

3744bfc

typo

e17367f

c3024 requested a review from a team as a code owner August 8, 2023 01:34

melvin-bot bot removed the request for review from a team August 8, 2023 01:34

melvin-bot bot requested a review from abdulrahuman5196 August 8, 2023 01:34

c3024 mentioned this pull request Aug 8, 2023

[HOLD for payment 2023-08-24] [$1000] IOS - The email in welcome message acts like a button in iOS #22103

Closed

6 tasks

abdulrahuman5196 suggested changes Aug 8, 2023

View reviewed changes

abdulrahuman5196 approved these changes Aug 13, 2023

View reviewed changes

melvin-bot bot requested a review from danieldoglas August 13, 2023 16:14

danieldoglas approved these changes Aug 14, 2023

View reviewed changes

danieldoglas merged commit 566efc9 into Expensify:main Aug 14, 2023

danieldoglas mentioned this pull request Aug 14, 2023

Revert "suppressHighlighting on Text components with onPress" #24529

Closed

OSBotify mentioned this pull request Aug 14, 2023

Deploy Checklist: New Expensify 2023-08-14 #24550

Closed

49 tasks

lanitochka17 mentioned this pull request Aug 15, 2023

[HOLD for payment 2023-09-06] [$1000] Workspace - Highlight on text is displayed when email is pressed in Bills screen #24591

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

suppressHighlighting on Text components with onPress #24244

suppressHighlighting on Text components with onPress #24244

c3024 commented Aug 8, 2023 •

edited

Loading

melvin-bot bot commented Aug 8, 2023

c3024 commented Aug 8, 2023

abdulrahuman5196 Aug 8, 2023

c3024 Aug 9, 2023

abdulrahuman5196 Aug 8, 2023

c3024 Aug 9, 2023

abdulrahuman5196 commented Aug 8, 2023 •

edited

Loading

c3024 commented Aug 9, 2023

abdulrahuman5196 commented Aug 9, 2023

c3024 commented Aug 9, 2023

danieldoglas commented Aug 9, 2023

c3024 commented Aug 10, 2023

abdulrahuman5196 commented Aug 11, 2023

c3024 commented Aug 11, 2023

c3024 commented Aug 13, 2023

abdulrahuman5196 commented Aug 13, 2023 •

edited

Loading

abdulrahuman5196 left a comment

OSBotify commented Aug 14, 2023

OSBotify commented Aug 14, 2023

OSBotify commented Aug 17, 2023

suppressHighlighting on Text components with onPress #24244

suppressHighlighting on Text components with onPress #24244

Conversation

c3024 commented Aug 8, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 8, 2023

c3024 commented Aug 8, 2023

abdulrahuman5196 Aug 8, 2023

Choose a reason for hiding this comment

c3024 Aug 9, 2023

Choose a reason for hiding this comment

abdulrahuman5196 Aug 8, 2023

Choose a reason for hiding this comment

c3024 Aug 9, 2023

Choose a reason for hiding this comment

abdulrahuman5196 commented Aug 8, 2023 • edited Loading

c3024 commented Aug 9, 2023

abdulrahuman5196 commented Aug 9, 2023

c3024 commented Aug 9, 2023

danieldoglas commented Aug 9, 2023

c3024 commented Aug 10, 2023

abdulrahuman5196 commented Aug 11, 2023

c3024 commented Aug 11, 2023

c3024 commented Aug 13, 2023

abdulrahuman5196 commented Aug 13, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 14, 2023

OSBotify commented Aug 14, 2023

OSBotify commented Aug 17, 2023

c3024 commented Aug 8, 2023 •

edited

Loading

abdulrahuman5196 commented Aug 8, 2023 •

edited

Loading

abdulrahuman5196 commented Aug 13, 2023 •

edited

Loading