Merge pull request #22 from stavroskasidis/release/3.0.0

Release 3.0.0

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>2.3.0</Version>
+    <Version>3.0.0</Version>
     <Version Condition=" '$(VersionSuffix)' != '' ">$(Version)-$(VersionSuffix)</Version>
     <Product>BlazorDialog</Product>
   </PropertyGroup>

BlazorDialog/BlazorDialogStore.cs

@@ -11,6 +11,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 Dialog GetById(string id)
@@ -47,7 +48,7 @@ public async Task RegisterComponentDialog(string id, ComponentDialog options)
             }
         }
 
-        public void Unregister(Dialog blazorDialog)
+        public void Remove(Dialog blazorDialog)
         {
             if (blazorDialog.Id != null && registeredDialogs.ContainsKey(blazorDialog.Id))
             {

BlazorDialog/Components/ComponentAsDialogContainer.razor

@@ -7,7 +7,8 @@
                 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">
+                OnBeforeHide="ComponentDialog.Options.OnBeforeHide" OnBeforeShow="ComponentDialog.Options.OnBeforeShow"
+                PreventNavigation="ComponentDialog.Options.PreventNavigation">
             <DynamicComponent Type="ComponentDialog.Options.ComponentType" Parameters="ComponentDialog.Options.Parameters"></DynamicComponent>
         </Dialog>
     }
@@ -16,7 +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">
+                OnBeforeHide="ComponentDialog.Options.OnBeforeHide" OnBeforeShow="ComponentDialog.Options.OnBeforeShow"
+                PreventNavigation="ComponentDialog.Options.PreventNavigation">
             <DynamicComponent Type="ComponentDialog.Options.ComponentType" Parameters="ComponentDialog.Options.Parameters"></DynamicComponent>
         </Dialog>
     }

BlazorDialog/Components/Dialog.razor

@@ -2,6 +2,7 @@
 @inject IBlazorDialogStore dialogStore
 @namespace BlazorDialog
 @implements IDisposable
+@inject ILocationChangingHandler locationChangingHandler
 @if (isShowing)
 {
     <CascadingValue Value="this" Name="ParentDialog" IsFixed="true">
@@ -99,6 +100,11 @@
     /// </summary>
     [Parameter] public EventCallback<bool> OnAfterRender { get; set; }
 
+    /// <summary>
+    /// Allows you to prevent browser navigation when the dialog is shown. Defaults to true.
+    /// </summary>
+    [Parameter] public bool PreventNavigation { get; set; } = true;
+
     protected TaskCompletionSource<object> taskCompletionSource;
     internal Action<object> OnDialogHide;
     protected void NotifyDialogHidden(object result) => OnDialogHide?.Invoke(result);
@@ -188,9 +194,12 @@
                 var args = new DialogAfterShowEventArgs(this);
                 await OnAfterShow.InvokeAsync(args);
             }
