TimeWarp.State.Plus 12.0.0-beta.5

TimeWarp.State.Plus

TimeWarp.State.Plus extends TimeWarp.State with additional, features, middleware and components to simplify and enhance your Blazor applications.

TimeWarp.State.Plus

TimeWarp.State.Plus extends the core functionality with additional features:

Available Middleware

• PersistentState
  • Key Feature: Automates the persistence of state in browser storage.
  • Usage: Annotate a top-level state with [PersistentState(PersistentStateMethod.SessionStorage)] or LocalStorage.
  • Host: AddBlazoredSessionStorage / AddBlazoredLocalStorage, AddScoped<IPersistenceService, PersistenceService>(), and [assembly: MediatorBehavior(typeof(PersistentStatePostProcessor<,>), order: 520, Scope = typeof(ClientPipeline))]. Auto-load sends LoadPersistentStateRequest.
  • Storage keys: New writes use the state's FullName so two types with the same simple name do not collide. Load tries FullName first, then the simple Name, so existing browser entries are not dropped. There is no migration framework.
  • JSON: Save and load use TimeWarpStateOptions.JsonSerializerOptions (the same options as Store and JsonRequestHandler). Configure converters there so persisted state round-trips. Load is property-name case-insensitive so leftover PascalCase entries still hydrate.
  • Sample: samples/05-persistence.
• MultiTimer System: A flexible framework for managing multiple timers in your application.
  • It supports configurable timers
  • Activity-based resets.

Available Components

• TwBreadcrumb
  • Key Feature: RouteState history trail with back navigation.
  • Usage: <TwBreadcrumb MaxLinks="3" />
  • Styling: Isolated CSS (tw-breadcrumb). Hosts do not need Bootstrap.
• TwPageTitle
  • Key Feature: Records the page title onto RouteState for the breadcrumb trail.
  • Usage: <TwPageTitle>Home</TwPageTitle>
• InputColor
  • Key Feature: A color picker input component.
  • Usage: <InputColor @bind-Value="Color" />
  • ValueType: System.Drawing.Color

Available Features

• ThemeState
  • Key Feature: Manages the CurrentTheme of your application (Light, Dark, System).
  • Actions: UpdateTheme

Give a Star! ⭐

If you find this project useful, please give it a star. Thanks!

Getting Started

For a quick start, refer to the middleware section in the full Documentation.

Installation

dotnet add package TimeWarp.State.Plus

Check out the latest NuGet packages on the TimeWarp NuGet page.

• TimeWarp.State.Plus

Releases

View the Release Notes for detailed information on each release.

UnLicense

This project is licensed under the Unlicense.

Contributing

Your contributions are welcome! Before starting any work, please open a discussion.

Help with the documentation is also greatly appreciated.

Contact

If you have an issue and don't receive a timely response, feel free to reach out on our Discord server.