Vuex Electron

The easiest way to share your Vuex Store between all processes (including main).

Features

⭐ Persisted state
⭐ Shared mutations

Requirements

• Vue v2.0+
• Vuex v2.0+
• Electron v2.0+

Installation

Installation of the Vuex Electron easy as 1-2-3.

1. Install package with using of yarn or npm:

   yarn install vuex-electron
   

   or

   npm install vuex-electron
   

2. Include plugins in your Vuex store::

   import Vue from "vue"
   import Vuex from "vuex"
   
   import { createPersistedState, createSharedMutations } from "vuex-electron"
   
   Vue.use(Vuex)
   
   export default new Vuex.Store({
     // ...
     plugins: [
       createPersistedState(),
       createSharedMutations()
     ],
     // ...
   })

3. In case if you enabled createSharedMutations() plugin you need to create an instance of store in the main process. To do it just add this line into your main process (for example src/main.js):

   import './path/to/your/store'

4. Well done you did it! The last step is to add the star to this repo 😄

Usage example: Vuex Electron Example

IMPORTANT

In renderer process to call actions you need to use dispatch or mapActions. Don't use commit because actions fired via commit will not be shared between processes.

Breaking changes

[Deprecated] The whitelist and blacklist features do not work, and have been replaced by the ignoredPaths, ignoredCommits and invertIgnored options.

Options

Available options for createPersistedState()

createPersistedState({
  // Inverts the ignoredPaths and ignoredCommits settings
  invertIgnored: true,
  
  // Ignores specific paths on the state object, when persisting.
  ignoredPaths: ["a.path.on.state", "another.path"],
  
  // Specifies commits that will not trigger a persistance update.
  ignoredCommits: ["increment"],
  // or a variation using a function
  ignoredCommits: (mutation) => {
    return true // Return true for mutations that should not trigger an update
  }
})

Author

Andrew Emelianenko
IG: @truemelianenko

License

MIT License