Improved popup dismiss options

[reck1610]

Currently, PopupOptions.OnTappingOutsideOfPopup will only get invoked when the popup is dismissed.
If CanBeDismissedByTappingOutsideOfPopup is set to false PopupOptions.OnTappingOutsideOfPopup will not get invoked.
Furthermore, PopupOptions.OnTappingOutsideOfPopup will get invoked if the back button is pressed on Android.
I don't like this.

I propose the following changes:

• PopupOptions.OnTappingOutsideOfPopup should be renamed to PopupOptions.OnDismiss
• a new PopupOptions.OnTappingOutsideOfPopup should be created an get fired regardless of CanBeDismissedByTappingOutsideOfPopup
• a new PopupOptions.OnBackButtonPressed should be created
• a new CanBeDismissedByBackButtonPressed should be created

CanBeDismissedByTappingOutsideOfPopup and CanBeDismissedByBackButtonPressed would only change the dismissal behavior.
PopupOptions.OnTappingOutsideOfPopup and PopupOptions.OnBackButtonPressed can be used to implement custom behavior.
PopupOptions.OnDismiss can be used to get the current behavior.

I have already implemented such a change in https://github.com/reck1610/CommunityToolkit.Maui/tree/improve-popup-dismiss

[reck1610]

My main problem with the current behavior is, that it is not possible to only prevent dismissal by tap outside of popup.

[brendanrempel]

I'd like to add to this support to intercept Android's back button within the popup. This would allow a wizard UI within a popup or control cancelation.

[reck1610]

await PopupService.ShowPopupAsync<WizardPopupViewModel>(Shell.Current, new PopupOptions()
{
    CanBeDismissedByTappingOutsideOfPopup = false,
    CanBeDismissedByBackButtonPressed = false,
    OnBackButtonPressed = () => { /* handle back button for wizard */ }
});

I think the only part missing, to support this, is access to the ViewModel in OnBackButtonPressed. We could pass the Popup and access the ViewModel that way.

await PopupService.ShowPopupAsync<WizardPopupViewModel>(Shell.Current, new PopupOptions()
{
    CanBeDismissedByTappingOutsideOfPopup = false,
    CanBeDismissedByBackButtonPressed = false,
    OnBackButtonPressed = (popup) => { ((WizardPopupViewModel)popup.BindingContext)?.NavigateBack(); }
});

Maybe we should pass the dismissCommand as second parameter to allow custom dismissal logic.
Or even better, we could move dismissCommand from PopupPage to Popup and give it a public getter.
This would create a straightforward way to dismiss the popup from everywhere.

[EmilienDup]

I also find the popup dismissal options way too limited 😕

Are the community toolkit maintainers open to the idea of improving it?
Would they agree to review a pull request?

I assume they would not want any breaking change to be introduced 🤔

[bijington]

I am open to the idea and yes we want to avoid breaking changes where we can.

[thenderson21]

I ran into this same limitation while implementing a custom popup with an exit animation.

Currently, OnTappingOutsideOfPopup is invoked, but the popup is dismissed immediately afterward, which doesn't leave an opportunity to perform asynchronous work before the popup is removed.

I experimented with a small API addition that allows the application to suppress the default outside-tap dismissal while still raising the callback. This lets the application perform an animation (or other custom logic) and then explicitly call CloseAsync() when it's is ready.

Importantly, this is not a breaking change. The new behavior is opt-in, and the default behavior remains exactly as it is today, so existing applications are unaffected.

The implementation has been working well in my testing, and I'd be happy to open a proposal and submit a PR if this is a direction the Toolkit would consider.

main...thenderson21:ComunityToolkit_Maui:main