Skip to content

docs(compat): state the compatibility API's support status #3810

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
armando-navarro wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −1
Open

docs(compat): state the compatibility API's support status #3810

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/compat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ AngularFire has a new tree-shakable API, you're looking at the documentation for

[See the v7 upgrade guide for more information on this change.](version-7-upgrade.md).

### Support status

The compatibility API (`@angular/fire/compat/*`) is supported and is kept working on every Angular and Firebase version AngularFire supports. Its specs run in the same test suite as the modular API, and it receives bug fixes. It does not receive new features: new Firebase products and new AngularFire features land in the modular API only. There is no planned removal date. If you depend on the compatibility API, you can keep upgrading AngularFire without migrating, and migrate when the modular API offers something you need.

### 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](https://firebase.google.com/docs/analytics).
Expand Down
2 changes: 1 addition & 1 deletion docs/version-7-upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ AngularFire v7.0 has a compatibility layer that supports the AngularFire v6.0 AP

While not as tree-shakable as the new modular SDK, this allows you to upgrade and take advantage of the benefits of the new SDK ASAP.

**Most developers can stop here for now as the new API isn't feature complete.**
**You can stop here if the compatibility API covers your needs.** It stays supported and receives bug fixes, but new features land in the modular API only. See [the compatibility guide's support status](compat.md#support-status).

## **NEW** Modular SDK

Expand Down
Loading