vuex-class

Binding helpers for Vuex and vue-class-component

Dependencies

• Vue
• Vuex
• vue-class-component

Installation

1$ npm install --save vuex-class
2# or
3$ yarn add vuex-class

Example

1import Vue from 'vue'
2import Component from 'vue-class-component'
3import {
4  State,
5  Getter,
6  Action,
7  Mutation,
8  namespace
9} from 'vuex-class'
10
11const someModule = namespace('path/to/module')
12
13@Component
14export class MyComp extends Vue {
15  @State('foo') stateFoo
16  @State(state => state.bar) stateBar
17  @Getter('foo') getterFoo
18  @Action('foo') actionFoo
19  @Mutation('foo') mutationFoo
20  @someModule.Getter('foo') moduleGetterFoo
21
22  // If the argument is omitted, use the property name
23  // for each state/getter/action/mutation type
24  @State foo
25  @Getter bar
26  @Action baz
27  @Mutation qux
28
29  created () {
30    this.stateFoo // -> store.state.foo
31    this.stateBar // -> store.state.bar
32    this.getterFoo // -> store.getters.foo
33    this.actionFoo({ value: true }) // -> store.dispatch('foo', { value: true })
34    this.mutationFoo({ value: true }) // -> store.commit('foo', { value: true })
35    this.moduleGetterFoo // -> store.getters['path/to/module/foo']
36  }
37}

Issue Reporting Guideline

Questions

For general usage question which is not related to vuex-class should be posted to StackOverflow or other Q&A forum. Such questions will be closed without an answer.

Bug Reports

Please make sure to provide minimal and self-contained reproduction when you report a bug. Otherwise the issue will be closed immediately.

License

MIT