Added new onSwipe callbacks

[Purii]

Great component!

I needed a method to get notified, once the user started swiping the modal:
Modal from bottom containing an arrow icon. The icon shall be animated based on the swiping state.

Feel free to provide improvements 👍

[mmazzarolo]

@Purii thank you for the PR!
You're right, a few more "swiping" props would be useful.
My main issue with the PR is the naming convention:

• onSwipe
• onSwiping
• onSwipingDone
  They seem a bit confusing now, but that's just because the original onSwipe props should have been named onSwipeDone/onSwipeComplete instead... 🤔

Would it make sense doing something like this (just asking for feedback, I'm not saying you should do it in the PR 😃)?

• Deprecate the onSwipe callback (but still support it)
• Create the following callbacks:
  • onSwipeStart
  • onSwipeMove
  • onSwipeComplete
  • onSwipeCancel

What do you think?

[Purii]

I'm also not that happy with the naming.
Your suggestion sounds much better. I'm going to update the PR :)

[mmazzarolo]

@Purii thank you sir 🙇

[Purii]

@mmazzarolo You're welcome!
I added the four new methods.

Deprecation onSwipe
The deprecation warning will be triggered on componentDidMount.

Added Prettier Config
During development I saw, that my local prettier config is different than the one used in the repo.
So I added a prettier config to override different local settings.
I also set trailingComma:true.
Hope this is fine for you?

Let me know if I should change something :)

[Purii]

Any idea for a better naming of percentageLeft as value of onSwipeMove?

[mmazzarolo]

Any idea for a better naming of percentageLeft as value of onSwipeMove

swipeProgress maybe? Did you check if it is invoked correctly? (Can't check it right now).

Look good to me, top notch contribution 👌

No worries about the prettier config, we are planning to start using a community driven one so it probably be changed again soon.

[mmazzarolo]

❤️

[mmazzarolo]

Thanks for the cleanup

[Purii]

swipeProgress maybe? Did you check if it is invoked correctly? (Can't check it right now).

Yep. Will be invoked on each move. No throttling, as I would leave that responsibility to the user.
Currently I just return newOpacityFactor, that's why I labeled it percentageLeft. Wouldn't swipeProgress implicate the progress of the swipe and not the way still to go? But we could give it a try: swipeProgress === newOpacityFactor

[mmazzarolo]

Wouldn't swipeProgress implicate the progress of the swipe and not the way still to go?

🤦‍♂️ my bad, you're right.
Mind reverting it for the last time? Thank you!

[Purii]

Renamed it to percentageShown. Still not perfect, but understandable.
Also updated the example: onSwipe --> onSwipeComplete 👍

[Purii]

Is the prettier config fine for you?
Changed some formatting of the example (added trailing comma,...)

[mmazzarolo]

Is the prettier config fine for you?

Yes, see:

No worries about the prettier config, we are planning to start using a community driven one so it probably be changed again soon.

Merging, thanks @Purii !

[mmazzarolo]

Landed in v8.0.0-beta.1 🛬