vuebx v1.1.0

Vuebx

a lightweight state management library for vuejs

Example

// store/index.js
import vuebx from 'vuebx'

const state = {
  count: 1
}
const [getter, setter] = vuebx(state)
export default {
  getter,
  setter
}

// Counter.vue
<template>
  <p>{{ count }}<p>
  <p>
    <button v-on:click="increment">-</button>
    <button v-on:click="decrement">+</button>
  </p>
</template>
<script>
  import { getter, setter } from './store'
  export default {
    name: 'Counter',
    computed: {
      ...getter(['count'])
    },
    methods: {
      increment () {
        setter((state) => {
          return {
            count: state.count + 1
          }
        })
      },
      decrement () {
        setter((state) => {
          return {
            count: state.count - 1
          }
        })
      }
    }
  }
</script>

Install

npm install vuebx --save

Usage

vuebx receive default state and return two functions

const defaultState = {
  count1: 1,
  count2: 2
}
const [getter, setter] = vuebx(defaultState)

• getter

Getter is the same as mapGetters that provided by vuex, it can simply maps store getters to local computed properties.

export default {
  // ...
  computed: {
    ...getter(['count1', 'count2'])
  }
}

if you want to map a getter to a different name:

export default {
  // ...
  computed: {
    ...getter({
      count_1: 'count1',
      count_2: 'count2'
    })
  }
}

• setter

If you've used React before, You will be familiar with the function because it very similar to setState api.

// setter receive a new state object
setter(newState)

// or a function that will return a state object
setter((state) => {
  return {
    ...state,
    count: state.count + 1
  }
})

// setter will return a promise
setter(newState).then(() => {
  // as same as Vue.nextTick(() => {})
  // keep your state up to date
}) 

License

MIT