API

React bindings for Firebase Firestore API.

Docs moved to https://react-firebase-js.com/docs/react-firestore-database/api

FirestoreProvider Props

Name	Type	Required	Default
firebase	firebase	yes
authDomain	string	yes
apiKey	string	yes
databaseURL	string	yes
projectId	string	yes
messagingSenderId	string	no
storageBucket	string	no
children	React Node	no
render	() => ReactNode	no

Firestore Setup Reference

FirestoreCollection

Name	Type	Required	Default
path	string	yes	null
where	{}	no	null
where.field	string	no	undefined
where.operator	"<" | "<=" | "==" | ">" | ">=" | "array-contains"	no	undefined
where.value	any	no	undefined
orderBy	{ field: string; type?: "desc" | "asc" }[]	no	null
limit	number	no	null
startAt	PrimitiveType | PrimitiveType[] | DocumentSnapshot	no	null
endAt	PrimitiveType | DocumentSnapshot	no	null
startAfter	PrimitiveType | DocumentSnapshot	no	null
endBefore	PrimitiveType | DocumentSnapshot	no	null

Firestore Query Reference

FirestoreDocument

Same props as FirestoreCollection

Name	Type	Required	Default
path	string	yes	null
where	{}	no	null
where.field	string	no	undefined
where.operator	"<" | "<=" | "==" | ">" | ">=" | "array-contains"	no	undefined
where.value	any	no	undefined
orderBy	{ field: string; type?: "desc" | "asc" }[]	no	null
limit	number	no	null
startAt	PrimitiveType | PrimitiveType[] | DocumentSnapshot	no	null
endAt	PrimitiveType | DocumentSnapshot	no	null
startAfter	PrimitiveType | DocumentSnapshot	no	null
endBefore	PrimitiveType | DocumentSnapshot	no	null

Firestore Query Reference

FirestoreMutation Props​

Name	Type	Required	Default
path	string	yes	​
type	"set" | "update" | "add"	yes	​
children	( { runMutation: (value:any, options?:any) => Promise<{key?:string}> } ) => ReactNode	yes	null

​Firestore Write Data Reference​