Skip to content

[docs] Rename callback and update migration guide#3951

Merged
m-bert merged 4 commits intonextfrom
@mbert/docs-migration-guide-v2
Feb 5, 2026
Merged

[docs] Rename callback and update migration guide#3951
m-bert merged 4 commits intonextfrom
@mbert/docs-migration-guide-v2

Conversation

@m-bert
Copy link
Copy Markdown
Collaborator

@m-bert m-bert commented Feb 4, 2026

Description

This PR does two things:

  1. Renames onTouchesCancelled callback to onTouchesCancel
  2. Adds few information to migration guide:
    2.1. Added information that onChange was removed
    2.2. Added information about removed state, oldState
    2.3. Added information about unified callback events types.

Test plan

Read docs 🤓

Copilot AI review requested due to automatic review settings February 4, 2026 12:15

### onChange

We decided to simplify API by removing `onChange` callback. You can now access `change*` properties in `onUpdate` callback.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We decided to simplify API by removing `onChange` callback. You can now access `change*` properties in `onUpdate` callback.
`onChange` callback has been removed, and its functionality integrated into `onUpdate`. You can now access `change*` properties in `onUpdate` callback.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the documentation to reflect API changes in Gesture Handler 3, specifically renaming the onTouchesCancelled callback to onTouchesCancel and adding comprehensive migration guidance for removed features.

Changes:

  • Renames onTouchesCancelled to onTouchesCancel across v3 documentation to match the v3 API implementation
  • Adds migration guide sections explaining the removal of onChange callback, state/oldState properties, and the unification of event types

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
packages/docs-gesture-handler/src/examples/CallbacksFlowCharts/TouchEventChart.jsx Updates callback name in the touch event flow chart
packages/docs-gesture-handler/docs/guides/upgrading-to-3.mdx Adds three new sections documenting removed onChange callback, removed state properties, and unified event types
packages/docs-gesture-handler/docs/gestures/use-manual-gesture.mdx Updates callback reference in manual gesture tutorial
packages/docs-gesture-handler/docs/fundamentals/callbacks-events.mdx Updates callback name and signature in API reference

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread packages/docs-gesture-handler/docs/guides/upgrading-to-3.mdx
@m-bert
Copy link
Copy Markdown
Collaborator Author

m-bert commented Feb 4, 2026

I've also noticed that I have not added onTouchesCancel change into "Renamed callbacks" section. Done in ceff49c

@m-bert m-bert merged commit 599b47c into next Feb 5, 2026
1 check passed
@m-bert m-bert deleted the @mbert/docs-migration-guide-v2 branch February 5, 2026 09:15
@m-bert m-bert added the Documentation Documentation change/enhancement label Feb 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Documentation change/enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants