Add `TypeDoc` to new API #2874

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.

Sign up for GitHub

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

Jump to bottom

Merged

j-piasecki merged 5 commits into main from @mbert/add-ts-docs

Apr 29, 2024

Contributor

m-bert commented Apr 23, 2024

Description

I thought that adding TypeDocs might be a good idea and it could enhance developer experience (I've come up with this idea when I discovered that we have withRef modifier). This PR adds TypeDocs to new API (but we can also think of filling missing docs in old API)

Test plan

Hover functions/components and read docs.

m-bert added 3 commits

April 23, 2024 10:12


          Add GestureDetector docs

972e368


          Add docs to Gesture object

5ff0f70


          Add rest of docs

daa4427

m-bert requested review from j-piasecki and kacperkapusciak

April 23, 2024 10:02

j-piasecki approved these changes

View reviewed changes

src/handlers/gestures/gesture.ts Outdated Show resolved Hide resolved

src/handlers/gestures/flingGesture.ts Show resolved Hide resolved

m-bert added 2 commits

April 23, 2024 15:19


          Change finger to pointer

ef3e648


          Add | operator to fling docs

4de93ca

j-piasecki merged commit 15c65fb into main

j-piasecki deleted the @mbert/add-ts-docs branch

April 29, 2024 07:53

This was referenced May 21, 2024

[Snyk] Upgrade react-native-gesture-handler from 2.1.3 to 2.16.1 ColeCoffman/JBApp#88

Open

[Snyk] Upgrade react-native-gesture-handler from 2.1.3 to 2.16.1 ColeCoffman/JBApp#93

Open

Abellache-Rabah mentioned this pull request

[Snyk] Upgrade react-native-gesture-handler from 2.9.0 to 2.16.1 Abellache-Rabah/frontend-hawasli#39

Open

github-merge-queue bot referenced this pull request in valora-xyz/wallet


          fix(deps): update dependency react-native-gesture-handler to ^2.16.2 (#…

e696bee

…5520)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](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)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/react-native-gesture-handler/2.16.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/react-native-gesture-handler/2.16.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/react-native-gesture-handler/2.16.0/2.16.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/react-native-gesture-handler/2.16.0/2.16.2?slim=true)](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`
([#&#8203;2835](https://togithub.com/software-mansion/react-native-gesture-handler/issues/2835))"
by [@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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 [@&#8203;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
[@&#8203;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
[@&#8203;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 [@&#8203;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 [@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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

- [@&#8203;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>

ColeCoffman mentioned this pull request

[Snyk] Upgrade react-native-gesture-handler from 2.1.3 to 2.16.2 ColeCoffman/JBApp#98

Open

Abellache-Rabah mentioned this pull request

[Snyk] Upgrade react-native-gesture-handler from 2.9.0 to 2.17.1 Abellache-Rabah/frontend-hawasli#45

Open

ColeCoffman mentioned this pull request

[Snyk] Upgrade react-native-gesture-handler from 2.1.3 to 2.17.1 ColeCoffman/JBApp#106

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet