Blazor.LocalStorage 9.0.1

dotnet add package Blazor.LocalStorage --version 9.0.1                
NuGet\Install-Package Blazor.LocalStorage -Version 9.0.1                
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="Blazor.LocalStorage" Version="9.0.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Blazor.LocalStorage --version 9.0.1                
#r "nuget: Blazor.LocalStorage, 9.0.1"                
#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 Blazor.LocalStorage as a Cake Addin
#addin nuget:?package=Blazor.LocalStorage&version=9.0.1

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

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 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. 
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 (2)

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

Repository Stars
dotnet/samples
Sample code referenced by the .NET documentation
ZaqueuCavalcante/syki
Full Education Management System.
Version Downloads Last updated
9.0.1 237 12/1/2024
9.0.0 182 11/22/2024
8.0.0 12,037 11/17/2023
8.0.0-rc.2.23480.2 86 10/13/2023
7.0.3 1,876 2/15/2023
7.0.2 328 2/7/2023
7.0.1 357 1/24/2023
7.0.0 439 1/11/2023
2.0.11 5,195 10/10/2022
2.0.10 1,863 5/19/2022
2.0.9 1,761 4/18/2022
2.0.8 452 4/14/2022
2.0.7 429 4/14/2022
2.0.6 452 4/7/2022
2.0.5 448 4/5/2022
2.0.4 427 4/5/2022
2.0.3 451 4/5/2022
2.0.2 460 4/4/2022