Snail.Toolkit.Blazor.Extensions.LocalStorage 1.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Snail.Toolkit.Blazor.Extensions.LocalStorage --version 1.0.0
                    
NuGet\Install-Package Snail.Toolkit.Blazor.Extensions.LocalStorage -Version 1.0.0
                    
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="Snail.Toolkit.Blazor.Extensions.LocalStorage" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Snail.Toolkit.Blazor.Extensions.LocalStorage" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Snail.Toolkit.Blazor.Extensions.LocalStorage" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Snail.Toolkit.Blazor.Extensions.LocalStorage --version 1.0.0
                    
#r "nuget: Snail.Toolkit.Blazor.Extensions.LocalStorage, 1.0.0"
                    
#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.
#:package Snail.Toolkit.Blazor.Extensions.LocalStorage@1.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Snail.Toolkit.Blazor.Extensions.LocalStorage&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Snail.Toolkit.Blazor.Extensions.LocalStorage&version=1.0.0
                    
Install as a Cake Tool

Toolkit.Blazor.Extensions.LocalStorage

Secure client-side localStorage implementation for Blazor applications with automatic encryption.

NuGet Version MIT License

Features

  • Secure Storage: All values automatically encrypted using AES encryption
  • Type Safety: Strongly-typed get/set operations for complex objects
  • Full API Coverage: Complete implementation of the localStorage API
  • Async Operations: All methods are async for Blazor compatibility
  • Cancellation Support: Built-in support for CancellationToken

Installation

dotnet add package Snail.Toolkit.Blazor.Extensions.LocalStorage

Configuration

Basic Setup

builder.Services.AddLocalStorage();

With Custom Encryption

builder.Services.AddLocalStorage(options => 
{
    options.EncryptionKey = "your-256-bit-secret";
    options.IV = "your-16-byte-IV"; // Optional
});

Using AppSettings Configuration

{
  "Cryptography": {
    "EncryptionKey": "your-secure-key",
    "Iterations": 10000
  }
}
builder.Services.AddLocalStorage(builder.Configuration);

Usage

Dependency Injection

@inject ILocalStorage localStorage

Basic Operations

Store data:

await localStorage.SaveStringAsync("username", "john.doe");
await localStorage.SaveObjectAsync("user", new { Id = 1, Name = "John" });

Retrieve data:

var username = await localStorage.GetStringAsync("username");
var user = await localStorage.GetObjectAsync<User>("user");

Check existence:

var exists = await localStorage.ContainKeyAsync("username");

Remove data:

await localStorage.RemoveAsync("username");

Advanced Operations

Get all keys:

var allKeys = await localStorage.KeysAsync();

Clear storage:

await localStorage.ClearAsync();

Encryption Details

All values are encrypted using AES-256-CBC before being stored in localStorage, providing protection against:

  • XSS attacks that might access localStorage
  • Browser extensions reading localStorage
  • Basic snooping of localStorage data

Note: While values are encrypted, keys remain visible in localStorage.

Browser Support

Works with all modern browsers that support:

  • Web Storage API
  • Web Cryptography API (for encryption)
  • Blazor WebAssembly (client-side)

License

Toolkit.Blazor.Extensions.LocalStorage is released under the MIT License.

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
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

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 230 6/13/2025
1.0.0 127 6/1/2025