BlazorRamp.DebounceFilter 1.1.0

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


                    

                
NuGet\Install-Package BlazorRamp.DebounceFilter -Version 1.1.0
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.DebounceFilter" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="BlazorRamp.DebounceFilter" Version="1.1.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="BlazorRamp.DebounceFilter" />
                    


                            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.DebounceFilter --version 1.1.0
                    


                    

                
#r "nuget: BlazorRamp.DebounceFilter, 1.1.0"
#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.DebounceFilter@1.1.0
#: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.DebounceFilter&version=1.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=BlazorRamp.DebounceFilter&version=1.1.0
                    


                            Install as a Cake Tool

Blazor Ramp - Debounce Filter

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

The BlazorRamp.DebounceFilter NuGet package contains a single component, the DebounceFilter. This is, in essence, a single text input styled like the other input components, however, there is no binding as the keystrokes and input value are handled in JavaScript using a timer. On each keystroke the timer is reset; once the timer elapses, the input value is checked against an optional Regex pattern, with the result of any validation and the input value handed to Blazor.

The component, rather than using a traditional EventCallback, uses a Func<DebouncedFilterResult, Task> to provide you with the result. Using a Func does not cause a re-render, which in this case is useful, as if the filter value is invalid you do not need your component to re-render. If the value is valid, you can then hand it to your component and call StateHasChanged to trigger

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.DebounceFilter NuGet package to your project using the NuGet Package Manager or the dotnet CLI.
dotnet add package BlazorRamp.DebounceFilter
  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.DebounceFilter/assets/css/debounce-filter.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 Debounce Filter

Add the filter next to or inside your component that needs a text filter. Set the paramters as desired and a handler for the OnDebounceFilterResult parameter in order to get the result of the filter after each debounce delay.

Validation is turned on if the RegexPattern parameter is provided.

<DebounceFilter DebounceDelayMs="500" 
                ValidationMessage="Invalid entry filtering paused, letters and numbers only" 
                RegexPattern="^[A-Za-z0-9]*$"
                FilterLabelText="Filter Results" 
                HintText="Data filtered on pause of typing." 
                OnDebounceFilterResult="HandleDebounce"  
                ParseErrorMessage="System error, filtering is unavailable at this time." />

@code{

    public async Task HandleDebounce(DebouncedFilterResult result)
    {
        if(result.IsValid)
        {
            var inputValue = result.FilterValue;
            /*
                * Pass the input value to your filtering mechanism 
                * And remember to inform Blazor as callback is using a Func not EventCallback.
            */
            await InvokeAsync(StateHasChanged); 
        }
    }

}

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.1.0 99 6/18/2026
1.0.0 99 6/17/2026

Added a Replayable parameter to DebounceFilter for controlling whether validation
announcements are logged to the announcement history.