Skip to content

fix(perf): turn off legacy image swiping behaviour #1006

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vishalnarkhede merged 1 commit into from
Nov 17, 2021
Merged

fix(perf): turn off legacy image swiping behaviour #1006

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions ...n-content/core-components/channel/props/legacy_image_viewer_swipe_behaviour.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,9 @@

Enables/disables the legacy image viewer behavior.

By default, when you open (press) an image attachment it opens the image in a full-screen image viewer.
Within the viewer, you can keep swiping left to scroll through all the images that have been loaded within a channel so far.
This creates quite a lot of extra work for the JS thread to keep track of image attachments loaded in a channel and pre-populating them in the viewer for smooth transitions.

For performance reason, you can switch to an alternate UX for the image viewer where image attachments are only loaded for the selected messages in a viewer,
by setting this prop to false.
When true, within the image viewer you can keep swiping left to scroll through all the images that have been loaded within a channel so far.
Beaware that this creates quite a lot of extra work for the JS thread to keep track of image attachments loaded in a channel and pre-populating them in the viewer for smooth transitions.

| Type | Default |
| - | - |
| boolean | true |
| boolean | false |
3 changes: 1 addition & 2 deletions package/src/components/Channel/Channel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,8 +466,7 @@ const ChannelWithContext = <
keyboardBehavior,
KeyboardCompatibleView = KeyboardCompatibleViewDefault,
keyboardVerticalOffset,
// TODO[major]: switch to false.
legacyImageViewerSwipeBehaviour = true,
legacyImageViewerSwipeBehaviour = false,
LoadingErrorIndicator = LoadingErrorIndicatorDefault,
LoadingIndicator = LoadingIndicatorDefault,
loadingMore: loadingMoreProp,
Expand Down