Merge pull request #69 from stavroskasidis/release/1.3

Release/1.3

Author: stavroskasidis

BlazorContextMenu/BlazorContextMenu.csproj

@@ -18,7 +18,7 @@
     <Copyright />
     <PackageTags>blazor blazor-component blazor-context-menu context-menu contextmenu menu blazor-menu blazorcontextmenu razor razor-components razorcomponents</PackageTags>
     <VersionSuffix>$(VersionSuffix)</VersionSuffix>
-    <Version>1.2.0</Version>
+    <Version>1.3.0</Version>
     <Version Condition=" '$(VersionSuffix)' != '' ">$(Version)-$(VersionSuffix)</Version>
     <Product>Blazor.ContextMenu</Product>
   </PropertyGroup>

BlazorContextMenu/Components/ContextMenu.razor

@@ -103,6 +103,12 @@
     [Parameter]
     public EventCallback<MenuAppearingEventArgs> OnAppearing { get; set; }
 
+    /// <summary>
+    /// A handler that is triggered before the menu is hidden. Can be used to prevent the menu from hiding.
+    /// </summary>
+    [Parameter]
+    public EventCallback<MenuHidingEventArgs> OnHiding { get; set; }
+
     /// <summary>
     /// Set to false if you want to close the menu programmatically. Default: true
     /// </summary>
@@ -266,10 +272,21 @@
         await InvokeAsync(() => StateHasChanged());
     }
 
-    internal async Task Hide()
+    internal async Task<bool> Hide()
     {
+        if (OnHiding.HasDelegate)
+        {
+            var eventArgs = new MenuHidingEventArgs(Id, TargetId, X, Y, Trigger, Data);
+            await OnHiding.InvokeAsync(eventArgs);
+            if (eventArgs.PreventHide)
+            {
+                return false;
+            }
+        }
+
         IsShowing = false;
         await InvokeAsync(() => StateHasChanged());
+        return true;
     }
 
     internal string GetTarget()

BlazorContextMenu/EventArgs/MenuHidingEventArgs.cs

@@ -0,0 +1,54 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace BlazorContextMenu
+{
+    public class MenuHidingEventArgs
+    {
+        public MenuHidingEventArgs(string contextMenuId, string contextMenuTargetId, string x, string y, ContextMenuTrigger trigger, object data)
+        {
+            ContextMenuId = contextMenuId;
+            ContextMenuTargetId = contextMenuTargetId;
+            ContextMenuTrigger = trigger;
+            Data = data;
+            X = x;
+            Y = y;
+        }
+
+        /// <summary>
+        /// The <see cref="ContextMenuTrigger"/> that triggered this menu.
+        /// </summary>
+        public ContextMenuTrigger ContextMenuTrigger { get; protected set; }
+
+        /// <summary>
+        /// The X position of the <see cref="ContextMenu"/>.
+        /// </summary>
+        public string X { get; set; }
+
+        /// <summary>
+        /// The Y position of the <see cref="ContextMenu"/>.
+        /// </summary>
+        public string Y { get; set; }
+
+        /// <summary>
+        /// The id of the <see cref="ContextMenu"/> that triggered this event.
+        /// </summary>
+        public string ContextMenuId { get; protected set; }
+
+        /// <summary>
+        /// The id of the target element that the <see cref="ContextMenu"/> was triggered from.
+        /// </summary>
+        public string ContextMenuTargetId { get; protected set; }
+
+        /// <summary>
+        /// If set to true, then the <see cref="ContextMenu"/> will not hide.
+        /// </summary>
+        public bool PreventHide { get; set; }
+
+        /// <summary>
+        /// Extra data that were passed to the <see cref="ContextMenu"/>.
+        /// </summary>
+        public object Data { get; protected set; }
+    }
+}

BlazorContextMenu/Services/InternalContextMenuHandler.cs

@@ -11,7 +11,7 @@ namespace BlazorContextMenu
     public interface IInternalContextMenuHandler
     {
         bool ReferencePassedToJs { get; set; }
-        Task HideMenu(string id);
+        Task<bool> HideMenu(string id);
         Task ShowMenu(string id, string x, string y, string targetId = null, DotNetObjectReference<ContextMenuTrigger> trigger = null);
     }
 
