Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 1.1 KB

README.md

File metadata and controls

44 lines (29 loc) · 1.1 KB
Raw

FirebaseData

A swappable replacement for the Framer data object that syncs it realtime to Firebase.

Usage

Normal Data Object

const data = Data({
    userLoggedIn: false,
    accentColor: "#0000ff",
})

Firebase Synced Data Object

const data = FirebaseData(firebaseConfig, {
    userLoggedIn: false,
    accentColor: "#0000ff",
})

Install

$ yarn add firebase-data

Guide on using NPM packages in Framer x

API

FirebaseData(firebaseConfig, initialState, ref?)

  • firebaseConfig a config object from Firebase project settings.
  • initialState an object of default values for the Data object
  • ref an optional string to use as a Firebase reference to set/get data

Troubleshooting

The most common issues in setting up firebase-data are related to the Firebase setup process. I've walked through the process as well some common problems & solutions in a paper document.