-
-
Notifications
You must be signed in to change notification settings - Fork 1k
[docs] Rename callback and update migration guide #3951
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.
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
base: next
Are you sure you want to change the base?
Conversation
|
|
||
| ### onChange | ||
|
|
||
| We decided to simplify API by removing `onChange` callback. You can now access `change*` properties in `onUpdate` callback. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this 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
onTouchesCancelledtoonTouchesCancelacross v3 documentation to match the v3 API implementation - Adds migration guide sections explaining the removal of
onChangecallback,state/oldStateproperties, 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.
|
I've also noticed that I have not added |
Description
This PR does two things:
onTouchesCancelledcallback toonTouchesCancel2.1. Added information that
onChangewas removed2.2. Added information about removed
state,oldState2.3. Added information about unified callback events types.
Test plan
Read docs 🤓