@@ -50,13 +50,15 @@ public async Task ShowMenu(string id, string x, string y, string targetId = null
         /// </summary>
         /// <param name="id">The id of the menu.</param>
         [JSInvokable]
-        public async Task HideMenu(string id)
+        public async Task<bool> HideMenu(string id)
         {
             var menu = _contextMenuStorage.GetMenu(id);
             if (menu != null)
             {
-                await menu.Hide();
+                return await menu.Hide();
             }
+
+            return true;
         }
     }
 }

BlazorContextMenu/wwwroot/blazorContextMenu.js

@@ -122,9 +122,12 @@
                 if (menuElement && menuElement.dataset["autohide"] == "true") {
                     var clickedInsideMenu = menuElement.contains(e.target);
                     if (!clickedInsideMenu) {
-                        blazorContextMenu.Hide(openMenuId);
-                        openMenuId = null;
-                        openMenuTarget = null;
+                        blazorContextMenu.Hide(openMenuId).then(function (hideSuccessful) {
+                            if (hideSuccessful) {
+                                openMenuId = null;
+                                openMenuTarget = null;
+                            }
+                        });
                     }
                 }
             }
@@ -146,7 +149,7 @@
     }
 
     blazorContextMenu.Hide = function (menuId) {
-        menuHandlerReference.invokeMethodAsync('HideMenu', menuId);
+        return menuHandlerReference.invokeMethodAsync('HideMenu', menuId);
     }
 
     var subMenuTimeout = null;

README.md

@@ -240,7 +240,12 @@ public class Startup
 
 ## Release Notes
 
-<details open="open"><summary>1.2</summary>
+<details open="open"><summary>1.3</summary>
+
+>- Added menu `OnHiding` event [#68](https://github.com/stavroskasidis/BlazorContextMenu/issues/68).
+</details>
+
+<details><summary>1.2</summary>
 
 >- Fix for [#65](https://github.com/stavroskasidis/BlazorContextMenu/issues/65).
 </details>

TestApps/BlazorContextMenu.TestAppsCommon/CommonIndex.razor

@@ -63,6 +63,10 @@
     <p id="test11-trigger">Double click me (menu2 - with icons and sub-menus)</p>
 </ContextMenuTrigger>
 
+<ContextMenuTrigger MenuId="menu4">
+    <p id="test12-trigger">Right-Click me (menu4 unhideable)</p>
+</ContextMenuTrigger>
+
 
 <ContextMenu Id="menu1" Template="dark" OnAppearing="OnAppearingMenu1">
     <Item Id="menu1-item1" OnClick="FetchDataClick">Fetch Data</Item>
@@ -104,6 +108,11 @@
     <Item Id="menu3-item2" OnClick="OnClick">Item 2</Item>
 </ContextMenu>
 
+<ContextMenu Id="menu4" OnHiding="OnHiding">
+    <Item Id="menu4-item1" OnClick="OnClick">Item 1</Item>
+    <Item Id="menu4-item2" OnClick="OnClick">Item 2</Item>
+</ContextMenu>
+
 <div>
     <button id="showMenuBtn" @onclick="ShowMenuBtnOnClick">Show menu1 in 300x300 using handler</button>
     <button id="showNoAutoCloseBtn" @onclick="ShowNoAutoCloseBtnOnClick">Show menu1 in 300x300 using handler</button>
@@ -165,4 +174,9 @@
             e.PreventShow = true;
         }
     }
+
+    void OnHiding(MenuHidingEventArgs e)
+    {
+        e.PreventHide = true;
+    }
 }

Tests/BlazorContextMenu.TestsCommon/CommonTests/TestAppIndexTests.cs

@@ -333,6 +333,21 @@ public async Task Menu2_MouseOverSubMenuAndThenToSecondSubMenu_SecondSubMenuOpen
             Assert.Equal(expectedDisplay, display);
         }
 
-        
+        [Fact]
+        public async Task Menu4_TriggerAndClickOutside_MenuStaysOpen()
+        {
+            //Arrange
+            var expectedDisplay = "block";
+
+            //Act
+            await OpenContextMenuAt("test12-trigger", MouseButtonTrigger.Right);
+            var headerElement = Browser.FindElement(By.Id("header"));
+            headerElement.Click();
+
+            //Assert
+            var menuElement = Browser.FindElement(By.Id("menu4"));
+            var display = menuElement.GetCssValue("display");
+            Assert.Equal(expectedDisplay, display);
+        }
     }
 }