πŸ”₯Firebase bindings for Vuex (Vue.js)
Switch branches/tags
Clone or download

README.md

VuexFire Build Status npm package coverage size

SSR ready Firebase binding for Vuex

Supports only Vue 2, Vuex 2 and Firebase JavaScript SDK 2/3/4. If you need an older version check the v1 branch: npm i -D vuexfire@v1

If you are looking for a version compatible with Firestore, it's over here

Installation

  1. Using a CDN:
<script src="https://unpkg.com/vuexfire"></script>
  1. In module environments, e.g CommonJS:
npm install vue firebase vuexfire --save

Usage

Add the mutations to your root Store and make sure to define the property you want to bind in the state first:

import { firebaseMutations } from 'vuexfire'
const store = new Vuex.Store({
  state: {
    todos: [], // Will be bound as an array
    user: null // Will be bound as an object
  },
  mutations: {
    // your mutations
    ...firebaseMutations
  }
})

It works with modules as well, but you don't need to add the mutations there, only add them in the root Store:

const store = new Vuex.Store({
  modules: {
    cart: {
      state: {
        products: [], // Will be bound as an array
        user: null // Will be bound as an object
      }
    }
  },
  mutations: firebaseMutations
})

In order to use VuexFire, you have to enhance actions. This action enhancer takes the actual action and enhances it with two additional parameters in the context, bindFirebaseRef and unbindFirebaseRef:

import { firebaseAction } from 'vuexfire'

const setTodosRef = firebaseAction(({ bindFirebaseRef, unbindFirebaseRef }, { ref }) => {
  // binding will automatically unbind any previously bound ref so you
  // don't need to unbind before binding over an existing bound key
  bindFirebaseRef('todos', ref)
  // it is possible to unbind a bound key at any time
  unbindFirebaseRef('user')
})

Access it as a usual piece of the state:

const Component = {
  template: '<div>{{ todos }}</div>',
  computed: Vuex.mapState(['todos']),
  created () {
    this.$store.dispatch('setTodosRef', { ref: db.ref('todos') })
  }
}

Browser support

VuexFire requires basic WeakMap support, which means that if you need to support any of these browsers:

  • IE < 11
  • Safari < 7.1
  • Android < 5.0

You'll have to include a polyfill. You can use Benvie/WeakMap

You can find more information about WeakMap support here

How does it work?

VuexFire uses multiple global mutations prefixed by vuexfire/ to call the actual mutations to modify objects and arrays. It listens for updates to your firebase database and commits mutations to sync your state. Thanks to the action enhancer firebaseAction, it gets access to the local state and commit so it works with modules too πŸ‘

Examples

You can check out the examples by opening the html files in your browser, or check this online Demo

API

firebaseMutations

This object contains VuexFire internal mutations. They are all prefixed by vuexfire/. This object must be added in the root Store mutations object.

bindFirebaseRef(key, ref[, options])

Only available inside of an enhanced action

Binds a firebase reference to a property in the state. If there was already another reference bound to the same property, it unbinds it first.

options:

{
  cancelCallback: Function, // Cancel callback passed to Firebase when listening for events
  readyCallback: Function, // Callback called once the data has been loaded. Useful for SSR
  errorCallback: Function, // Callback called when there is an error loading the data. Useful for SSR
  wait: Boolean, // (Arrays only) Should Vuexfire wait for the whole array to be populated. Defaults to true
}

wait can be set to true every time. It's useful to do pagination and SSR.

unbindFirebaseRef(key)

Only available inside of an enhanced action

Unbinds a bound firebase reference to a given property in the state.

License

MIT

Support on Beerpay

Hey dude! Help me out for a couple of 🍻!

Beerpay Beerpay