Blazored SessionStorage

A library to provide access to session storage in Blazor applications

Installing

You can install from NuGet using the following command:

Install-Package Blazored.SessionStorage

Or via the Visual Studio package manager.

Setup

You will need to register the session storage services with the service collection in your Startup.cs file in Blazor Server.

public void ConfigureServices(IServiceCollection services)
{
    services.AddBlazoredSessionStorage();
}

Or in your Program.cs file in Blazor WebAssembly.

public static async Task Main(string[] args)
{
    var builder = WebAssemblyHostBuilder.CreateDefault(args);
    builder.RootComponents.Add<App>("app");

    builder.Services.AddBlazoredSessionStorage();

    await builder.Build().RunAsync();
}

Configuration

The session storage provides options that can be modified by you at registration in your Startup.cs file in Blazor Server.

public void ConfigureServices(IServiceCollection services)
{
    services.AddBlazoredSessionStorage(config =>
        config.JsonSerializerOptions.WriteIndented = true);
}

Or in your Program.cs file in Blazor WebAssembly.

public static async Task Main(string[] args)
{
    var builder = WebAssemblyHostBuilder.CreateDefault(args);
    builder.RootComponents.Add<App>("app");

    builder.Services.AddBlazoredSessionStorage(config =>
        config.JsonSerializerOptions.WriteIndented = true);

    await builder.Build().RunAsync();
}

Usage (Blazor WebAssembly)

To use Blazored.SessionStorage in Blazor WebAssembly, inject the ISessionStorageService per the example below.

@inject Blazored.SessionStorage.ISessionStorageService sessionStorage

@code {

    protected override async Task OnInitializedAsync()
    {
        await sessionStorage.SetItemAsync("name", "John Smith");
        var name = await sessionStorage.GetItemAsync<string>("name");
    }

}

With Blazor WebAssembly you also have the option of a synchronous API, if your use case requires it. You can swap the ISessionStorageService for ISyncSessionStorageService which allows you to avoid use of async/await. For either interface, the method names are the same.

@inject Blazored.SessionStorage.ISyncSessionStorageService sessionStorage

@code {

    protected override void OnInitialized()
    {
        sessionStorage.SetItem("name", "John Smith");
        var name = sessionStorage.GetItem<string>("name");
    }

}

Usage (Blazor Server)

NOTE: Due to pre-rendering in Blazor Server you can't perform any JS interop until the OnAfterRender lifecycle method.

@inject Blazored.SessionStorage.ISessionStorageService sessionStorage

@code {

    protected override async Task OnAfterRenderAsync(bool firstRender)
    {
        await sessionStorage.SetItemAsync("name", "John Smith");
        var name = await sessionStorage.GetItemAsync<string>("name");
    }

}

The APIs available are:

• asynchronous via ISessionStorageService:

  • SetItemAsync()
  • GetItemAsync()
  • RemoveItemAsync()
  • ClearAsync()
  • LengthAsync()
  • KeyAsync()
  • ContainsKeyAsync()

• synchronous via ISyncSessionStorageService (Synchronous methods are only available in Blazor WebAssembly):

  • SetItem()
  • GetItem()
  • RemoveItem()
  • Clear()
  • Length()
  • Key()
  • ContainsKey()

Note: Blazored.SessionStorage methods will handle the serialisation and de-serialisation of the data for you.