Merge pull request #29 from stavroskasidis/release/4.1.0

Release 4.1.0

Author: stavroskasidis

BlazorDialog/BlazorDialog.csproj

@@ -12,7 +12,7 @@
     <Copyright />
     <PackageTags>blazor blazor-component blazor-dialog dialog modal blazor-modal blazordialog blazormodaldialog blazormodal razor razor-components razorcomponents</PackageTags>
     <VersionSuffix>$(VersionSuffix)</VersionSuffix>
-    <Version>4.0.1</Version>
+    <Version>4.1.0</Version>
     <Version Condition=" '$(VersionSuffix)' != '' ">$(Version)-$(VersionSuffix)</Version>
     <Product>BlazorDialog</Product>
   </PropertyGroup>

BlazorDialog/BlazorDialogService.cs

@@ -30,7 +30,7 @@ public Task ShowComponentAsDialog(ComponentAsDialogOptions options)
             return ShowComponentAsDialog<object>(options);
         }
 
-        public async Task<TResult> ShowComponentAsDialog<TResult>(ComponentAsDialogOptions options)
+        public async Task<TResult?> ShowComponentAsDialog<TResult>(ComponentAsDialogOptions options)
         {
             var id = Guid.NewGuid().ToString();
             var tcs = new TaskCompletionSource();
@@ -49,17 +49,17 @@ public async Task ShowDialog(string dialogId)
             await ShowDialog<object>(dialogId, null);
         }
 
-        public async Task<TResult> ShowDialog<TResult>(string dialogId)
+        public async Task<TResult?> ShowDialog<TResult>(string dialogId)
         {
             return await ShowDialog<TResult>(dialogId, null);
         }
 
-        public async Task ShowDialog(string dialogId, object input)
+        public async Task ShowDialog(string dialogId, object? input)
         {
             await ShowDialog<object>(dialogId, input);
         }
 
-        public async Task<TResult> ShowDialog<TResult>(string dialogId, object input)
+        public async Task<TResult?> ShowDialog<TResult>(string dialogId, object? input)
         {
             return await _blazorDialogStore.GetById(dialogId).Show<TResult>(input);
         }

BlazorDialog/BlazorDialogStore.cs

@@ -12,7 +12,7 @@ internal class BlazorDialogStore : IBlazorDialogStore
         private Dictionary<string, Dialog> registeredDialogs = new Dictionary<string, Dialog>();
         private Dictionary<string, ComponentDialog> registeredComponentDialogs = new Dictionary<string, ComponentDialog>();
 
