VDT.Core.Blazor.GlobalEventHandler
1.1.4
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package VDT.Core.Blazor.GlobalEventHandler --version 1.1.4
NuGet\Install-Package VDT.Core.Blazor.GlobalEventHandler -Version 1.1.4
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="VDT.Core.Blazor.GlobalEventHandler" Version="1.1.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add VDT.Core.Blazor.GlobalEventHandler --version 1.1.4
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: VDT.Core.Blazor.GlobalEventHandler, 1.1.4"
#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.
// Install VDT.Core.Blazor.GlobalEventHandler as a Cake Addin
#addin nuget:?package=VDT.Core.Blazor.GlobalEventHandler&version=1.1.4
// Install VDT.Core.Blazor.GlobalEventHandler as a Cake Tool
#tool nuget:?package=VDT.Core.Blazor.GlobalEventHandler&version=1.1.4
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
VDT.Core.Blazor.GlobalEventHandler
Blazor component that allows you to handle global window level events in your application.
Features
- Window-level keyboard events that don't require focus on any element
Usage
To register event handlers, simply include the GlobalEventHandler component on your page and register your event handler with the event in the component that you want to handle. The available events are:
OnKeyDown
which provides an optionalKeyboardEventArgs
parameterOnKeyUp
which provides an optionalKeyboardEventArgs
parameterOnResize
which provides an optionalResizeEventArgs
parameterOnClick
which provides an optionalMouseEventArgs
parameterOnMouseDown
which provides an optionalMouseEventArgs
parameterOnMouseUp
which provides an optionalMouseEventArgs
parameterOnMouseMove
which provides an optionalMouseEventArgs
parameterOnContextMenu
which provides an optionalMouseEventArgs
parameterOnDoubleClick
which provides an optionalMouseEventArgs
parameterOnScroll
which provides an optionalScrollEventArgs
parameter
Example
<GlobalEventHandler OnKeyDown="@OnWindowKeyDown" OnResize="@OnWindowResize" OnClick="@OnWindowClick" />
@if (keyDownEventArgs != null) {
<h2>Last key down event</h2>
<ul>
<li>Alt key: @keyDownEventArgs.AltKey</li>
<li>Code: @keyDownEventArgs.Code</li>
<li>Ctrl key: @keyDownEventArgs.CtrlKey</li>
<li>Key: @keyDownEventArgs.Key</li>
<li>Location: @keyDownEventArgs.Location</li>
<li>Meta key: @keyDownEventArgs.MetaKey</li>
<li>Repeat: @keyDownEventArgs.Repeat</li>
<li>Shift key: @keyDownEventArgs.ShiftKey</li>
<li>Type: @keyDownEventArgs.Type</li>
</ul>
}
@if (resizeEventArgs != null) {
<h2>Last resize event</h2>
<ul>
<li>Width: @resizeEventArgs.Width</li>
<li>Height: @resizeEventArgs.Height</li>
</ul>
}
@if (clicked) {
<h2>Clicked</h2>
}
@code {
private KeyboardEventArgs? keyDownEventArgs;
private ResizeEventArgs? resizeEventArgs;
private bool clicked = false;
// Handlers can be asynchronous ...
public async Task OnWindowKeyDown(KeyboardEventArgs args) {
keyDownEventArgs = args;
await Task.CompletedTask;
}
// ... Or synchronous
public void OnWindowResize(ResizeEventArgs args) {
resizeEventArgs = args;
}
// EventArgs are optional
public void OnWindowClick() {
clicked = true;
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 is compatible. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net5.0
- Microsoft.AspNetCore.Components.Web (>= 5.0.12)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
- Added example project
- Simplified javascript module
- Added fingerprint to javascript module