[Docs] Mention shouldCancelWhenOutside default in Native on Android#4242
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Gesture Handler documentation to correct the stated default for shouldCancelWhenOutside, clarifying that Native gestures (at least on Android) default to true, and it also performs some cleanup/formatting on shared 2.x docs fragments.
Changes:
- Update
shouldCancelWhenOutsidedefault documentation to includeNative(Android) alongsideLongPressandTap. - Reformat/normalize wording and punctuation across shared “base gesture” 2.x doc fragments.
- Adjust pointer type enum bullet formatting in the shared event data docs.
Reviewed changes
Copilot reviewed 11 out of 17 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/_shared/base-gesture-event-data.md | Formatting updates to the PointerType enum list. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/_shared/base-gesture-config.md | Updates shared config docs (including shouldCancelWhenOutside defaults). |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/_shared/base-gesture-callbacks.md | Minor wording edits in shared callback descriptions. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/_shared/base-continuous-gesture-config.md | Minor punctuation/grammar tweak in continuous gesture config docs. |
| packages/docs-gesture-handler/docs/gestures/_shared/base-gesture-config.mdx | Updates current (unversioned) shared config docs to mention Native default behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…ion/react-native-gesture-handler into @mbert/docs-native-android
j-piasecki
approved these changes
Jun 8, 2026
This file contains hidden or 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
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.
Description
Our docs incorrectly stated that onlu
LongPressandTapuseshouldCancelWhenOutsideset totrueby default. This is also the case forNativegesture on Android.I've also changed some of the legacy pages to symlinks, seems that it has been missed in previous PRs. If there were any differences (checked with
difftool), I've copied newer content fromlegacy-gesturesand then created symlink.Test plan
Read docs 🤓