-        public event Func<Task> OnComponentAsDialogsChanged;
+        public event Func<Task>? OnComponentAsDialogsChanged;
 
         public Dialog GetById(string id)
         {

BlazorDialog/Components/ComponentAsDialogContainer.razor

@@ -6,8 +6,8 @@
         <Dialog Id="@Key" Animation="ComponentDialog.Options.Animation" BaseZIndex="ComponentDialog.Options.BaseZIndex"
                 Centered="ComponentDialog.Options.Centered" CssClass="@ComponentDialog.Options.CssClass" Size="ComponentDialog.Options.Size"
                 OnAfterRender="EventUtil.AsNonRenderingEventCallback((bool firstLoad) => OnAfterDialogRender(firstLoad))"
-                OnAfterHide="ComponentDialog.Options.OnAfterHide" OnAfterShow="ComponentDialog.Options.OnAfterShow"
-                OnBeforeHide="ComponentDialog.Options.OnBeforeHide" OnBeforeShow="ComponentDialog.Options.OnBeforeShow"
+                OnAfterHide="ComponentDialog.Options.OnAfterHide!" OnAfterShow="ComponentDialog.Options.OnAfterShow!"
+                OnBeforeHide="ComponentDialog.Options.OnBeforeHide!" OnBeforeShow="ComponentDialog.Options.OnBeforeShow!"
                 PreventNavigation="ComponentDialog.Options.PreventNavigation" KeyboardCloseEnabled="ComponentDialog.Options.KeyboardCloseEnabled"
                 KeyboardCloseKey="@ComponentDialog.Options.KeyboardCloseKey">
             <DynamicComponent Type="ComponentDialog.Options.ComponentType" Parameters="ComponentDialog.Options.Parameters"></DynamicComponent>
@@ -17,8 +17,8 @@
     {
         <Dialog Id="@Key" IsCustom="ComponentDialog.Options.IsCustom"
                 OnAfterRender="EventUtil.AsNonRenderingEventCallback((bool firstLoad) => OnAfterDialogRender(firstLoad))"
-                OnAfterHide="ComponentDialog.Options.OnAfterHide" OnAfterShow="ComponentDialog.Options.OnAfterShow"
-                OnBeforeHide="ComponentDialog.Options.OnBeforeHide" OnBeforeShow="ComponentDialog.Options.OnBeforeShow"
+                OnAfterHide="ComponentDialog.Options.OnAfterHide!" OnAfterShow="ComponentDialog.Options.OnAfterShow!"
+                OnBeforeHide="ComponentDialog.Options.OnBeforeHide!" OnBeforeShow="ComponentDialog.Options.OnBeforeShow!"
                 PreventNavigation="ComponentDialog.Options.PreventNavigation" KeyboardCloseEnabled="ComponentDialog.Options.KeyboardCloseEnabled"
                 KeyboardCloseKey="@ComponentDialog.Options.KeyboardCloseKey">
             <DynamicComponent Type="ComponentDialog.Options.ComponentType" Parameters="ComponentDialog.Options.Parameters"></DynamicComponent>
@@ -27,8 +27,8 @@
 </CascadingValue>
 
 @code {
-    [Parameter, EditorRequired] public ComponentDialog ComponentDialog { get; set; }
-    [Parameter, EditorRequired] public string Key { get; set; }
+    [Parameter, EditorRequired] public ComponentDialog ComponentDialog { get; set; } = null!;
+    [Parameter, EditorRequired] public string Key { get; set; } = null!;
 
     protected override void OnInitialized()
     {

BlazorDialog/Components/Dialog.razor

@@ -28,12 +28,12 @@
 
 @code{
 
-    [Parameter] public RenderFragment ChildContent { get; set; }
+    [Parameter] public RenderFragment ChildContent { get; set; } = null!;
 
     /// <summary>
     /// The unique idetifier of the dialog. This field is required when using the dialog as a service.
     /// </summary>
-    [Parameter] public string Id { get; set; }
+    [Parameter] public string? Id { get; set; }
 
     /// <summary>
     /// The base z-index of the dialog when shown. Default: 1050
@@ -44,6 +44,11 @@
     /// Use this to show/hide the dialog as a simple component.
     /// </summary>
     [Parameter] public bool? IsShowing { get; set; }
+
+    /// <summary>
+    /// Used for two-way binding of the <see cref="IsShowing" /> parameter.
+    /// </summary>
+    [Parameter] public EventCallback<bool?> IsShowingChanged { get; set; }
     private bool isShowing;
 
     /// <summary>
@@ -94,7 +99,7 @@
     /// <summary>
     /// Adds a custom css class to the wrapper of the dialog.
     /// </summary>
-    [Parameter] public string CssClass { get; set; }
+    [Parameter] public string? CssClass { get; set; }
 
     /// <summary>
     /// An event that is triggered after the dialog renders.
@@ -118,11 +123,18 @@
 
 
     private bool? _forcedPreventNavigation;
-    protected TaskCompletionSource<object> taskCompletionSource;
-    internal Action<object> OnDialogHide;
+    protected TaskCompletionSource<object?>? taskCompletionSource;
+    internal Action<object?> OnDialogHide = null!;
     private DotNetObjectReference<Dialog>? dotNetObjectReference;
 
-    protected void NotifyDialogHidden(object result) => OnDialogHide?.Invoke(result);
+    protected async Task NotifyDialogHidden(object? result) 
+    {
+        OnDialogHide?.Invoke(result);
+        if(IsShowingChanged.HasDelegate)
+        {
+            await IsShowingChanged.InvokeAsync(false);
+        }
+    }
 
     protected string ContentWrapperCssClass
     {
@@ -175,7 +187,7 @@
         {
             dialogStore.Register(this);
         }
-        OnDialogHide = (object result) =>
+        OnDialogHide = (object? result) =>
         {
             if (taskCompletionSource != null)
             {
@@ -219,13 +231,13 @@
             locationChangingHandler.RemoveLocationChangingHandler(this);
             if (OnBeforeHide.HasDelegate)
             {
-                var args = new DialogBeforeHideEventArgs(this);
+                var args = new DialogBeforeHideEventArgs(this, default, triggeredFromKeyboard: false, triggeredFromCloseButton: false);
                 await OnBeforeHide.InvokeAsync(args);
             }
             this.isShowing = false;
             if (OnAfterHide.HasDelegate)
             {
-                var args = new DialogAfterHideEventArgs(this);
+                var args = new DialogAfterHideEventArgs(this, triggeredFromKeyboard: false, triggeredFromCloseButton: false);
                 await OnAfterHide.InvokeAsync(args);
             }
 
@@ -266,7 +278,7 @@
         await this.Show<object>(input);
     }
 
-    public async Task<TResult?> Show<TResult>(object input)
+    public async Task<TResult?> Show<TResult>(object? input)
     {
         this.Input = input;
         var result = await ShowInternal();
@@ -298,31 +310,47 @@
 
         await jsRuntime.InvokeVoidAsync("blazorDialog.registerShownDialog", dotNetObjectReference, this.KeyboardCloseEnabled, this.KeyboardCloseKey);
 
-        taskCompletionSource = new TaskCompletionSource<object>();
+        taskCompletionSource = new TaskCompletionSource<object?>();
         return await taskCompletionSource.Task;
     }
 
 
-    public async Task Hide<TResult>(TResult result)
+    public async Task Hide<TResult>(TResult? result)
+    {
+        await Hide(result, triggeredFromKeyboard: false, triggeredFromCloseButton: false);
+    }
+
+    protected async Task Hide<TResult>(TResult? result, bool triggeredFromKeyboard = false, bool triggeredFromCloseButton = false)
     {
-        locationChangingHandler.RemoveLocationChangingHandler(this);
         if (OnBeforeHide.HasDelegate)
         {
-            var args = new DialogBeforeHideEventArgs(this);
+            var args = new DialogBeforeHideEventArgs(this, result, triggeredFromKeyboard, triggeredFromCloseButton);
             await OnBeforeHide.InvokeAsync(args);
+            if (args.PreventHide) return;
         }
+        locationChangingHandler.RemoveLocationChangingHandler(this);
         this.isShowing = false;
-        NotifyDialogHidden(result);
+        await NotifyDialogHidden(result);
         await InvokeAsync(() => StateHasChanged());
         if (OnAfterHide.HasDelegate)
         {
-            var args = new DialogAfterHideEventArgs(this);
+            var args = new DialogAfterHideEventArgs(this, triggeredFromKeyboard, triggeredFromCloseButton);
             await OnAfterHide.InvokeAsync(args);
         }
 
         await jsRuntime.InvokeVoidAsync("blazorDialog.unregisterShownDialog", dotNetObjectReference);
     }
 
+    internal async Task HideFromKeyboard()
+    {
+        await this.Hide<object>(null, triggeredFromKeyboard: true);
+    }
+
+    internal async Task HideFromCloseButton()
+    {
+        await this.Hide<object>(null, triggeredFromCloseButton: true);
+    }
+
     public async Task Hide()
     {
         await this.Hide<object>(null);
@@ -367,6 +395,6 @@
     [JSInvokable]
     public async Task HideFromKeyPress()
     {
-        await this.Hide();
+        await this.HideFromKeyboard();
     }
 }

BlazorDialog/Components/DialogBody.razor

@@ -5,7 +5,7 @@
 
 @code{
 
-    [Parameter] public RenderFragment ChildContent { get; set; }
+    [Parameter] public RenderFragment ChildContent { get; set; } = null!;
 
-    [Parameter] public string CssClass { get; set; }
+    [Parameter] public string? CssClass { get; set; }
 }

BlazorDialog/Components/DialogFooter.razor

@@ -4,6 +4,6 @@
 </div>
 
 @code{
-    [Parameter] public RenderFragment ChildContent { get; set; }
-    [Parameter] public string CssClass { get; set; }
+    [Parameter] public RenderFragment ChildContent { get; set; } = null!;
+    [Parameter] public string? CssClass { get; set; }
 }

BlazorDialog/Components/DialogHeader.razor

@@ -10,13 +10,13 @@
 </div>
 
 @code{
-    [Parameter] public RenderFragment ChildContent { get; set; }
+    [Parameter] public RenderFragment ChildContent { get; set; } = null!;
     [Parameter] public bool ShowClose { get; set; } = false;
-    [Parameter] public string CssClass { get; set; }
-    [CascadingParameter(Name = "ParentDialog")] Dialog Dialog { get; set; }
+    [Parameter] public string? CssClass { get; set; }
+    [CascadingParameter(Name = "ParentDialog")] Dialog Dialog { get; set; } = null!;
 
     private async Task OnCloseClick()
     {
-        await Dialog.Hide();
+        await Dialog.HideFromCloseButton();
     }
 }

BlazorDialog/Components/DialogInputProvider.razor

@@ -4,7 +4,7 @@
 @ChildContent(new DialogContext<TInput>(ParentDialog, (TInput)Input))
 
 @code{
-    [Parameter] public RenderFragment<DialogContext<TInput>> ChildContent { get; set; }
-    [CascadingParameter(Name = "DialogInput")] protected object Input { get; set; }
-    [CascadingParameter(Name = "ParentDialog")] protected Dialog ParentDialog { get; set; }
+    [Parameter] public RenderFragment<DialogContext<TInput>> ChildContent { get; set; } = null!;
+    [CascadingParameter(Name = "DialogInput")] protected object Input { get; set; } = null!;
+    [CascadingParameter(Name = "ParentDialog")] protected Dialog ParentDialog { get; set; } = null!;
 }

BlazorDialog/EventArgs.cs

@@ -32,17 +32,48 @@ public DialogAfterShowEventArgs(Dialog dialog) : base(dialog)
 
     public class DialogBeforeHideEventArgs : DialogEventArgs
     {
-        public DialogBeforeHideEventArgs(Dialog dialog) : base(dialog)
+        public DialogBeforeHideEventArgs(Dialog dialog, object? result, bool triggeredFromKeyboard, bool triggeredFromCloseButton) : base(dialog)
         {
+            Result = result;
+            TriggeredFromKeyboard = triggeredFromKeyboard;
+            TriggeredFromCloseButton = triggeredFromCloseButton;
         }
 
-        //public bool PreventHide { get; set; }
+        /// <summary>
+        /// If set to true, the dialog hide action will be prevented.
+        /// </summary>
+        public bool PreventHide { get; set; }
+
+        /// <summary>
+        /// The dialog result if any.
+        /// </summary>
+        public object? Result { get; }
+
+        /// <summary>
+        /// Gets a value indicating whether the action was triggered by a keyboard input.
+        /// </summary>
+        public bool TriggeredFromKeyboard { get; }
+
+        /// <summary>
+        /// Gets a value indicating whether the action was triggered by the close button.
+        /// </summary>
+        public bool TriggeredFromCloseButton { get; }
     }
 
     public class DialogAfterHideEventArgs : DialogEventArgs
     {
-        public DialogAfterHideEventArgs(Dialog dialog) : base(dialog)
+        public DialogAfterHideEventArgs(Dialog dialog, bool triggeredFromKeyboard, bool triggeredFromCloseButton) : base(dialog)
         {
+            TriggeredFromKeyboard = triggeredFromKeyboard;
+            TriggeredFromCloseButton = triggeredFromCloseButton;
         }
+        /// <summary>
+        /// Gets a value indicating whether the action was triggered by a keyboard input.
+        /// </summary>
+        public bool TriggeredFromKeyboard { get; }
+        /// <summary>
+        /// Gets a value indicating whether the action was triggered by the close button.
+        /// </summary>
+        public bool TriggeredFromCloseButton { get; }
     }
 }