Blazor.SessionStorage
2.0.11
See the version list below for details.
dotnet add package Blazor.SessionStorage --version 2.0.11
NuGet\Install-Package Blazor.SessionStorage -Version 2.0.11
<PackageReference Include="Blazor.SessionStorage" Version="2.0.11" />
paket add Blazor.SessionStorage --version 2.0.11
#r "nuget: Blazor.SessionStorage, 2.0.11"
// Install Blazor.SessionStorage as a Cake Addin
#addin nuget:?package=Blazor.SessionStorage&version=2.0.11
// Install Blazor.SessionStorage as a Cake Tool
#tool nuget:?package=Blazor.SessionStorage&version=2.0.11
Blazorators: The Source Generated sessionStorage
JavaScript Interop library for Blazor
The Blazor.SessionStorage
package consumes the Blazor.SourceGenerators
package. It exposes a source generated IStorageService
interface specific to Blazor WebAssembly and the sessionStorage
Web API.
Get started
After the NuGet package is added as a reference, call the AddSessionStorageServices
method to register the ISessionStorageService
service type.
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
builder.Services.AddSessionStorageServices();
builder.Services.AddRazorPages();
builder.Services.AddServerSideBlazor();
var app = builder.Build();
app.UseHttpsRedirection();
app.UseStaticFiles();
app.UseRouting();
app.MapControllers();
app.MapBlazorHub();
app.MapFallbackToPage("/_Host");
app.Run();
Anywhere needed within your Razor component, or Blazor client code — either @inject
or [Inject]
the ISessionStorageService
type. The interface takes the following shape:
using Blazor.Serialization.Extensions;
using System.Text.Json;
#nullable enable
namespace Microsoft.JSInterop;
/// <summary>
/// Source generated interface definition of the <c>Storage</c> type.
/// </summary>
public interface ISessionStorageService
{
/// <summary>
/// Source generated implementation of <c>window.sessionStorage.clear</c>.
/// <a href="https://developer.mozilla.org/docs/Web/API/Storage/clear"></a>
/// </summary>
ValueTask ClearAsync();
/// <summary>
/// Source generated implementation of <c>window.sessionStorage.getItem</c>.
/// <a href="https://developer.mozilla.org/docs/Web/API/Storage/getItem"></a>
/// </summary>
ValueTask<string?> GetItemAsync(string key);
/// <summary>
/// Source generated implementation of <c>window.sessionStorage.key</c>.
/// <a href="https://developer.mozilla.org/docs/Web/API/Storage/key"></a>
/// </summary>
ValueTask<string?> KeyAsync(double index);
/// <summary>
/// Source generated implementation of <c>window.sessionStorage.removeItem</c>.
/// <a href="https://developer.mozilla.org/docs/Web/API/Storage/removeItem"></a>
/// </summary>
ValueTask RemoveItemAsync(string key);
/// <summary>
/// Source generated implementation of <c>window.sessionStorage.setItem</c>.
/// <a href="https://developer.mozilla.org/docs/Web/API/Storage/setItem"></a>
/// </summary>
ValueTask SetItemAsync(string key, string value);
/// <summary>
/// Source generated implementation of <c>window.sessionStorage.length</c>.
/// <a href="https://developer.mozilla.org/docs/Web/API/Storage/length"></a>
/// </summary>
ValueTask<double> Length { get; }
}
Product | Versions |
---|---|
.NET | net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows |
-
net6.0
- Microsoft.Extensions.DependencyInjection (>= 6.0.0)
- Microsoft.Extensions.Primitives (>= 6.0.0)
- Microsoft.JSInterop (>= 6.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.