BlazorRamp.NavGroup 1.0.2

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package BlazorRamp.NavGroup --version 1.0.2
                    


                    

                
NuGet\Install-Package BlazorRamp.NavGroup -Version 1.0.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="BlazorRamp.NavGroup" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="BlazorRamp.NavGroup" Version="1.0.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="BlazorRamp.NavGroup" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add BlazorRamp.NavGroup --version 1.0.2
                    


                    

                
#r "nuget: BlazorRamp.NavGroup, 1.0.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package BlazorRamp.NavGroup@1.0.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=BlazorRamp.NavGroup&version=1.0.2
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=BlazorRamp.NavGroup&version=1.0.2
                    


                            Install as a Cake Tool

Blazor Ramp - NavGroup

The Blazor Ramp project aims to provide a suite of modular, accessibility-first Blazor components.

Requirements

It is a requirement that the Blazor Ramp Core script, Live Region Service, and associated Announcement History component are added alongside this component’s specific requirements (a stylesheet reference), as outlined below.

Note: Every package includes a reference to the Blazor Ramp Core project (where the aforementioned items reside) so there is no need to install this package separately (but it can be if you only require the Live Regions Service and Announcement History component).

The full documentation is available at: https://docs.blazorramp.uk

Installation

  1. Add the BlazorRamp.NavGroup nuget package to your project using the Nuget Package Manager or the dotnet CLI.
dotnet add package BlazorRamp.NavGroup
  1. Add the following Core and NavGroup style references to the <head> section of your application:
  • Blazor Web App / Blazor Server → App.razor
  • Blazor WebAssembly → wwwroot/index.html
<head>
	<link rel="stylesheet" href="_content/BlazorRamp.Core/assets/css/core.min.css" />
	<link rel="stylesheet" href="_content/BlazorRamp.NavGroup/assets/css/nav-group.min.css" />
</head>
  1. Add the following Blazor Ramp Core live region script after Blazors script, as follows:
  • Blazor Web App / Blazor Server → App.razor
  • Blazor WebAssembly → wwwroot/index.html
<script src="_framework/blazor.web.js"></script>
<script type="module" src="_content/BlazorRamp.Core/assets/js/core-live-region.js"></script>
  1. Register BlazorRamp services in the Program.cs file (Both server and client if using Server and WebAssembly interactive rendermode)

Add the following line to the service registration section:

@using BlazorRamp.Core.Common.Extensions;

builder.Services.AddBlazorRampCore();
  1. Add the <AnnouncementHistory /> component with your parameter values above the Router component contained in either:
  • Blazor Web App / Blazor Server → Routes.razor
  • Blazor WebAssembly → App.razor
<AnnouncementHistory RefreshText="Refresh" ClearCloseText="Clear & Close" CloseText="Close" NoDataText="No announcements" 
Title="Recent Announcements" TriggerVisible="true" TriggerText="Alerts" />

<Router AppAssembly . . .

Using the NavGroup component

The Nav Group component is designed to be used within an HTMLnav element. It uses what is known as a "disclosure" pattern in accessibility terms, meaning it has a button that, when pressed, shows or hides content. In this instance it pushes content out of the way, as opposed to a dropdown where a panel may obscure content, and as such was designed for side navigation systems. in fact, the reason it was built was for the Blazor Ramp documenation site.

The Nav Group itself can contain NavGroupLink components, NavSection components (which provide the disclosure behaviour), or a NavSeparator (decorative line / separator). Each NavSection can in turn contain NavGroupLink, NavSeparator and NavSection components allowing you to build 'N'-level deep menu systems.

The following example (at time or writing) is the Frameworks section of the Blazor Ramp documenation site:

<h2 id="framework-section" class="main-menu__heading">Frameworks</h2>
<NavGroup AriaLabelledBy="framework-section">
    <NavSeparator />
    <NavSection Title="Modal Dialog">
        <NavGroupLink Href="/frameworks/modal-dialog/overview" VisuallyHiddenPrefix="Modal Dialogl" LinkText="Overview" />
        <NavGroupLink Href="/frameworks/modal-dialog/installation" VisuallyHiddenPrefix="Modal Dialog" LinkText="Installation" />
        <NavGroupLink Href="/frameworks/modal-dialog/accessibility" VisuallyHiddenPrefix="Modal Dialog" LinkText="Accessibility" />
        <NavGroupLink Href="/frameworks/modal-dialog/api" VisuallyHiddenPrefix="Modal Dialog" LinkText="API Reference" />
        <NavGroupLink Href="/frameworks/modal-dialog/usage" VisuallyHiddenPrefix="Modal Dialog" LinkText="Usage" />
    </NavSection>    
</NavGroup>

Note: For the full documentation please see https://docs.blazorramp.uk

Using the Live Region Service (directly)

Inject the ILiveRegionService into your desired component or class and make the appropriate calls by passing the ILiveRegionSerivce.MakeAnnouncement method an announcement object.

@inject ILiveRegionService _liveRegionService

@code{

	private async Task MakeAnnouncement()
	{
		var announcement = new Announcement("The site is now using a dark coloured theme.", AnnouncementType.Info, "Dark Theme Switch", LiveRegionType.Polite);
		await _liveRegionService.MakeAnnouncement(announcement);
	}
}

Note: Where possible make announcements using LiveRegionType.Polite and keep your messages brief and to the point. Long verbose messages are annoying and just slow the user down.

The announcement object has the following constructor parameters:

  • Message - a string value containing the message to be announced.
  • AnnouncementType - an enumerated type describing the type category of announcement (for future use) the default is AnnoucementType.Info,
  • AnnouncementTrigger - an optional string value with the user friendly display name of the element that triggered the announcement such as 'Save Button'
  • LiveRegionType - the urgency of the announcement. Polite announcements wait for the screen reader to finish current speech before announcing where as assertive announcements interrupt the screen reader immediately.

Full documentation available at: https://docs.blazorramp.uk

Screen Reader Browser Combination Tests:

  • On Windows 11 - JAWS, NVDA and Narrator each paired with Chrome, Edge and Firefox.
  • On macOS (Sequoia) VoiceOver was paired with Safari
  • On iPhone, VoiceOver was paired with Safari
  • On Android, TalkBack was paired with Chrome
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.2 97 4/26/2026
1.0.1 98 4/22/2026
1.0.0 95 4/22/2026

Enabled the NoIndent parameter on the NavSection so each section can turn off its child indenting if necessary.