A library to provide access to local storage in Blazor applications
Switch branches/tags
Nothing to show
Clone or download

README.md

BlazoredLocalStorage

A library to provide access to local storage in Blazor applications

NuGet

Build Status

Installing

You can install from Nuget using the following command:

Install-Package BlazoredLocalStorage

Or via the Visual Studio package manger.

Setup

First, you will need to register local storage with the service collection in your startup.cs file

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

Usage

This is an example of using local storage in a .cshtml file

@inject Blazored.Storage.ILocalStorage localStorage

@functions {

    protected override async Task OnInitAsync()
    {
        await localStorage.SetItem("name", "John Smith");
        var name = await localStorage.GetItem<string>("name");
    }

}

The APIs available are

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

All APIs are now async

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