angular / angularfire

Angular + Firebase = ❤️
https://firebaseopensource.com/projects/angular/angularfire2
MIT License
7.7k stars 2.19k forks source link
angular angularfire cloud-firestore cloud-functions firebase ngrx notifications offline-data realtime realtime-database rxjs

AngularFire

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.

ng add @angular/fire

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 { inject } from '@angular/core';
import { Firestore, collectionData, collection } from '@angular/fire/firestore';
import { Observable } from 'rxjs';

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

@Component({
  selector: 'app-root',
  standalone: true,
  template: `
  <ul>
    @for (item of (item$ | async); track item) {
      <li>
        {{ item.name }}
      </li>
    }
  </ul>
  `
})
export class AppComponent {
  item$: Observable<Item[]>;
  firestore: Firestore = inject(Firestore);

  constructor() {
    const itemCollection = collection(this.firestore, 'items');
    this.item$ = collectionData<Item>(itemCollection);
  }
}

Polyfills

Neither AngularFire nor Firebase ship with polyfills. To have compatibility across a wide-range of environments, we suggest the following polyfills be added to your application:

API Environments Suggested Polyfill License
Various ES5+ features Safari < 10 core-js/stable MIT
globalThis Chrome < 71
Safari < 12.1
iOS < 12.2
Node < 12
globalThis MIT
Proxy Safari < 10 proxy-polyfill Apache 2.0
fetch 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 "compatibility" 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: While relatively stable, AngularFire is a developer preview and is subject to change before general availability. 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

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

#### [Analytics](docs/analytics.md#analytics) ```ts import { } from '@angular/fire/analytics'; ``` #### [Authentication](docs/auth.md#authentication) ```ts import { } from '@angular/fire/auth'; ```
#### [Cloud Firestore](docs/firestore.md#cloud-firestore) ```ts import { } from '@angular/fire/firestore'; ``` #### [Cloud Functions](docs/functions.md#cloud-functions) ```ts import { } from '@angular/fire/functions'; ```
#### [Cloud Messaging](docs/messaging.md#cloud-messaging) ```ts import { } from '@angular/fire/messaging'; ``` #### [Cloud Storage](docs/storage.md#cloud-storage) ```ts import { } from '@angular/fire/storage'; ```
#### [Performance Monitoring](docs/performance.md#performance-monitoring) ```ts import { } from '@angular/fire/performance'; ``` #### [Realtime Database](docs/database.md#realtime-database) ```ts import { } from '@angular/fire/database'; ```
#### [Remote Config](docs/remote-config.md#remote-config) ```ts import { } from '@angular/fire/remote-config'; ``` #### [App Check](docs/app-check.md#app-check) ```ts import { } from '@angular/fire/app-check'; ```
#### [Vertex AI](docs/vertexai.md#vertex-ai-preview) ```ts import { } from '@angular/fire/vertexai-preview'; ```