Blazorators: The Source Generated localStorage JavaScript Interop library for Blazor

The Blazor.LocalStorage package consumes the Blazor.SourceGenerators package. It exposes a source generated IStorageService interface specific to Blazor WebAssembly and the localStorage Web API.

Get started

After the NuGet package is added as a reference, call the AddLocalStorageServices method to register the ILocalStorageService service type.

var builder = WebApplication.CreateBuilder(args); // Add services to the container. builder.Services.AddLocalStorageServices(); 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 ILocalStorageService 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 ILocalStorageService { /// <summary> /// Source generated implementation of <c>window.localStorage.clear</c>. /// <a href="https://developer.mozilla.org/docs/Web/API/Storage/clear"></a> /// </summary> ValueTask ClearAsync(); /// <summary> /// Source generated implementation of <c>window.localStorage.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.localStorage.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.localStorage.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.localStorage.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.localStorage.length</c>. /// <a href="https://developer.mozilla.org/docs/Web/API/Storage/length"></a> /// </summary> ValueTask<double> Length { get; } }