//vike-vue-pinia-coladabykevinmarrec

vike-vue-pinia-colada

Pinia Colada integration for vike-vue with SSR support

0
0
0
TypeScript

npm version

vike-vue-pinia-colada

Pinia Colada integration for vike-vue with SSR support.

Built on top of the same patterns as vike-vue-pinia, with added Pinia Colada query cache serialization/hydration.

[!NOTE]
Pinia is included — you don’t need vike-vue-pinia alongside this extension.

Installation

  1. npm install vike-vue-pinia-colada pinia @pinia/colada

  2. Extend +config.js:

    // pages/+config.js
    
    import vikeVuePiniaColada from 'vike-vue-pinia-colada/config'
    import vikeVue from 'vike-vue/config'
    
    export default {
      // ...
      extends: [vikeVue, vikeVuePiniaColada]
    }
    

Pinia Colada Options

You can pass options to the Pinia Colada plugin via the piniaColadaOptions config:

// pages/+config.js

export default {
  piniaColadaOptions: {
    queryOptions: {
      staleTime: 5000,
    },
  }
}

All options from PiniaColadaOptions are supported.

Why a separate extension?

Pinia Colada stores its query cache inside Pinia, but serializing it through Pinia’s standard state hydration doesn’t work reliably — cache keys can be functions, which aren’t serializable out of the box. This causes issues when relying solely on vike-vue-pinia for SSR.

The recommended approach is to use the dedicated helpers provided by Pinia Colada (serializeQueryCache / reviveQueryCache) to correctly serialize the query cache on the server and hydrate it on the client. This is exactly what this extension does under the hood.

See also

[beta]v0.14.0