Fluxor.Persistence 1.0.9

Fluxor.Persistence

Fluxor.Persistence is a seamless extension to Fluxor that introduces state persistence. It allows you to save and restore your application's state using your preferred storage mechanism.

Getting Started

Installation

You can install the package via NuGet:

dotnet add package Fluxor.Persistence

Configuration

Integrate the persistence mechanism into your project by configuring Fluxor in your Program.cs:

builder.Services.AddFluxor(options =>
{
    options.ScanAssemblies(typeof(Program).Assembly);
    options.UsePersist(cfg =>
    {
        cfg.ForState<CounterState>().AddFullStatePersistence();

        cfg.ForState<WeatherState>()
            .AddPropertyPersistence(x => x.SelectedCity)
            .AddPropertyPersistence(x => x.TemperatureUnit);
    });
});

Handling Nested Properties

Fluxor.Persistence also supports nested properties. Here's how you can configure it:

cfg.ForState<UserSettings>()
    .AddPropertyPersistence(x => x.Theme.Colours.Pallette)
    .AddPropertyPersistence(x => x.Theme.IsDarkTheme);

Custom Persistence Service

By default, the extension uses Blazored.LocalStorage for storing state. If you need a different storage solution, implement the IPersistenceService interface:

internal sealed class InMemoryPersistenceService : IPersistenceService
{
    private readonly ConcurrentDictionary<string, string> _storage = new();

    public ValueTask<string?> GetItemAsStringAsync(string storageKey)
    {
        _storage.TryGetValue(storageKey, out var value);
        return ValueTask.FromResult<string?>(value);
    }

    public ValueTask SetItemAsStringAsync(string storageKey, string value)
    {
        _storage[storageKey] = value;
        return ValueTask.CompletedTask;
    }
}

Then, register your custom service:

builder.Services.AddScoped<IPersistenceService, InMemoryPersistenceService>();

Examples

For practical implementations, check out the Blazor WASM example:

• Blazor WASM Example: FluxorPersistence.Blazor.Wasm

Demonstration

Check out the following GIF to see state persistence in action within a Blazor WASM application:

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests for improvements and new features.

Publishing a New Version

To publish a new version of the library to the NuGet registry create a new release in the GitHub repository, the release event will automatically publish the package.

License

This project is licensed under the MIT License.