Stores ​

Overview ​

Spire doesn't have its own Store system, instead it relies on Pinia Stores.

Syncing to LocalStorage ​

If you need to sync your Store to local or session storage, you can use Spire's syncStoreLocal() helper.

This is an example of a sync of a store to localStorage that will replace all string dates to dayjs objects on restoring:

import { syncStoreLocal } from "@/toolkit"

syncStoreLocal(useCustomerStore(), (data, store) => {
    replaceDateRecursive(data)

    store.$state = data
})

If you need to sync to sessionStorage instead you can use syncStoreSession().

Default App Store ​

Spire provides an AppStore by default to take care of its own state, like what Layout and Language are currently active.

You can extend this Store with your own data as needed by passing your options into the CustomAppStore type in stores/app.store.ts:

type CustomAppStore = AppStore<{
    // myKey: boolean
}>