[Proposal] Popup

Popup

• Proposed
• Prototype
• Implementation
  • iOS Support
  • Android Support
  • macOS Support
  • Windows Support
• Unit Tests
• Sample
• Documentation

Summary

A customizable popup

Detailed Design

Popup.shared.cs

public class Popup<T> : BasePopupView
{  
  public static readonly BindableProperty ContentProperty;
  public static readonly BindableProperty ColorProperty;
  public static readonly BindableProperty SizeProperty;
  public static readonly BindableProperty VerticalOptionsProperty;
  public static readonly BindableProperty HorizontalOptionsProperty;
  
  public Task<T?> Result { get; }
  public virtual View? Content { get; set; }
  public Color Color { get; set; }
  public LayoutOptions VerticalOptions { get; set; }
  public LayoutOptions HorizontalOptions { get; set; }
  public View? Anchor { get; set; }
  public Size Size { get; set; }
  public bool IsLightDismissEnabled { get; set; }
  public event EventHandler<PopupDismissedEventArgs> Dismissed;
  public event EventHandler<PopupOpenedEventArgs> Opened;
  
  public void Reset();
  public void Dismiss(T? result);
}

// Both `Popup` and `Snackbar` should inherit from `BasePopupView` 
public abstract class BasePopupView
{
  public static readonly BindableProperty IsShown; // One-way binding
  public static readonly BindableProperty AnchorProperty; // Two-way binding
  public static readonly BindableProperty AppearingAnimationProperty; // Two-way binding
  public static readonly BindableProperty DisappearingAnimationProperty; // Two-way binding

  public bool IsShown { get; private set; }

  public IView Anchor { get; set; } = GetDefaultAnchor();
  public Animation AppearingAnimation { get; set; } = GetDefaultAnimation();
  public Animation DisappearingAnimation { get; set; } = GetDefaultAnimation();

  public event EventHandler Shown;
  public event EventHandler Dismissed;

  public abstract Task Show();
  public abstract Task Dismiss();

  private Animation GetDefaultAnimation();

  private IView GetDefaultAnchor();
}

[maxkoshevoi]

Maybe it’s too late, but how are you looking at using Rg.Plugins.Popups port as a popup view in the toolkit? It has more features and is already widely used.

CC: @LuckyDucko

[msftbot[bot]]

Reopening Proposal.

Only Proposals moved to the Closed Project Column and Completed Project Column can be closed.