-
-
Notifications
You must be signed in to change notification settings - Fork 1k
[docs] State management #3905
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?
[docs] State management #3905
Conversation
…re.mdx Co-authored-by: Jakub Piasecki <[email protected]>
Co-authored-by: Jakub Piasecki <[email protected]>
…on/react-native-gesture-handler into @mbert/docs-state-manager
…eractions.mdx Co-authored-by: Jakub Piasecki <[email protected]>
…eractions.mdx Co-authored-by: Jakub Piasecki <[email protected]>
packages/docs-gesture-handler/docs/fundamentals/callbacks-events.mdx
Outdated
Show resolved
Hide resolved
packages/docs-gesture-handler/src/examples/CallbacksFlowCharts/TouchEventChart.jsx
Show resolved
Hide resolved
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
Updates the React Native Gesture Handler documentation to better explain gesture state management by shifting focus from raw states/events to callback-driven lifecycle descriptions, and consolidating manual gesture guidance.
Changes:
- Reworks state-related docs by moving handler state details under “under the hood” and introducing a new “callbacks & events” fundamentals page.
- Moves/rewrites
GestureStateManagerdocs into fundamentals and updates references accordingly. - Adds interactive callback flow charts (via
vis-network) and consolidates the manual gesture guide into the Manual gesture docs page.
Reviewed changes
Copilot reviewed 35 out of 37 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/react-native-gesture-handler/apple/RNGestureHandlerDetector.mm | Whitespace cleanup. |
| packages/docs-gesture-handler/yarn.lock | Adds lock entry for new docs dependency. |
| packages/docs-gesture-handler/src/theme/MDXComponents/Details.js | Adjusts summary detection logic for MDX <summary>. |
| packages/docs-gesture-handler/src/examples/CallbacksFlowCharts/index.ts | Exposes new callback flow chart components. |
| packages/docs-gesture-handler/src/examples/CallbacksFlowCharts/TouchEventChart.jsx | Adds touch callback flow chart node/edge data. |
| packages/docs-gesture-handler/src/examples/CallbacksFlowCharts/GestureEventChart.jsx | Adds gesture callback flow chart node/edge data. |
| packages/docs-gesture-handler/src/examples/CallbacksFlowCharts/FlowChart.jsx | Renders charts using vis-network. |
| packages/docs-gesture-handler/package.json | Adds vis-network dependency for charts. |
| packages/docs-gesture-handler/docs/under-the-hood/state.md | Rewrites handler state documentation as a callback-focused table. |
| packages/docs-gesture-handler/docs/guides/troubleshooting.md | Removes troubleshooting section about automatic workletization (now covered elsewhere). |
| packages/docs-gesture-handler/docs/guides/manual-gestures/index.md | Removes the standalone manual gestures guide (content moved/merged). |
| packages/docs-gesture-handler/docs/guides/manual-gestures/_steps/step7.md | Removes old manual-gestures step content. |
| packages/docs-gesture-handler/docs/guides/manual-gestures/_steps/step6.md | Removes old manual-gestures step content. |
| packages/docs-gesture-handler/docs/guides/manual-gestures/_steps/step5.md | Removes old manual-gestures step content. |
| packages/docs-gesture-handler/docs/guides/manual-gestures/_steps/step4.md | Removes old manual-gestures step content. |
| packages/docs-gesture-handler/docs/guides/manual-gestures/_steps/step3.md | Removes old manual-gestures step content. |
| packages/docs-gesture-handler/docs/gestures/use-tap-gesture.mdx | Removes links to removed states/events page; simplifies wording. |
| packages/docs-gesture-handler/docs/gestures/use-rotation-gesture.mdx | Updates activation wording and removes states/events deep links. |
| packages/docs-gesture-handler/docs/gestures/use-pinch-gesture.mdx | Updates activation wording and removes states/events deep links. |
| packages/docs-gesture-handler/docs/gestures/use-pan-gesture.mdx | Removes states/events deep links and updates wording. |
| packages/docs-gesture-handler/docs/gestures/use-native-gesture.mdx | Simplifies state-based phrasing around activation/interruption. |
| packages/docs-gesture-handler/docs/gestures/use-manual-gesture.mdx | Merges manual gesture guide into Manual gesture docs and updates state-manager link. |
| packages/docs-gesture-handler/docs/gestures/use-long-press-gesture.mdx | Removes states/events deep links; simplifies wording. |
| packages/docs-gesture-handler/docs/gestures/use-fling-gesture.mdx | Removes states/events deep links; simplifies wording. |
| packages/docs-gesture-handler/docs/gestures/state-manager.md | Removes old Gesture state manager page (moved to fundamentals). |
| packages/docs-gesture-handler/docs/gestures/_shared/base-gesture-config.md | Rewords state-based config descriptions to callback/behavior language. |
| packages/docs-gesture-handler/docs/gestures/_shared/base-continuous-gesture-config.md | Updates state manager link to new fundamentals location. |
| packages/docs-gesture-handler/docs/gestures/_manual_gesture_steps/step7.md | Adds new manual gesture step snippet for activation/deactivation callbacks. |
| packages/docs-gesture-handler/docs/gestures/_manual_gesture_steps/step6.md | Adds new manual gesture step snippet for onTouchesUp handling. |
| packages/docs-gesture-handler/docs/gestures/_manual_gesture_steps/step5.md | Adds new manual gesture step snippet for onTouchesMove handling. |
| packages/docs-gesture-handler/docs/gestures/_manual_gesture_steps/step4.md | Adds new manual gesture step snippet for onTouchesDown handling. |
| packages/docs-gesture-handler/docs/gestures/_manual_gesture_steps/step3.md | Adds new manual gesture step snippet for wiring up pointers + detector. |
| packages/docs-gesture-handler/docs/gestures/_manual_gesture_steps/step2.md | Refactors the pointer component snippet to typed TS style. |
| packages/docs-gesture-handler/docs/gestures/_manual_gesture_steps/step1.md | Refactors pointer type snippet to TS type. |
| packages/docs-gesture-handler/docs/fundamentals/states-events.mdx | Removes old states & events fundamentals page. |
| packages/docs-gesture-handler/docs/fundamentals/state-manager.mdx | Adds new fundamentals page documenting GestureStateManager. |
| packages/docs-gesture-handler/docs/fundamentals/callbacks-events.mdx | Adds new fundamentals page describing callbacks/events + flow charts. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
packages/docs-gesture-handler/docs/gestures/_manual_gesture_steps/step7.md
Show resolved
Hide resolved
packages/docs-gesture-handler/docs/fundamentals/state-manager.mdx
Outdated
Show resolved
Hide resolved
packages/docs-gesture-handler/docs/fundamentals/state-manager.mdx
Outdated
Show resolved
Hide resolved
packages/docs-gesture-handler/docs/fundamentals/callbacks-events.mdx
Outdated
Show resolved
Hide resolved
packages/docs-gesture-handler/docs/fundamentals/callbacks-events.mdx
Outdated
Show resolved
Hide resolved
packages/docs-gesture-handler/src/examples/CallbacksFlowCharts/FlowChart.jsx
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <[email protected]>
Description
This PR handles state management in our docs:
GestureStateManagerentry and moves it to fundamentalsTest plan
Read docs 🤓