Skip to content
On this page

Binding Firebase Reference to existing Vue Refs

Sometimes, you might want to reuse an existing ref(). This might be because you want to write the Firebase data to a custom ref coming from a composable or because the ref comes from an existing reactivity source like a Vuex/Pinia store. This can be achieved by passing the ref() to the target option of the composable:

ts
todos // given an existing Ref<Todo[]>
const { pending } = useCollection(todoListRef, { target: todos })

When passing a target ref, the composable will not create a new ref() for you, but will instead use the one you passed. It will also not return the ref() as a result, but instead return an object with some useful properties. You can find more about this in the declarative subscriptions section.

Pinia

If you are using Pinia, you can directly use the useCollection function within setup stores:

ts
import { defineStore } from 'pinia'

export const useTodoStore = defineStore('todos', () => {
  const todos = useCollection(todoListRef)
  
  return { todos }
})

Note you will still have to follow the Firebase API (e.g. addDoc(), updateDoc(), etc) to update the data.

TypeScript

TODO: use type helper to add properties of converter

Released under the MIT License.