Add NotFoundPage.

Author: ilonatommy

src/Components/Components/src/PublicAPI.Unshipped.txt

@@ -1,6 +1,8 @@
 #nullable enable
 Microsoft.AspNetCore.Components.NavigationManager.NotFoundEvent -> System.EventHandler<System.EventArgs!>!
 virtual Microsoft.AspNetCore.Components.NavigationManager.NotFound() -> void
+Microsoft.AspNetCore.Components.Routing.Router.NotFoundPage.get -> System.Type!
+Microsoft.AspNetCore.Components.Routing.Router.NotFoundPage.set -> void
 Microsoft.AspNetCore.Components.Infrastructure.ComponentStatePersistenceManager.ComponentStatePersistenceManager(Microsoft.Extensions.Logging.ILogger<Microsoft.AspNetCore.Components.Infrastructure.ComponentStatePersistenceManager!>! logger, System.IServiceProvider! serviceProvider) -> void
 Microsoft.AspNetCore.Components.Infrastructure.ComponentStatePersistenceManager.SetPlatformRenderMode(Microsoft.AspNetCore.Components.IComponentRenderMode! renderMode) -> void
 Microsoft.AspNetCore.Components.Infrastructure.RegisterPersistentComponentStateServiceCollectionExtensions

src/Components/Components/src/Routing/Router.cs

@@ -3,6 +3,7 @@
 
 #nullable disable warnings
 
+using System.Diagnostics.CodeAnalysis;
 using System.Reflection;
 using System.Reflection.Metadata;
 using System.Runtime.ExceptionServices;
@@ -70,6 +71,13 @@ static readonly IReadOnlyDictionary<string, object> _emptyParametersDictionary
     [Parameter]
     public RenderFragment NotFound { get; set; }
 
+    /// <summary>
+    /// Gets or sets the page content to display when no match is found for the requested route.
+    /// </summary>
+    [Parameter]
+    [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)]
+    public Type NotFoundPage { get; set; } = default!;
+
     /// <summary>
     /// Gets or sets the content to display when a match is found for the requested route.
     /// </summary>
@@ -132,6 +140,22 @@ public async Task SetParametersAsync(ParameterView parameters)
             throw new InvalidOperationException($"The {nameof(Router)} component requires a value for the parameter {nameof(Found)}.");
         }
 
+        if (NotFoundPage != null)
+        {
+            if (!typeof(IComponent).IsAssignableFrom(NotFoundPage))
+            {
+                throw new InvalidOperationException($"The type {NotFoundPage.FullName} " +
+                    $"does not implement {typeof(IComponent).FullName}.");
+            }
+
+            var routeAttributes = NotFoundPage.GetCustomAttributes(typeof(RouteAttribute), inherit: true);
+            if (routeAttributes.Length == 0)
+            {
+                throw new InvalidOperationException($"The type {NotFoundPage.FullName} " +
+                    $"does not have a {typeof(RouteAttribute).FullName} applied to it.");
+            }
+        }
+
         if (!_onNavigateCalled)
         {
             _onNavigateCalled = true;
@@ -327,7 +351,22 @@ private void OnNotFound(object sender, EventArgs args)
         if (_renderHandle.IsInitialized)
         {
             Log.DisplayingNotFound(_logger);
-            _renderHandle.Render(NotFound ?? DefaultNotFoundContent);
+            _renderHandle.Render(builder =>
+            {
+                if (NotFoundPage != null)
+                {
+                    builder.OpenComponent(0, NotFoundPage);
+                    builder.CloseComponent();
+                }
+                else if (NotFound != null)
+                {
+                    NotFound(builder);
+                }
+                else
+                {
+                    DefaultNotFoundContent(builder);
+                }
+            });
         }
     }
 

src/Components/test/E2ETest/Tests/GlobalInteractivityTest.cs

@@ -22,12 +22,16 @@ public class GlobalInteractivityTest(
 {
 
     [Theory]
-    [InlineData("server", true)]
-    [InlineData("webassembly", true)]
-    [InlineData("ssr", false)]
-    public void CanRenderNotFoundInteractive(string renderingMode, bool isInteractive)
+    [InlineData("server", true, false)]
+    [InlineData("webassembly", true, false)]
+    [InlineData("server", true, true)]
+    [InlineData("webassembly", true, true)]
+    [InlineData("ssr", false, true)]
+    [InlineData("ssr", false, false)]
+    public void CanRenderNotFoundPage(string renderingMode, bool isInteractive, bool useCustomNotFoundPage)
     {
-        Navigate($"/subdir/render-not-found-{renderingMode}");
+        string query = useCustomNotFoundPage ? "?useCustomNotFoundPage=true" : "";
+        Navigate($"{ServerPathBase}/render-not-found-{renderingMode}{query}");
 
         if (isInteractive)
         {
@@ -36,8 +40,16 @@ public void CanRenderNotFoundInteractive(string renderingMode, bool isInteractiv
             Browser.Exists(By.Id(buttonId)).Click();
         }
 
-        var bodyText = Browser.FindElement(By.TagName("body")).Text;
-        Assert.Contains("There's nothing here", bodyText);
+        if (useCustomNotFoundPage)
+        {
+            var infoText = Browser.FindElement(By.Id("test-info")).Text;
+            Assert.Contains("Welcome On Custom Not Found Page", infoText);
+        }
+        else
+        {
+            var bodyText = Browser.FindElement(By.TagName("body")).Text;
+            Assert.Contains("There's nothing here", bodyText);
+        }
     }
 
     [Fact]

src/Components/test/testassets/Components.WasmMinimal/Pages/CustomNotFoundPage.razor

@@ -0,0 +1,4 @@
+@page "/render-custom-not-found-page"
+
+<h3 id="test-info">Welcome On Custom Not Found Page</h3>
+<p>Sorry, the page you are looking for does not exist.</p>

src/Components/test/testassets/Components.WasmMinimal/Routes.razor

@@ -1,6 +1,29 @@
 @using Microsoft.AspNetCore.Components.Routing
 
-<Router AppAssembly="@typeof(Program).Assembly">
+@using Components.WasmMinimal.Pages
+@inject NavigationManager NavigationManager
+
+@code {
+    private Type? NotFoundPageType { get; set; }
+
+    protected override void OnInitialized()
+    {
+        var uri = NavigationManager.ToAbsoluteUri(NavigationManager.Uri);
+        var query = System.Web.HttpUtility.ParseQueryString(uri.Query);
+        var useCustomNotFoundPage = query["useCustomNotFoundPage"];
+
+        if (useCustomNotFoundPage == "true")
+        {
+            NotFoundPageType = typeof(CustomNotFoundPage);
+        }
+        else
+        {
+            NotFoundPageType = null;
+        }
+    }
+}
+
+<Router AppAssembly="@typeof(Program).Assembly" NotFoundPage="NotFoundPageType">
     <Found Context="routeData">
         <RouteView RouteData="@routeData" />
         <FocusOnNavigate RouteData="@routeData" Selector="h1" />