Documentation
Documentation
- Projectexpand_less
- Open Sourceexpand_more
- Firebaseexpand_more
AngularFire
AngularFire smooths over the rough edges an Angular developer might encounter when implementing the framework-agnosticFirebase JS SDK & aims to provide a more natural developer experienceby conforming to Angular conventions.
ng add @angular/fire
- Dependency injection - Provide and Inject Firebase services in your components.
- Zone.js wrappers - Stable zones allow proper functionality of service workers, forms, SSR, and pre-rendering.
- Observable based - Utilize RxJS rather than callbacks for real-time streams.
- NgRx friendly API - Integrate with NgRx using AngularFire's action based APIs.
- Lazy-loading - AngularFire dynamically imports much of Firebase, reducing the time to load your app.
- Deploy schematics - Get your Angular application deployed on Firebase Hosting with a single command.
- Google Analytics - Zero-effort Angular Router awareness in Google Analytics.
- Router Guards - Guard your Angular routes with built-in Firebase Authentication checks.
Example use
import { provideFirebaseApp, initializeApp } from '@angular/fire/app';import { getFirestore, provideFirestore } from '@angular/fire/firestore';export const appConfig: ApplicationConfig = { providers: [ provideFirebaseApp(() => initializeApp({ ... })), provideFirestore(() => getFirestore()), ... ], ...})import { AsyncPipe } from '@angular/common';import { inject } from '@angular/core';import { Firestore, collectionData, collection } from '@angular/fire/firestore';interface Item { name: string, ...};@Component({ selector: 'app-root', template: ` <ul> @for (item of (item$ | async); track item) { <li> {{ item.name }} </li> } </ul> `, imports: [AsyncPipe]})export class AppComponent { firestore = inject(Firestore); itemCollection = collection(this.firestore, 'items'); item$ = collectionData<Item>(itemCollection);}Resources
Quickstart - Get your first application up and running by following our quickstart guide.
Stackblitz Template - Remember to set your Firebase configuration inapp/app.module.ts.
Upgrading from v6.0? Check out our guide.
Sample app
Thesample folder contains a kitchen sink application that demonstrates use of the "modular" API, in a zoneless server-rendered application, with all the bells and whistles.
Having troubles?
Get help on ourQ&A board, the officialFirebase Mailing List, theFirebase Community Slack (#angularfire2), theAngular Community Discord (#firebase),Gitter, theFirebase subreddit, orStack Overflow.
NOTE: While relatively stable, AngularFire is adeveloper preview and is subject to change before general availability. Questions on the mailing list and issues filed here are answered on abest-effort basis by maintainers and other community members. If you are able to reproduce a problem with Firebaseoutside of AngularFire's implementation, pleasefile an issue on the Firebase JS SDK or reach out to the personalizedFirebase support channel.
Developer Guide
This developer guide assumes you're using the new tree-shakable AngularFire API,if you're looking for the compatibility API you can find the documentation here.
See the v7 upgrade guide for more information on this change..
Firebase product integrations
####Analyticstsimport { } from '@angular/fire/analytics'; | ####Authenticationtsimport { } from '@angular/fire/auth'; |
####Cloud Firestoretsimport { } from '@angular/fire/firestore'; | ####Cloud Functionstsimport { } from '@angular/fire/functions'; |
####Cloud Messagingtsimport { } from '@angular/fire/messaging'; | ####Cloud Storagetsimport { } from '@angular/fire/storage'; |
####Performance Monitoringtsimport { } from '@angular/fire/performance'; | ####Realtime Databasetsimport { } from '@angular/fire/database'; |
####Remote Configtsimport { } from '@angular/fire/remote-config'; | ####App Checktsimport { } from '@angular/fire/app-check'; |
####Vertex AItsimport { } from '@angular/fire/vertexai'; |
For copyright and licensing details please see theLICENSE file.