Blazor.LocalStorage 2.0.10

.NET 6.0
NuGet\Install-Package Blazor.LocalStorage -Version 2.0.10
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.
dotnet add package Blazor.LocalStorage --version 2.0.10
<PackageReference Include="Blazor.LocalStorage" Version="2.0.10" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Blazor.LocalStorage --version 2.0.10
#r "nuget: Blazor.LocalStorage, 2.0.10"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Blazor.LocalStorage as a Cake Addin
#addin nuget:?package=Blazor.LocalStorage&version=2.0.10

// Install Blazor.LocalStorage as a Cake Tool
#tool nuget:?package=Blazor.LocalStorage&version=2.0.10

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; }
}
Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Blazor.LocalStorage:

Repository Stars
dotnet/orleans
Cloud Native application framework for .NET
Version Downloads Last updated
2.0.10 533 5/19/2022
2.0.9 524 4/18/2022
2.0.8 96 4/14/2022
2.0.7 84 4/14/2022
2.0.6 96 4/7/2022
2.0.5 88 4/5/2022
2.0.4 81 4/5/2022
2.0.3 85 4/5/2022
2.0.2 91 4/4/2022