@angular/fire

What is @angular/fire?

@angular/fire is the official Angular library for Firebase. It provides a set of AngularFire modules that enable Angular applications to interact with Firebase services such as Firestore, Authentication, Storage, and more. This library simplifies the integration of Firebase with Angular applications, offering reactive and declarative APIs.

What are @angular/fire's main functionalities?

Firestore

This feature allows you to interact with Firestore, a NoSQL database provided by Firebase. The code sample demonstrates how to retrieve a collection of items from Firestore and subscribe to changes in real-time.

import { AngularFirestore } from '@angular/fire/compat/firestore';

constructor(private firestore: AngularFirestore) {}

getItems() {
  return this.firestore.collection('items').valueChanges();
}

Authentication

This feature enables authentication functionalities such as signing in, signing out, and managing user sessions. The code sample shows how to sign in a user using email and password.

import { AngularFireAuth } from '@angular/fire/compat/auth';

constructor(private afAuth: AngularFireAuth) {}

login(email: string, password: string) {
  return this.afAuth.signInWithEmailAndPassword(email, password);
}

Storage

This feature allows you to interact with Firebase Storage, which is used for storing and serving user-generated content such as images and videos. The code sample demonstrates how to upload a file to Firebase Storage.

import { AngularFireStorage } from '@angular/fire/compat/storage';

constructor(private storage: AngularFireStorage) {}

uploadFile(filePath: string, file: File) {
  const fileRef = this.storage.ref(filePath);
  return fileRef.put(file);
}

Realtime Database

This feature provides access to Firebase Realtime Database, a cloud-hosted NoSQL database that allows data to be stored and synchronized in real-time. The code sample shows how to retrieve a list of items from the Realtime Database.

import { AngularFireDatabase } from '@angular/fire/compat/database';

constructor(private db: AngularFireDatabase) {}

getItems() {
  return this.db.list('items').valueChanges();
}

Analytics

This feature enables the use of Firebase Analytics to log events and track user interactions within your application. The code sample demonstrates how to log a custom event.

import { AngularFireAnalytics } from '@angular/fire/compat/analytics';

constructor(private analytics: AngularFireAnalytics) {}

logEvent(eventName: string, eventParams: any) {
  this.analytics.logEvent(eventName, eventParams);
}

Other packages similar to @angular/fire

firebase

The 'firebase' package is the official Firebase JavaScript SDK. It provides comprehensive access to Firebase services but lacks the Angular-specific integrations and reactive APIs provided by @angular/fire. Developers using Angular would need to manually integrate Firebase services and manage state updates.

reactfire

The 'reactfire' package is the official Firebase library for React. It offers similar functionalities to @angular/fire but is tailored for React applications. It provides hooks and components to easily integrate Firebase services with React's component-based architecture.

vuefire

The 'vuefire' package is the official Firebase library for Vue.js. It provides bindings to integrate Firebase services with Vue.js applications, similar to how @angular/fire integrates with Angular. It offers Vue-specific features such as directives and plugins.

README

AngularFire

The official Angular library for Firebase.

ng add @angular/fire

AngularFire smooths over the rough edges an Angular developer might encounter when implementing the framework-agnostic Firebase JS SDK & aims to provide a more natural developer experience by conforming to Angular conventions.

• 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 realtime streams
• NgRx friendly API - Integrate with NgRx using AngularFire's action based APIs.
• Lazy-loading - AngularFire dynamically imports much of Firebase, reducing 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, getApp, initializeApp } from '@angular/fire/app';
import { getFirestore, provideFirestore } from '@angular/fire/firestore';

@NgModule({
  imports: [
    provideFirebaseApp(() => initializeApp({ ... })),
    provideFirestore(() => getFirestore()),
  ],
  ...
})
export class AppModule { }

import { Firestore, collectionData, collection } from '@angular/fire/firestore';
import { Observable } from 'rxjs';

interface Item {
  name: string,
  ...
};

@Component({
  selector: 'app-root',
  template: `
  <ul>
    <li *ngFor="let item of item$ | async">
      {{ item.name }}
    </li>
  </ul>
  `
})
export class AppComponent {
  item$: Observable<Item[]>;
  constructor(firestore: Firestore) {
    const collection = collection(firestore, 'items');
    this.item$ = collectionData(collection);
  }
}

Compatibility

Angular and Firebase versions

AngularFire doesn't follow Angular's versioning as Firebase also has breaking changes throughout the year. Instead we try to maintain compatibility with both Firebase and Angular majors for as long as possible, only breaking when we need to support a new major of one or the other.

Angular	Firebase	AngularFire
13	9	^7.2
12	9	^7.0
12	7,8	^6.1.5
11	7,8	^6.1
10	8	^6.0.4
10	7	^6.0.3
9	8	^6.0.4
9	7	^6.0

