Crate tauri_plugin_zustand

tauri-plugin-zustand

Persistent Zustand stores for Tauri and React.

Features

• Save your stores to disk.
• Synchronize across multiple windows.
• Debounce or throttle store updates.
• Access the stores from both JavaScript and Rust.

Documentation

Check the documentation for more information on how to install and use the plugin.

Plugins

Currently, the following plugins are available:

Name	Version	Works with
tauri-store		Everything
@tauri-store/pinia		Vue, Nuxt
@tauri-store/svelte		Svelte
@tauri-store/valtio		React
@tauri-store/zustand		React

Supported Tauri Version

The plugins require Tauri 2.0 or later.

Structs

Builder

Builder for the Zustand plugin.

Migrationunstable-migration

A migration step.

MigrationContextunstable-migration

Context for a migration step.

Store

A key-value store that can persist its state to disk.

StoreCollection

A collection of stores. This is the core component for store plugins.

StoreId

Unique identifier for a store.

StoreOptions

Options to configure the store behavior.

StoreState

Internal state of a store.

WatcherId

Unique watcher identifier.

Zustand

The Zustand plugin.

Enums

Error

Runtime errors for the stores.

Json

Represents any valid JSON value.

SaveStrategy

The strategy to use when saving a store.

Traits

ManagerExt

Extension for the Manager trait providing access to the Zustand plugin.

Functions

init

Initializes the plugin with the default settings.

with_store

Calls a closure with a mutable reference to the store with the given id.

Type Aliases

BoxResult

A Result type with a boxed error.

OnLoadFn

Closure to be called when a store is loaded.

Result

A Result type with Error as the error variant.