Resize and automatically hide attachment carousel arrows #17269
Conversation
melvin-bot
bot
requested review from
Beamanator and
parasharrajat
and removed request for
a team
|
@Beamanator @parasharrajat One of you needs to 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] |
|
PR is ready @parasharrajat. Because automatically hide arrows is only available on mobile, I don't know what test steps to write that QA can verify the resized arrow for both Desktop/Web. I want to write "verify the arrows size are smaller then the current arrows", but it sounds confusing, so I just write a test step for mobile. Here is how it looks on resized desktop when the attachment is hovered. |
src/styles/styles.js
Outdated
| }, | ||
|
|
||
| arrowIcon: { | ||
| height: 52, | ||
| width: 52, | ||
| height: 42, |
There was a problem hiding this comment.
Can you show me images for 40 px and 44 px? It should be a multiple of 4.
What is your take on this? |
|
size 40 size 44 I personally prefer 40, but you can see the arrow is misaligned. To solve it, we can apply this style: We want to clear the padding that comes from 40 after correcting the alignment style
On desktop/web, we need to resize it very small which I think real user won't use the app with the small window. |
|
Ok, let's do 40 then. |
|
updated |
|
Auto-hide does not seem to provide the best UX.
|
|
For 2, I think we need to reset the timer when the button is clicked. |
| @@ -56,6 +56,7 @@ class AttachmentCarousel extends React.Component { | |||
|
|
|||
| componentDidMount() { | |||
| this.makeStateWithReports(); | |||
| this.scheduleHideArrow(); | |||
There was a problem hiding this comment.
I think it's already pretty clear that we want to automatically hide the arrow when the component mounts. Adding a comment feels redundant to me.
Solved when the user long press. I don't get the hovering part. The auto hide arrow is only for mobile screen, so we can't hover over it, except when we use emulator.
Solved.
Do you mean a different style for web? I also thinks the arrow is really near the edge in web/desktop. |
Yes. Testing in some time. |
|
@bernhardoj Can you please merge main into this? |
|
done! |
|
BUG: mWEB: It takes two clicks to see the arrow buttons after autoHide. Steps:
screen-2023-04-13_23.46.57.mp4BUG: mweb: Even if arrows are hidden clicking on their position triggers image navigation. Steps:
screen-2023-04-13_23.50.43.mp4 |
Screenshots🔲 iOS / native🔲 iOS / Safari🔲 MacOS / Desktop🔲 MacOS / Chrome
🔲 Android / Chrome🔲 Android / native |
I found that
I can't reproduce this issue. Can you test again? Maybe it will be resolved after the new changes. EDIT: diff --git a/src/components/AttachmentCarousel/index.js b/src/components/AttachmentCarousel/index.js
index 17b505b3f2..3e2fe1a445 100644
--- a/src/components/AttachmentCarousel/index.js
+++ b/src/components/AttachmentCarousel/index.js
@@ -44,14 +44,13 @@ class AttachmentCarousel extends React.Component {
constructor(props) {
super(props);
- this.canUseTouchScreen = DeviceCapabilities.canUseTouchScreen();
this.cycleThroughAttachments = this.cycleThroughAttachments.bind(this);
this.autoHideArrow = this.autoHideArrow.bind(this);
this.cancelAutoHideArrow = this.cancelAutoHideArrow.bind(this);
this.state = {
source: this.props.source,
- shouldShowArrow: this.canUseTouchScreen,
+ shouldShowArrow: DeviceCapabilities.canUseTouchScreen(),
isForwardDisabled: true,
isBackDisabled: true,
};
@@ -92,7 +91,7 @@ class AttachmentCarousel extends React.Component {
* if there is no interaction for 3 seconds.
*/
autoHideArrow() {
- if (!this.canUseTouchScreen) {
+ if (!DeviceCapabilities.canUseTouchScreen()) {
return;
}
this.cancelAutoHideArrow();
@@ -190,11 +189,12 @@ class AttachmentCarousel extends React.Component {
render() {
const isPageSet = Number.isInteger(this.state.page);
const authSource = addEncryptedAuthTokenToURL(this.state.source);
+ const canUseTouchScreen = DeviceCapabilities.canUseTouchScreen();
return (
<View
style={[styles.attachmentModalArrowsContainer]}
- onMouseEnter={() => !this.canUseTouchScreen && this.toggleArrowsVisibility(true)}
- onMouseLeave={() => !this.canUseTouchScreen && this.toggleArrowsVisibility(false)}
+ onMouseEnter={() => !canUseTouchScreen && this.toggleArrowsVisibility(true)}
+ onMouseLeave={() => !canUseTouchScreen && this.toggleArrowsVisibility(false)}
>
{(isPageSet && this.state.shouldShowArrow) && (
<>
@@ -252,7 +252,7 @@ class AttachmentCarousel extends React.Component {
styles={[styles.attachmentModalArrowsContainer]}
canSwipeLeft={!this.state.isBackDisabled}
canSwipeRight={!this.state.isForwardDisabled}
- onPress={() => this.canUseTouchScreen && this.toggleArrowsVisibility(!this.state.shouldShowArrow)}
+ onPress={() => canUseTouchScreen && this.toggleArrowsVisibility(!this.state.shouldShowArrow)}
onCycleThroughAttachments={this.cycleThroughAttachments}
>
<AttachmentView
What do you think? @parasharrajat |
|
Conflict solved! Don't forget to take a look at this one @parasharrajat Btw, I think we can ignore my comment #17269 (comment) for now because looks like we are planning to change canUseTouchScreen to hasHoverSupport based on the concern here #15988 (comment) |
| this.setState((current) => { | ||
| const newShouldShowArrow = !_.isUndefined(shouldShowArrow) ? shouldShowArrow : !current.shouldShowArrow; | ||
| return {shouldShowArrow: newShouldShowArrow}; | ||
| }, () => { |
There was a problem hiding this comment.
I didn't understand this part. Why are we checking the _.isUndefined(shouldShowArrow) when this is a required param?
There was a problem hiding this comment.
In renderCell, there is a Pressable which will toggle the value based on the previous value.
There was a problem hiding this comment.
For context, previously, the onPress logic is
toggleArrowsVisibility(!this.state.shouldShowArrow)
then by this PR #16973, the logic changes to
this.setState(current => ({shouldShowArrow: !current.shouldShowArrow}))
There was a problem hiding this comment.
Was it causing issues or why did you change it back?
There was a problem hiding this comment.
We call the auto hide arrow inside toggleArrowsVisibility. Because we set the state manually (this.setState(current => ({shouldShowArrow: !current.shouldShowArrow}))), the arrow never auto hide and I think we will be repeating the logic to show/hide the arrow inside the setState callback
There was a problem hiding this comment.
Sorry, I don't quite understand your comment.
We call autoHide/cancelAutoHide inside the setState callback of toggleArrowVisibility. If we manually set the state of shouldShowArrow (this.setState(current => ({shouldShowArrow: !current.shouldShowArrow}))), we should repeat the same callback logic, which is to call autoHide/cancelAutoHide. To prevent repeating the same code, this changes is made.
So, toggleArrowVisiblity now can accept empty parameter to literally toggle it.
There was a problem hiding this comment.
I am not able to imagine the difference between both but IMO his.setState(current => ({shouldShowArrow: !current.shouldShowArrow})) is better for calls where the user can take the action multiple times and we want to remember all the actions and update their states in sequence.
If we just pass this.setState({something: static value}) it will be called with the old state when the user clicks multiple times very quickly. These state updates will be batched.
There was a problem hiding this comment.
Yes, that's why if we pass nothing to toggleArrowVisibility, we set the value based on the previous state.
There was a problem hiding this comment.
Just fixed the conflict. Regarding your concern, another PR did the same approach. I think you can reread the diff to help answering any concern.
There was a problem hiding this comment.
No, worries. It was hard for me to imagine this.
|
Bump on here too @parasharrajat |
| onPressIn={this.cancelAutoHideArrow} | ||
| onPressOut={this.autoHideArrow} |
There was a problem hiding this comment.
What is the purpose for these?
There was a problem hiding this comment.
It is to fix the first 2 issues here #17269 (comment)
Screenshots🔲 iOS / nativeScreen.Recording.2023-04-26.at.8.50.11.PM.mov🔲 iOS / SafariScreen.Recording.2023-04-26.at.8.37.58.PM.mov🔲 MacOS / DesktopScreen.Recording.2023-04-26.at.9.07.30.PM.mov🔲 MacOS / ChromeScreen.Recording.2023-04-26.at.6.59.37.PM.mov🔲 Android / ChromeScreen.Recording.2023-04-26.at.6.58.35.PM.mov🔲 Android / nativeScreen.Recording.2023-04-26.at.8.49.16.PM.mov |
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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.
toggleReportand notonIconClick). - 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 Copylabel 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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
Avataris modified, I verified thatAvataris 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
ScrollViewcomponent to make it scrollable when more elements are added to the page. - If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
cc: @Beamanator
🎀 👀 🎀 C+ reviewed
|
Awaiting merge @Beamanator |
|
@parasharrajat looks like you may have to update your review checklist w/ the latest checklist please 🙏 |
|
@Beamanator done. |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to staging by https://github.com/Beamanator in version: 1.3.8-0 🚀
|
|
🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.8-8 🚀
|
Details
Resized the attachment carousel arrows smaller and will automatically hide if there is no interactions.
Fixed Issues
$ #15896
PROPOSAL: #15896 (comment)
Tests
Same as QA Steps
Offline tests
Same as QA Steps
QA Steps
Android/iOS/mWeb
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)src/languages/*files and using the translation methodWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)/** comment above it */thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor)thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Web
Mobile Web - Chrome
Screen.Recording.2023-04-13.at.12.42.05.mov
Mobile Web - Safari
Screen.Recording.2023-04-13.at.12.38.37.mov
Desktop
iOS
Android
Screen.Recording.2023-04-13.at.12.45.01.mov