https://github.com/vue-electron/vuex-electron

Integration of Vuex and Electron
https://github.com/vue-electron/vuex-electron

electron javascript vue vuex

Last synced: about 2 months ago
JSON representation

Integration of Vuex and Electron

• Host: GitHub
• URL: https://github.com/vue-electron/vuex-electron
• Owner: vue-electron
• License: mit
• Created: 2018-09-07T05:17:51.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-19T15:21:18.000Z (4 months ago)
• Last Synced: 2024-07-25T20:22:50.656Z (about 2 months ago)
• Topics: electron, javascript, vue, vuex
• Language: JavaScript
• Homepage:
• Size: 443 KB
• Stars: 305
• Watchers: 5
• Forks: 97
• Open Issues: 59
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



# Vuex Electron

[![Travis](https://img.shields.io/travis/com/vue-electron/vuex-electron.svg?style=for-the-badge&longCache=true)](https://travis-ci.com/vue-electron/vuex-electron)

[![Code Climate](https://img.shields.io/codeclimate/maintainability/vue-electron/vuex-electron.svg?style=for-the-badge&longCache=true)](https://codeclimate.com/github/vue-electron/vuex-electron)

[![Code Climate](https://img.shields.io/codeclimate/coverage/vue-electron/vuex-electron.svg?style=for-the-badge&longCache=true)](https://codeclimate.com/github/vue-electron/vuex-electron)

[![Code Style Prettier](https://img.shields.io/badge/code%20style-prettier-brightgreen.svg?style=for-the-badge&longCache=true)](https://github.com/prettier/prettier)

[![Made With Love](https://img.shields.io/badge/made%20with-love-brightgreen.svg?style=for-the-badge&longCache=true)](https://github.com/MrEmelianenko)

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

### Features

:star: Persisted state  

:star: Shared mutations

### Requirements

- [Vue](https://github.com/vuejs/vue) v2.0+

- [Vuex](https://github.com/vuejs/vuex) v2.0+

- [Electron](https://github.com/electron/electron) v2.0+

### Installation

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

1. Install package with using of [yarn](https://github.com/yarnpkg/yarn) or [npm](https://github.com/npm/cli):

    ```

    yarn add vuex-electron

    ```

    or

    ```

    npm install vuex-electron

    ```

2. Include plugins in your Vuex store::

    ```javascript

    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`):

    ```javascript

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

    ```

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

**Usage example: [Vuex Electron Example](https://github.com/vue-electron/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.

### Options

Available options for `createPersistedState()`

```javascript

createPersistedState({

  whitelist: ["whitelistedMutation", "anotherWhitelistedMutation"],

  // or

  whitelist: (mutation) => {

    return true

  },

  // or

  blacklist: ["ignoredMutation", "anotherIgnoredMutation"],

  // or

  blacklist: (mutation) => {

    return true

  }

})

```

### Author

Andrew Emelianenko  

IG: [@truemelianenko](https://www.instagram.com/truemelianenko)

### License

[MIT License](https://github.com/vue-electron/vuex-electron/blob/master/LICENSE)