software-mansion / react-native-gesture-handler

Declarative API exposing platform native touch and gesture system to React Native.
https://docs.swmansion.com/react-native-gesture-handler/
MIT License
6.13k stars 982 forks source link

Documentation on `onDrawerStateChanged` of Drawer Layout need to explain its second argument, `drawerWillShow: boolean`. #2993

Closed sinibida closed 4 months ago

sinibida commented 4 months ago

Description

The argument drawerWillShow of onDrawerStateChanged of DrawerLayout should be documented, as this is the only reliable way of telling whether the settling drawer is closing, or opening. (a.k.a if the drawer has started opening or closing) The current documentation website lacks of this explanation. #

Related Discussion: https://github.com/software-mansion/react-native-gesture-handler/discussions/1866

Steps to reproduce

.

Snack or a link to a repository

.

Gesture Handler version

.

React Native version

.

Platforms

Android

JavaScript runtime

None

Workflow

None

Architecture

None

Build type

None

Device

None

Device model

No response

Acknowledgements

Yes

github-actions[bot] commented 4 months ago

Hey! 👋

It looks like you've omitted a few important sections from the issue template.

Please complete Steps to reproduce, Snack or a link to a repository, Gesture Handler version and React Native version sections.

github-actions[bot] commented 4 months ago

Hey! 👋

The issue doesn't seem to contain a minimal reproduction.

Could you provide a snack or a link to a GitHub repository under your username that reproduces the problem?

m-bert commented 4 months ago

Hi @sinibida! I've just added that in #3000. Could you please check that and tell me if there is something more that you think that should be added?

sinibida commented 4 months ago

Nope, looks great! Thank you for your service.