[RNMobile] Add useScrollWhenDragging hook
#39705
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fluiddot
added
the
Mobile App - i.e. Android or iOS
fluiddot
changed the base branch from
rnmobile/feature/drag-and-drop
to
rnmobile/feature/drag-and-drop-block-draggable-component
|
Size Change: 0 B Total Size: 1.21 MB ℹ️ View Unchanged
|
fluiddot
force-pushed
the
rnmobile/feature/drag-and-drop-block-draggable-component
branch
from
ff1b9dd to
2bd4e66
Compare
fluiddot
force-pushed
the
rnmobile/feature/drag-and-drop-use-scroll-when-dragging
branch
from
a362614 to
f6e091a
Compare
fluiddot
commented
Mar 24, 2022
Comment on lines
+77
to
+106
|
|
||
| draggingScrollHandler( event ); |
There was a problem hiding this comment.
useScrollWhenDragging hook also needs to listen to scroll events, hence we connect its scroll handler with the one defined in BlockDraggable.
| scrollAnimation.value = withTiming( | ||
| scrollOffsetTarget, | ||
| { duration: SCROLL_ANIMATION_DURATION }, | ||
| () => startScrolling( position.y ) |
There was a problem hiding this comment.
In case we need to animate the scroll because the block is out of scroll view, we'll only notify the hook about starting scrolling once the animation finishes.
Comment on lines
+65
to
+82
| animationTimer.value = 0; | ||
| animationTimer.value = withRepeat( | ||
| withTiming( 1, { | ||
| duration: SCROLL_INTERVAL_MS, | ||
| easing: Easing.linear, | ||
| } ), | ||
| -1, | ||
| true | ||
| ); |
There was a problem hiding this comment.
The scroll animation needs to be running indefinitely until the drag gesture ends. For this reason, and in order of animating the scroll with Reanimated, we create a timer that repeats forever and animates animationTimer value from 0 to 1 every 1 second and in reverser, from 1 to 0.
This timer is used below in useAnimatedReaction block for calculating the offset to be increased on every frame.
Comment on lines
+79
to
+91
| const dragDistance = Math.max( | ||
| Math.abs( y - dragStartY.value ) - SCROLL_INACTIVE_DISTANCE_PX, | ||
| 0 | ||
| ); |
There was a problem hiding this comment.
The scroll is only animated if we drag the block beyond a threshold (i.e. SCROLL_INACTIVE_DISTANCE_PX constant).
| Math.abs( y - dragStartY.value ) - SCROLL_INACTIVE_DISTANCE_PX, | ||
| 0 | ||
| ); | ||
| const distancePercentage = dragDistance / windowHeight; |
There was a problem hiding this comment.
This percentage is used for increasing the scroll velocity depending on the distance between the drag starting position and the current drag position.
Comment on lines
+105
to
+115
| const delta = Math.abs( value - previous ); | ||
| let newOffset = offsetY.value + delta * velocityY.value; |
There was a problem hiding this comment.
The scroll is updated by calling Reanimated's scrollTo function, which prompts for the absolute scroll offset. In this case, we calculate the offset by adding to the current offset the pixels that have been moved on each frame (i.e. delta * scroll velocity).
| const startScrolling = ( y ) => { | ||
| 'worklet'; | ||
| stopScrolling(); | ||
| offsetY.value = scroll.offsetY.value; |
There was a problem hiding this comment.
Since the scroll animation requires providing the absolute offset, we have to get the initial offset at the time the dragging starts. This way we can make the offset calculations using the initial offset.
|
|
||
| const SCROLL_INACTIVE_DISTANCE_PX = 50; | ||
| const SCROLL_INTERVAL_MS = 1000; | ||
| const VELOCITY_MULTIPLIER = 5000; |
There was a problem hiding this comment.
If needed, we could tweak this value to increase the acceleration of the scroll velocity.
fluiddot
force-pushed
the
rnmobile/feature/drag-and-drop-use-scroll-when-dragging
branch
2 times, most recently
from
661c350 to
d224185
Compare
geriux
reviewed
Mar 29, 2022
packages/block-editor/src/components/block-draggable/use-scroll-when-dragging.native.js
Outdated
Show resolved
Hide resolved
Thanks for the review @geriux ❤️ ! I've just addressed the comment so the PR is ready for another review, thanks 🙇 . |
geriux
approved these changes
Mar 29, 2022
Base automatically changed from
rnmobile/feature/drag-and-drop-block-draggable-component
to
rnmobile/feature/drag-and-drop
March 30, 2022 08:27
fluiddot
added
the
[Feature] Drag and Drop
fluiddot
force-pushed
the
rnmobile/feature/drag-and-drop-use-scroll-when-dragging
branch
from
440217c to
e4e8030
Compare
fluiddot
deleted the
rnmobile/feature/drag-and-drop-use-scroll-when-dragging
branch
fluiddot
added a commit
that referenced
this pull request
May 11, 2022
* [Mobile] - Drag & drop blocks - Fetch and share blocks layout size and position coordinates (#39089) * Mobile - Block list - Extract block list context into a separate file and add support to store the blocks layouts data and coordinates. * Mobile - Block list - Adds block list item cell to get the onLayout data and use updateBlocksLayouts to store it. It is needed to use CellRendererComponent to be able to get the right position coordinates * Mobile - Block list - Store block layouts data for inner blocks in a deep level * Mobile - BlockList ItemCell - Destructuring props * Mobile - BlockListContext - Rename findByRootId to findBlockLayoutByClientId * Mobile - BlockListContext - Rename deleteByClientId to deleteBlockLayoutByClientId * Mobile - BlockListContext - Store default context and use it for initialization * Mobile - BlockListContext - Add param's docs * Mobile - Block list context - Export findBlockLayoutByClientId * Mobile - Block list context - Update comments * Mobile - Block list context - Unit tests * Mobile - Block list context - update unit tests * [Mobile] - Draggable component (#39551) * Mobile - Add Draggable component * Mobile - Draggable - Fix composition of gestures, enable Pan gesture once LongPress is recognized * Mobile - Draggable component - Track if the gesture Pan started, if it didn't and long pressure was activated it should call onDragEnd * Mobile - Draggable component - Add props documentation * Mobile - Draggable component - Update documentation * Mobile - Draggable component - Refactor that includes: - Usage of only one onEnd callback for both gestures. - Removes the hasPanStarted value since the onEnd callback is unified - Adds shouldCancelWhenOutside for the Pan gesture. - Removes the simultaneousWithExternalGesture since the Pan gesture is manually activated and composed with the LongPress gesture. - Add isIOS check within onTouchesMove for the state.fail() call. * Mobile - Draggable component - Use Platform from @wordpress/element * [RNMobile] `BlockDraggable` component (#39617) * Use animated scroll handler in KeyboardAwareFlatList * Add hook for scrolling the block list while dragging * Improve scroll animation in useScrollWhenDragging * Add draggable chip component * Add block draggable component * Remove icon prop from draggable chip component * Add draggable placeholder * Fix draggable chip location * Wrap BlockListItemCell with BlockDraggable * Fix block draggable placeholder style * Animate scale property instead of opacity of draggable chip * Fix draggable placeholder container height calculation * Fix BlockDraggable height animation * Move draggable to BlockDraggableWrapper * Disable isDragging when long-press gesture ends * Fix onLayout calculation in block list item cell * Add findBlockLayoutByPosition helper * Set up dragging block by position * Remove animate scroll velocity * Remove useScrollWhenDragging hook This hook will be introduced in a separate PR * Remove react-native-reanimated mock * Rename CHIP_OFFSET_TO_TOUCH_POSITION constant * Remove unused shared values of chip component * Stop dragging when no block is found * Fix drag position calculation * Update html text input styles * Unify container component within html text input * Use only a single client id in block draggable * Add documentation to block draggable components * Add documentation to block draggable chip component * Add documentation to findBlockLayoutByPosition * Update scrollOffsetTarget calculation * Fix typos in block draggable * Add draggable wrapper container style * Add dark mode styles for draggable chip * Add dark mode styles for block draggable * Get container height from blocks layout data * Replace inline callback functions with useCallback hook * Update collapse/expand animation when dragging a block * Force draggable chip to be displayed upfront * Remove refs from dependencies arrays References can be omitted from the dependencies arrays since React guarantees that they are inmutable. * [RNMobile] Add `useScrollWhenDragging` hook (#39705) * Introduce useScrollWhenDragging hook * Cancel animation timer on stop scrolling * Add documentation to useScrollWhenDragging hook * Replace Dimensions with useWindowDimensions hook * [RNMobile] Prevent draggable gesture when any text input is focused (#39890) * [Mobile] Adds useBlockDropZone and DroppingInsertionPoint (#39891) * Adds useBlockDropZone and DroppingInsertionPoint * Fix dropping insertion point position when scrolling * Mobile - DroppingInsertionPoint - Fixes: - Avoid showing the indicator when no blocks are being dragged. - Allow showing the dropping indicator at the end of the content. - Prevent checks within useState for isBlockBeingDragged, if no blocks are being dragged. - Prevent looking for a block layout if the clientId is undefined. * Mobile - DroppingInsertionPoint - Add documentation * Mobile - useBlockDropZone - Add documentation * Mobile - useBlockDropZone - Add missing dependencies * Mobile - Block list context - Updates getBlockLayoutsOrderedByYCoord to make it compatible with hermes, currently it doesn't support using the native .sort. It also adds documentation of the function. * Mobile - Updates: useBlockDropZone: - Avoid using showInsertionPoint to avoid re-renders and bad performance. - Passes the current target index as a shared value to pass it to DroppingInsertionPoint. DroppingInsertionPoint: - Detects when targetBlockIndex changes from the dragging animation to update the indicator's position. - Fixes an issue where the last element couldn't be reached. * Mobile - Block list - Revert changes for the insertion point checks * Mobile - Updates documentation: - BlockListContext: Some typos and clarifications. - DroppingInsertionPoint: Update component description. - useBlockDropZone: Update comments. * Mobile - DroppingInsertionPoint - Remove usage of useCallback * Mobile - DroppingInsertionPoint - Remove static styles from useAnimatedStyles and merge both in a separate constant. * Mobile - DroppingInsertionPoint - Move component to the BlockDraggable folder, which is where it's rendered from. * Mobile - DroppingInsertionPoint - Remove usage of hasStartedDraggingOver in favor of isDragging. * Mobile - DroppingInsertionPoint - Remove unneeded braces. Co-authored-by: Carlos Garcia <fluiddot@gmail.com> * [RNMobile] Add `useOnBlockDrop` hook to update blocks order when dropping a block (#39884) * Add useOnBlockDrop hook * Add currentClientId ref to block draggable * Add onBlockDrop to block drop zone hook * Trigger onBlockDrop event when dragging finishes * Fix content overflow when dragging a selected block * [RNMobile] Update drag & drop animations (#40104) * Update drag&drop block animation * Keep block layout data instead of clientId in block draggable * Automatically select the dropped block * Delay opacity animation when dropping a block * Check current client Id existence on stop dragging * [RNMobile] Disable text editing when long-pressing a block in favor of drag & drop gesture (#40101) * Reduce default min duration for long-press gesture * Consume long click event on Android if Aztec text input is not focused * Ensure that drag events are not executed when text input focused * Replace onLongPress with long-press gesture handler in Button component * Use LongPressGestureHandler in button component * Update block-mover snapshots * [RNMobile] Refactor draggable logic and introduce `DraggableTrigger` component (#40406) * Present block mover picker only after state updates * Refactor draggable component * Use DraggableTrigger in BlockDraggable * Move BlockDraggable render to BlockListBlock component * Fix long-press gesture when editing a text on iOS * Memoize draggable provider value to prevent re-renders * Fix dragging not being disabled after scrolling * Reduce calls to event handlers of pan and long-press gestures * Prevent onDragEnd event to be called upon mounting * Add DEFAULT_IOS_LONG_PRESS_MIN_DURATION constant * [RNMobile] Update animation of drag & drop chip component (#40409) * Use layout animations when rendering the chip component Additionally, the block icon is now provided from the BlockDraggable component. * Fix chip layout calculation * Set block icon as state value * Update enter/exit animation duration of chip component * Mobile - DroppingInsertionPoint - Update indicator position for selected blocks (#40510) * Mobile - DroppingInsertionPoint - Update the indicator's position for the current selected block for both top and bottom positions depending on the current position when dragging. * Replace parseInt to Math.floor * [RNMobile] Add haptic feedback to drag & drop feature (#40423) * Add generate haptic feedback function into RN bridge * Add haptic feedback to drag & drop * Reduce haptic feedback intensity on iOS * [RNMobile] Fix issues related to editing text and dragging gesture (#40480) * Add input state functionality to Aztec * Control drag enabling with Aztec input state * Force disabling text editing when dragging * Add documentation to AztecInputState * Update changelog * Add tests for Aztec input state * Update focus change listener logic * Update listen to focus change event test * Fix react-native-aztec module mock * Fix wrong call to removeFocusChangeListener * Fix updating currentFocusedElement value * Check if an inner block is selected when enabling dragging * Wrap draggable long-press handler with useCallback * Add documentation to notifyListeners function * Mobile - Draggable - Disable multiple touches (#40519) * Mobile - Draggable - Disable multiple touches by getting the first touch during onTouchesMove, since using the maxPointers config works unexpectedly on Android. * Mobile - Draggable - Order touch events by ID and use the first element * Pass isPanActive to the LongPress onEnd callback to not update the isDragging flag when the panning event is active * Mobile - Draggable - Store the first touch ID instead of picking the first event within the allTouches event array. * Mobile - DroppingInsertionPoint - Hide indicator when it overflows outside the content (#40658) * Mobile - Provider - Adds SafeAreaProvider * Mobile - DroppingInsertionPoint - Hide indicator if the current position overflows over the header or footer * Fix tests, adds react-native-safe-area-context mock * Mobile - DroppingInsertionPoint - Use the height value from the useSafeAreaFrame instead * Mobile - DroppingInsertionPoint - Update mocks * Mobile - Disable long press event in media blocks (#40651) * Mobile - Disable long press event in media blocks * Mobile - Media & Text - Remove extra param * Mobile - Media & Text - Show replace media button for both Image and video * Mobile - DraggingInsertionPoint - Prevent crash when accessing a null element (#40689) * Mobile - DraggingInsertionPoint - Fix crash when there's only one block in the editor, the previousElement is null. * Mobile - DroppingInsertionPoint - Avoid having NaN values * Mobile - Draggable - Add onTouchesCancelled to handle manually ending the drag & drop event in cases like sending the app to background or opening the notifications center on iOS (#40729) * [RNMobile] Fix Android crash when closing the editor while dragging (#40810) * Remove Reanimated transitive dependency on Android * Test Android crash fix by changing Reanimated version * Bump react-native-reanimated dependency version * Bump react-native-reanimated dependency on Android * Update package-lock.json file * Bump react-native-reanimated dependency version * Revert "Test Android crash fix by changing Reanimated version" This reverts commit d01cdae. * Mobile - AztecView - Trigger notifyInputChange on focus/blur (#40788) * Mobile - BlockDraggable - Set isEditingText to false and update it with the initialization of the AztecView listener * Mobile - AztecView - Move notifyInputChange to the focus/blur functions within AztecInputState, to fix an issue where these are called directly. * [RNMobile] Disable dragging when a screen reader is enabled (#40852) * [RNMobile] Allow dragging from block toolbar (#40886) * Enable dragging from block toolbar * Ensure root block is dragged for nested blocks * Add draggingClientId prop to BlockDraggable With this change the `BlockDraggable` component might receive two different client ids, one is the client id of the block where the component is rendered, and the other (which is optional) is used for identifying the block to be dragged. * Set dragging always enabled for block toolbar The block toolbar is only visible when the block is selected so it's safe to allow dragging in all cases, as it won't affect other UI elements. * Update dragging enabled calculation In order to prevent issues related to disabling the long-press gesture in elements within the block UI, the logic for enabling the dragging has been updated. Now it will enabled in the following cases: - The block doesn't have inner blocks. This applies to root blocks and nested blocks without further nested blocks. - Blocks with nested blocks if the block is selected. - Blocks with nested blocks if none of the nested blocks is selected. * Update Podfile.lock * Update react-native-editor changelog * Fix text block query locator in Android E2E tests * Fix Cover block E2E test * Fix Spacer block E2E test Co-authored-by: Gerardo Pacheco <gerardo.pacheco@automattic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
NOTE: This PR points to rnmobile/feature/drag-and-drop-block-draggable-component, once #39617 PR is merged, it should point to rnmobile/feature/drag-and-drop.
Closes wordpress-mobile/gutenberg-mobile#4673.
What?
Add
useScrollWhenDragginghook for allowing scroll when dragging a block.Why?
This hook is required for providing the drag & drop functionality for blocks, similarly as we have in the web version.
How?
This hook is used by the
BlockDraggablecomponent which notifies when the drag gesture starts and finishes. With this information and scroll events from the block list, it runs a timer that updates the scroll position via the Reanimated'sscrollTofunction. Similar to the web implementation, the scroll is controlled with a velocity value that increases by the distance between the touch position and the position where the drag started.Testing Instructions
Screenshots or screencast
RPReplay_Final1648127958.MP4
Screen_Recording_20220324-142124_Gutenberg.mp4