+
+            locationChangingHandler.RegisterLocationChangingHandler(this);
         }
         else if (isShowingChanged && IsShowing == false && isShowing)
         {
+            locationChangingHandler.RemoveLocationChangingHandler(this);
             if (OnBeforeHide.HasDelegate)
             {
                 var args = new DialogBeforeHideEventArgs(this);
@@ -207,7 +216,8 @@
 
     public void Dispose()
     {
-        dialogStore.Unregister(this);
+        dialogStore.Remove(this);
+        locationChangingHandler.RemoveLocationChangingHandler(this);
         if (taskCompletionSource != null)
         {
             taskCompletionSource.TrySetCanceled();
@@ -260,13 +270,16 @@
             taskCompletionSource = null;
         }
 
+        locationChangingHandler.RegisterLocationChangingHandler(this);
+
         taskCompletionSource = new TaskCompletionSource<object>();
         return await taskCompletionSource.Task;
     }
 
 
     public async Task Hide<TResult>(TResult result)
     {
+        locationChangingHandler.RemoveLocationChangingHandler(this);
         if (OnBeforeHide.HasDelegate)
         {
             var args = new DialogBeforeHideEventArgs(this);

BlazorDialog/IBlazorDialogStore.cs

@@ -53,6 +53,11 @@ public ComponentAsDialogOptions(Type componentType)
         /// </summary>
         public DialogSize Size { get; set; } = DialogSize.Normal;
 
+        /// <summary>
+        /// Allows you to prevent browser navigation when the dialog is shown. Defaults to true.
+        /// </summary>
+        public bool PreventNavigation { get; set; } = true;
+
         /// <summary>
         /// An event that is triggered before the dialog appears.
         /// </summary>
@@ -143,7 +148,7 @@ public interface IBlazorDialogStore
     {
 
         void Register(Dialog blazorDialog);
-        void Unregister(Dialog blazorDialog);
+        void Remove(Dialog blazorDialog);
         Dialog GetById(string id);
         int GetVisibleDialogsCount();
 

BlazorDialog/ILocationChangingHandler.cs

@@ -0,0 +1,15 @@
+using Microsoft.AspNetCore.Components.Routing;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace BlazorDialog
+{
+    public interface ILocationChangingHandler
+    {
+        void RegisterLocationChangingHandler(Dialog dialog);
+        void RemoveLocationChangingHandler(Dialog dialog);
+    }
+}

BlazorDialog/LocationChangingHandler.cs

@@ -0,0 +1,68 @@
+using Microsoft.AspNetCore.Components;
+using Microsoft.AspNetCore.Components.Routing;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace BlazorDialog
+{
+    public class LocationChangingHandler : ILocationChangingHandler, IDisposable
+    {
+        private readonly NavigationManager _navigationManager;
+        private IDisposable? _currentRegistration;
+        private List<Dialog> _dialogsStack = new List<Dialog>();
+
+        public LocationChangingHandler(NavigationManager navigationManager)
+        {
+            _navigationManager = navigationManager;
+        }
+
+        public void RegisterLocationChangingHandler(Dialog dialog)
+        {
+            if (!_dialogsStack.Contains(dialog))
+            {
+                _dialogsStack.Add(dialog);
+            }
+
+            if(_currentRegistration == null)
+            {
+                _currentRegistration = _navigationManager.RegisterLocationChangingHandler(OnLocationChanging);
+            }
+        }
+
+        private ValueTask OnLocationChanging(LocationChangingContext context)
+        {
+            if (!context.IsNavigationIntercepted && _dialogsStack.Any(x => x.PreventNavigation))
+            {
+                context.PreventNavigation();
+            }
+            return ValueTask.CompletedTask;
+        }
+
+        public void RemoveLocationChangingHandler(Dialog dialog)
+        {
+            if (_dialogsStack.Contains(dialog))
+            {
+                _dialogsStack.Remove(dialog);
+            }
+
+            // if there are no dialogs left in the stack, we can remove the location changing handler
+            if (_currentRegistration != null && _dialogsStack.Count == 0)
+            {
+                _currentRegistration.Dispose();
+                _currentRegistration = null;
+            }
+        }
+
+        public void Dispose()
+        {
+            if(_currentRegistration != null)
+            {
+               _currentRegistration.Dispose();
+                _currentRegistration = null;
+            }
+        }
+    }
+}

BlazorDialog/Properties/launchSettings.json

@@ -8,13 +8,6 @@
     }
   },
   "profiles": {
-    "IIS Express": {
-      "commandName": "IISExpress",
-      "launchBrowser": true,
-      "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
-      }
-    },
     "BlazorDialog": {
       "commandName": "Project",
       "launchBrowser": true,

BlazorDialog/ServiceCollectionExtensions.cs

@@ -12,6 +12,7 @@ public static IServiceCollection AddBlazorDialog(this IServiceCollection service
         {
             services.AddScoped<IBlazorDialogStore, BlazorDialogStore>();
             services.AddScoped<IBlazorDialogService, BlazorDialogService>();
+            services.AddScoped<ILocationChangingHandler, LocationChangingHandler>();
             return services;
         }
     }

Directory.Build.props

@@ -1,8 +1,8 @@
 <Project>
   <!-- See https://aka.ms/dotnet/msbuild/customize for more details on customizing your build -->
   <PropertyGroup>
-	  <TargetFramework>net6.0</TargetFramework>
-	  <MSPackagesVersion>6.0.26</MSPackagesVersion>
+	  <TargetFramework>net8.0</TargetFramework>
+	  <MSPackagesVersion>8.0.*</MSPackagesVersion>
 	  <Nullable>enable</Nullable>
 	  <ImplicitUsings>enable</ImplicitUsings>
   </PropertyGroup>

README.md

@@ -81,7 +81,13 @@ Make sure that there is a call to `app.UseStaticFiles();` in your server project
 </details>
 
 ## Release Notes
-<details open="open"><summary>2.3</summary>
+<details open="open"><summary>3.0</summary>
+
+>- Migrate to .NET 8.0
+>- Add PreventNavigation option to prevent navigation when dialog is open.
+</details>
+
+<details><summary>2.3</summary>
 
 >- Expose dialog options as cascading parameter when using ComponentAsDialog.
 </details>

TestApps/BlazorDialog.TestAppsCommon/IndexCommon.razor

@@ -110,7 +110,7 @@
     </DialogInputProvider>
 </Dialog>
 
-<Dialog Id="simple-dialog" Size="size" Centered="isCentered" Animation="animation">
+<Dialog Id="simple-dialog" Size="size" Centered="isCentered" Animation="animation" PreventNavigation="false">
     <DialogInputProvider TInput="string">
         <DialogBody>
             <h4>@context.Input</h4>

TestApps/Wasm/BlazorDialog.BlazorTestApp.Server/Properties/launchSettings.json

@@ -8,17 +8,10 @@
     }
   },
   "profiles": {
-    "IIS Express": {
-      "commandName": "IISExpress",
-      "launchBrowser": true,
-      "inspectUri": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}",
-      "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
-      }
-    },
     "BlazorDialog.BlazorTestApp.Server": {
       "commandName": "Project",
       "launchBrowser": true,
+      "dotnetRunMessages": true,
       "inspectUri": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"

global.json

@@ -1,5 +1,5 @@
 {
   "sdk": {
-    "version": "6.0.412"
+    "version": "8.0.302"
   }
 }