react-query-firebase / FirebaseContextProviderProps

Type Alias: FirebaseContextProviderProps

type FirebaseContextProviderProps = PropsWithChildren & object;

Defined in: src/web/context/FirebaseContextProvider.tsx:58

Type Declaration

analyticsEnabled?

optional analyticsEnabled: boolean;

Flag indicating whether Firebase Analytics should be enabled.

Default Value

true

authEnabled?

optional authEnabled: boolean;

Flag indicating whether Firebase Auth should be enabled.

authPersistenceType?

optional authPersistenceType: "SESSION" | "LOCAL" | "NONE" | "COOKIE";

Firebase persistence type

Default Value

'LOCAL'

consentSettings?

optional consentSettings: ConsentSettings;

Default user consent settings. Make sure to either use a consent platform or install custom consent form for a certain regions.

Default Value

{
     *                  ad_personalization: "denied",
     *                  ad_storage: "denied",
     *                  ad_user_data: "denied",
     *                  analytics_storage: "denied",
     *                  functionality_storage: "denied",
     *                  personalization_storage: "denied",
     *                  security_storage: "denied"
     *              }

emulators?

optional emulators: object;

Defines configuration for firebase emulators

emulators.auth?

optional auth: object;

Defines configuration for Firebase Auth emulator. Optional

emulators.auth.host

host: string;

Host to connect to Firebase Auth Emulator

emulators.firestore?

optional firestore: object;

Defines configuration for Firebase Firestore emulator. Optional.

emulators.firestore.host

host: string;

Host to connect to Firebase Firestore Emulator

emulators.firestore.port

port: number;

Port to connect to Firebase Firestore Emulator

firestoreEnabled?

optional firestoreEnabled: boolean;

Flag indicating whether Firebase Firestore should be enabled.

Default Value

true

firestoreSettings?

optional firestoreSettings: FirestoreSettings;

Specifies custom configurations for your Cloud Firestore instance. You must set these before invoking any other methods. https://firebase.google.com/docs/reference/js/firestore_.firestoresettings

Default Value

{}

options

options: FirebaseOptions;

Configuration options for Firebase initialization. Learn about the Firebase config object

remoteConfigDefaults?

optional remoteConfigDefaults: object;

Configuration options for Firebase Remote Config Defaults.

Index Signature

[key: string]: string | number | boolean

remoteConfigEnabled?

optional remoteConfigEnabled: boolean;

Flag indicating whether Firebase Remote Config should be enabled.

Default Value

true

remoteConfigSettings?

optional remoteConfigSettings: RemoteConfigSettings;

Configuration options for Firebase Remote Config Settings. Learn about the Firebase Remote COnfig Settings object

Default Value

true