API

React bindings for Firebase auth API.

FirebaseAuthProvider Props

Name

Type

Required

Default

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

FirebaseAuthConsumer

Name

Type

Required

Default

children

({authState}) => ReactNode

no

render

({authState}) => ReactNode

no

authState

Name

Type

isSignedIn

boolean

providerId

'none' | 'anonymous' | 'google.com' | 'facebook.com' ....

user

user | null

  • isSignedIn: boolean

  • providerId: 'none' | 'anonymous' | 'google.com' | 'facebook.com' ....

  • user: null | user

IfFirebaseAuthed

Only renders when a user is authenticated

Name

Type

Required

Default

children

({authState}) => ReactNode

no

render

({authState}) => ReactNode

no

IfFirebaseAuthedAnd

Only renders when a user is authenticated AND when the filter function passed as prop returns true

Name

Type

Required

Default

children

({authState}) => ReactNode

no

render

({authState}) => ReactNode

no

filter

(authState) => boolean

IfFirebaseAuthedOr

Only renders when a user is authenticated OR when the filter function passed as prop returns true

Name

Type

Required

Default

children

({authState}) => ReactNode

no

render

({authState}) => ReactNode

no

filter

(authState) => boolean

IfFirebaseUnAuthed

Only renders when a user is unauthenticated

Name

Type

Required

Default

children

({authState}) => ReactNode

no

render

({authState}) => ReactNode

no

Last updated