fix(iOS): onNativeDismissCancelled called too early during modal dismissal

[zetavg]

Description

Currently, on iOS, onNativeDismissCancelled is being called while the user begins to drag down a modal (which calls the callback function of the usePreventRemove hook, if preventRemove is true).

This is not a common behavior of iOS apps and can sometimes be annoying: the callback will be triggered while the user is scrolling around a ScrollView in the modal and has hit the top, which is interrupting.

Ideal	Before	After
The event fires when the user releses the drag. If the user did not intend to dismiss the modal (the user did not drag it down far enough or dragged it back to its original position before release), the event will not fire.	The event fires as soon as the modal is dragged down, regardless of whether the user intends to dismiss the modal or not. (In this case, the user just wants to scroll to the top.)	Same as "Ideal".

This PR adjusts this to the more ideal behavior.

Changes

Move the call of notifyDismissCancelled from presentationControllerShouldDismiss to presentationControllerDidAttemptToDismiss - which "Notifies the delegate that a user-initiated attempt to dismiss a view was prevented", and has the same platform avalibality as presentationControllerShouldDismiss.

Test code and steps to reproduce

Use the new "Prevent Remove" example:

Full test recordings

Modal

Full.Test.-.Modal.-.05.mp4

Normal Screen (this should not be affected since I believe that preventing going back from a normal screen is not handled here)

Full.Test.-.Screen.-.05.mp4

Checklist

• Included code example that can be used to test this change
• Updated TS types
• Updated documentation:
  • https://github.com/software-mansion/react-native-screens/blob/main/guides/GUIDE_FOR_LIBRARY_AUTHORS.md
  • https://github.com/software-mansion/react-native-screens/blob/main/native-stack/README.md
  • https://github.com/software-mansion/react-native-screens/blob/main/src/types.tsx
  • https://github.com/software-mansion/react-native-screens/blob/main/src/native-stack/types.tsx
• Ensured that CI passes

[zetavg]

Note: both #1959 and this PR can achieve #1950. But I think this should be the default behavior of onNativeDismissCancelled and usePreventRemove - firing the callback when the user releases the drag.

[kkafar]

Hi @zetavg, thanks for preparing these changes 🎉. I took a glance & these changes look good, however I'll need to find time to test this! Will get back you once I do.