_{Version combinations not documented here may work but are untested and you will see NPM peer warnings.}

Polyfills

Neither AngularFire or Firebase ship with polyfills. To have compatability across as wide-range of environments we suggest the following polyfills be added to your application:

API	Environments	Suggested Polyfill	License
Various ES5+ features	IE 11 Safari < 10	core-js/stable	MIT
globalThis	IE 11 Chrome < 71 Safari < 12.1 iOS < 12.2 Node < 12	globalThis	MIT
Proxy	IE 11 Safari < 10	proxy-polyfill	Apache 2.0
fetch	IE 11 Safari < 10.1 iOS < 10.3	cross-fetch	MIT

Resources

Quickstart - Get your first application up and running by following our quickstart guide.

Contributing

Stackblitz Template - Remember to set your Firebase configuration in app/app.module.ts.

Upgrading to v7.0? Check out our guide.

Sample apps

We have three sample apps in this repository:

1. samples/compat a kitchen sink application that demonstrates use of the "compatability" API
2. samples/modular a kitchen sink application that demonstrates the new tree-shakable API
3. samples/advanced the same app as samples/modular but demonstrates more advanced concepts such as Angular Universal state-transfer, dynamically importing Firebase feature modules, and Firestore data bundling.

Having troubles?

Get help on our Q&A board, the official Firebase Mailing List, the Firebase Community Slack (#angularfire2), the Angular Community Discord (#firebase), Gitter, the Firebase subreddit, or Stack Overflow.

NOTE: AngularFire is maintained by Googlers but is not a supported Firebase product. Questions on the mailing list and issues filed here are answered on a best-effort basis by maintainers and other community members. If you are able to reproduce a problem with Firebase outside of AngularFire's implementation, please file an issue on the Firebase JS SDK or reach out to the personalized Firebase support channel.

Developer Guide

AngularFire has a new tree-shakable API, however this is still under active development and documentation is in the works, so we suggest most developers stick with the Compatiability API for the time being. See the v7 upgrade guide for more information..

This developer guide assumes you're using the Compatiability API (@angular/fire/compat/*).

Monitor usage of your application in production

AngularFireAnalytics provides a convenient method of interacting with Google Analytics in your Angular application. The provided ScreenTrackingService and UserTrackingService automatically log events when you're using the Angular Router or Firebase Authentication respectively. Learn more about Google Analytics.

• Getting started with Google Analytics

Interacting with your database(s)

Firebase offers two cloud-based, client-accessible database solutions that support realtime data syncing. Learn about the differences between them in the Firebase Documentation.

Cloud Firestore

AngularFirestore allows you to work with Cloud Firestore, the new flagship database for mobile app development. It improves on the successes of Realtime Database with a new, more intuitive data model. Cloud Firestore also features richer, faster queries and scales better than Realtime Database.

• Documents
• Collections
• Querying Collections
• Offline data

Realtime Database

AngularFireDatabase allows you to work with the Realtime Database, Firebase's original database. It's an efficient, low-latency solution for mobile apps that require synced states across clients in realtime.

• Objects
• Lists
• Querying lists

Authenticate users

• Getting started with Firebase Authentication
• Route users with AngularFire guards

Local Emulator Suite

• Getting started with Firebase Emulator Suite

Upload files

• Getting started with Cloud Storage

Receive push notifications

• Getting started with Firebase Messaging

BETA: Change behavior and appearance of your application without deploying

Firebase Remote Config is a cloud service that lets you change the behavior and appearance of your app without requiring users to download an app update. Learn more about Remote Config.

• Getting started with Remote Config

Monitor your application performance in production

Firebase Performance Monitoring is a service that helps you to gain insight into the performance characteristics of your iOS, Android, and web apps. Learn more about Performance Monitoring.

• Getting started with Performance Monitoring

Directly call Cloud Functions

• Getting started with Callable Functions

Deploying your application

Firebase Hosting is production-grade web content hosting for developers. With Hosting, you can quickly and easily deploy web apps and static content to a global content delivery network (CDN) with a single command.

• Deploy your application on Firebase Hosting

Server-side rendering

Angular Universal is a technology that allows you to run your Angular application on a server. This allows you to generate your HTML in a process called server-side rendering (SSR). AngularFire is compatible with server-side rendering; allowing you to take advantage of the Search Engine Optimization, link previews, the performance gains granted by the technology, and more. Learn more about Angular Universal.

• Getting started with Angular Universal
• Deploying your Universal application on Cloud Functions for Firebase
• Prerendering your Universal application

Ionic

• Installation and Setup with Ionic CLI
• Using AngularFire with Ionic 2
• Using AngularFire with Ionic 3