Add state flow charts to Gesture Handler's documentation. #2817
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
(minimal copy of Reanimated docs)
|
Found some critical errors, please give me some more time before reviewing :/ |
|
we found some bugs with @m-bert which likely are a problem within the handlers themselves. |
…ftware-mansion/react-native-gesture-handler into @latekvo/docs_add_state_chart
m-bert
reviewed
Mar 27, 2024
patrycjakalinska
approved these changes
Apr 5, 2024
docs/src/components/InteractiveExample/InteractiveExampleComponent/index.tsx
Show resolved
Hide resolved
docs/src/components/InteractiveExample/InteractiveExampleComponent/index.tsx
Outdated
Show resolved
Hide resolved
Co-authored-by: Patrycja Kalińska <59940332+patrycjakalinska@users.noreply.github.com>
…ansion/react-native-gesture-handler into @latekvo/docs_add_state_chart
kacperkapusciak
approved these changes
Apr 5, 2024
This was referenced May 21, 2024
github-merge-queue bot
referenced
this pull request
in valora-inc/wallet
Jun 6, 2024
…5520) [](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [react-native-gesture-handler](https://togithub.com/software-mansion/react-native-gesture-handler) | [`^2.16.0` -> `^2.16.2`](https://renovatebot.com/diffs/npm/react-native-gesture-handler/2.16.0/2.16.2) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>software-mansion/react-native-gesture-handler (react-native-gesture-handler)</summary> ### [`v2.16.2`](https://togithub.com/software-mansion/react-native-gesture-handler/releases/tag/2.16.2) [Compare Source](https://togithub.com/software-mansion/react-native-gesture-handler/compare/2.16.1...2.16.2) ##### 🐛 Bug fixes - Revert "Change `.web` files to default and add `.native` ([#​2835](https://togithub.com/software-mansion/react-native-gesture-handler/issues/2835))" by [@​m-bert](https://togithub.com/m-bert) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2896](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2896) ##### 🔢 Miscellaneous - Add examples to Gestures section in docs by [@​xnameTM](https://togithub.com/xnameTM) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2876](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2876) - Fix missing styles in gestures' InteractiveExamples by [@​patrycjakalinska](https://togithub.com/patrycjakalinska) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2897](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2897) **Full Changelog**: software-mansion/react-native-gesture-handler@2.16.1...2.16.2 ### [`v2.16.1`](https://togithub.com/software-mansion/react-native-gesture-handler/releases/tag/2.16.1) [Compare Source](https://togithub.com/software-mansion/react-native-gesture-handler/compare/2.16.0...2.16.1) #### 🐛 Bug fixes - Fix remote debugger detection in bridgeless mode by [@​piaskowyk](https://togithub.com/piaskowyk) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2864](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2864) - Fix `manualActivation` on web by [@​m-bert](https://togithub.com/m-bert) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2869](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2869) - Fix old Gesture Handler API integration with Reaniamted by [@​piaskowyk](https://togithub.com/piaskowyk) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2881](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2881) - \[Web] Fix incorrect `startX` and `startY` values in `Pan` by [@​m-bert](https://togithub.com/m-bert) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2871](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2871) - \[Web] Add `minVelocity` to `Pan` custom activation criteria by [@​m-bert](https://togithub.com/m-bert) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2884](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2884) #### 👍 Improvements - Add `TypeDoc` to new API by [@​m-bert](https://togithub.com/m-bert) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2874](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2874) #### 🔢 Miscellaneous - Bump Gesture Handler version in documentation by [@​m-bert](https://togithub.com/m-bert) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2838](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2838) - Change `.web` files to default and add `.native` by [@​m-bert](https://togithub.com/m-bert) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2835](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2835) - Bump `typescript` version in example by [@​m-bert](https://togithub.com/m-bert) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2848](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2848) - Disable flipper on CI by [@​m-bert](https://togithub.com/m-bert) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2843](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2843) - Update supported RN versions by [@​m-bert](https://togithub.com/m-bert) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2849](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2849) - Add state flow charts to Gesture Handler's documentation. by [@​latekvo](https://togithub.com/latekvo) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2817](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2817) - Fix `cancell` typo by [@​m-bert](https://togithub.com/m-bert) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2854](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2854) - Minor TS changes by [@​m-bert](https://togithub.com/m-bert) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2872](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2872) - Add automatic og:image generation to docs by [@​xnameTM](https://togithub.com/xnameTM) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2851](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2851) - Fix typo in og:image generation by [@​kacperkapusciak](https://togithub.com/kacperkapusciak) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2880](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2880) - Bump React Native in FabricExample to 0.74 by [@​m-bert](https://togithub.com/m-bert) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2877](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2877) - Update yarn setup in the repository by [@​j-piasecki](https://togithub.com/j-piasecki) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2882](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2882) - Release 2.16.1 by [@​j-piasecki](https://togithub.com/j-piasecki) in [https://github.com/software-mansion/react-native-gesture-handler/pull/2883](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2883) #### New Contributors - [@​xnameTM](https://togithub.com/xnameTM) made their first contribution in [https://github.com/software-mansion/react-native-gesture-handler/pull/2851](https://togithub.com/software-mansion/react-native-gesture-handler/pull/2851) **Full Changelog**: software-mansion/react-native-gesture-handler@2.16.0...2.16.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 5pm,every weekend" in timezone America/Los_Angeles, Automerge - "after 5pm,every weekend" in timezone America/Los_Angeles. 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/valora-inc/wallet). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zODguMSIsInVwZGF0ZWRJblZlciI6IjM3LjM4OC4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJucG0iLCJyZW5vdmF0ZSJdfQ==--> --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: valora-bot <valorabot@valoraapp.com>
](https://renovatebot.com){kind=link}
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
Add a flow chart to visualise state changes of gesture components.
Test plan
Run docs locally, go to the
Gesture states & eventsarticle.compatible with both Light and Dark modes
Screen.Recording.2024-03-28.at.13.21.44.mov
adaptive layout
Screen.Recording.2024-03-28.at.15.09.42.mov