SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Type Alias PersistentStateProviderProps

    type PersistentStateProviderProps = {
        children: React.ReactNode;
        debounceMs?: number;
        defaultValues?: Readonly<Record<string, unknown>>;
        namespace?: string;
        onReady?: (callback: () => void) => void;
        serializer?: PersistenceSerializer;
        store: PersistenceStore;
    }
    Index
    children debounceMs? defaultValues? namespace? onReady? serializer? store
    children: React.ReactNode

    Children elements that will have access to the persistence context.

    Required for provider

    debounceMs?: number

    Debounce time in milliseconds for state updates.

    150

    defaultValues?: Readonly<Record<string, unknown>>

    Default values by key, used for any key with no stored value.

    Lets a host change the starting value of user-adjustable state without taking the choice away from the user — for example, enabling the dark grid by default while the user can still turn it off.

    Keys are the same logical keys passed to usePersistentState (without the namespace). Values are the typed values, not serialized strings. A value here wins over the default passed to usePersistentState; a stored value wins over both. Defaults are never written to the store, so changing one later applies to every user who has not made a choice.

    none
    namespace?: string

    Namespace prefix for all keys

    none
    onReady?: (callback: () => void) => void

    Callback invoked when the store is ready to be used.

    serializer?: PersistenceSerializer

    Convert the value to/from a string for storage.

    JSON.parse / JSON.stringify

    store: PersistenceStore

    Storage backend to use

    Settings
    Member Visibility

    On This Page
    Properties