Skip to content
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.

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

Doc changes #3525

Merged
merged 1 commit into from
May 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 3 additions & 9 deletions docs/analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,8 @@ export class UserProfileComponent {

## Firebase API

The [Firebase API for Google Analytics documentation](https://firebase.google.com/docs/reference/js/analytics.md#analytics_package) is available on the Firebase website.
AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.

## Services

### ScreenTrackingService

Coming soon, for now [please review the documentation](https://firebase.google.com/docs/analytics/screenviews)

### UserTrackingService
Coming soon
Update the imports from `import { ... } from 'firebase/analytics'` to `import { ... } from '@angular/fire/analytics'` and follow the official documentation.

[Getting Started](https://firebase.google.com/docs/analytics/get-started?platform=web) | [API Reference](https://firebase.google.com/docs/reference/js/analytics)
9 changes: 5 additions & 4 deletions docs/app-check.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<small>
<a href="https://github.com/angular/angularfire">AngularFire</a> &#10097; <a href="../README.md#developer-guide">Developer Guide</a> &#10097; Realtime App Check
<a href="https://github.com/angular/angularfire">AngularFire</a> &#10097; <a href="../README.md#developer-guide">Developer Guide</a> &#10097; App Check
</small>

<img align="right" width="30%" src="images/[email protected]">
Expand Down Expand Up @@ -47,7 +47,8 @@ export class AppCheckComponent {

## Firebase API

The [AppCheck documentation](https://firebase.google.com/docs/reference/js/app-check) is available on the Firebase website.
AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.

## Convenience observables
Coming soon.
Update the imports from `import { ... } from 'firebase/app-check'` to `import { ... } from '@angular/fire/app-check'` and follow the official documentation.

[Getting Started](https://firebase.google.com/docs/app-check/web/recaptcha-enterprise-provider) | [API Reference](https://firebase.google.com/docs/reference/js/app-check)
2 changes: 1 addition & 1 deletion docs/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ extend class DepartmentComponent {

AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.

Just change your imports from `import { ... } from 'firebase/database'` to `import { ... } from '@angular/fire/database'` and follow the offical documentation.
Just change your imports from `import { ... } from 'firebase/database'` to `import { ... } from '@angular/fire/database'` and follow the official documentation.

[Getting Started](https://firebase.google.com/docs/database/web/start) | [API Reference](https://firebase.google.com/docs/reference/js/database)

Expand Down
9 changes: 8 additions & 1 deletion docs/firestore.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,15 @@ export class UserProfileComponent {
```

## Firebase API
With the reference to Cloud Firestore available in a component it is now possible to connect read from and write to the database.

AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.

Update the imports from `import { ... } from 'firebase/firestore'` to `import { ... } from '@angular/fire/firestore'` and follow the official documentation.

[Getting Started](https://firebase.google.com/docs/firestore/quickstart#web-modular-api) | [API Reference](https://firebase.google.com/docs/reference/js/firestore)

### Reading data

In Cloud Firestore data is stored in `documents` and `documents` are stored in `collections`. The path to data follows `<collection_name>/<document_id>` and continues if there are subcollections. For example, `"users/ABC12345/posts/XYZ6789"` represents:
* `users` collection
* document id `ABC12345`
Expand Down Expand Up @@ -111,6 +117,7 @@ export Interface UserProfile {
The `async` pipe handles unsubscribing from observables.

### Writing data

To write to Cloud Firestore use the `addDoc` function. It will create a new document at the path specified by the collection. In `user-profile.component.ts`, we'll update the code to add a new document on a `<button>` click.


Expand Down
7 changes: 4 additions & 3 deletions docs/functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,9 @@ export class AppComponent {
```

## Firebase API
The [Firebase API for Cloud Functions documentation](https://firebase.google.com/docs/reference/js/functions) is available on the Firebase website.

## Convenience observables
AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.

More details coming soon.
Update the imports from `import { ... } from 'firebase/functions'` to `import { ... } from '@angular/fire/functions'` and follow the official documentation.

[Call functions from your app](https://firebase.google.com/docs/functions/callable?gen=2nd#web-modular-api) | [API Reference](https://firebase.google.com/docs/reference/js/functions)
10 changes: 3 additions & 7 deletions docs/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,8 @@ export class PerformanceComponent {

## Firebase API

The [Performance documentation](https://firebase.google.com/docs/reference/js/performance.md#performance_package) is available on the Firebase website.
AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.

## Services
Update the imports from `import { ... } from 'firebase/performance'` to `import { ... } from '@angular/fire/performance'` and follow the official documentation.

Coming soon.

## Convenience observables

Coming soon.
[Getting Started](https://firebase.google.com/docs/perf-mon/get-started-web) | [API Reference](https://firebase.google.com/docs/reference/js/performance)
6 changes: 3 additions & 3 deletions docs/remote-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ export class RemoteConfigComponent {

## Firebase API

The [Remote Config documentation](https://firebase.google.com/docs/reference/js/remote-config) is available on the Firebase website.
AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.

## Convenience observables
Update the imports from `import { ... } from 'firebase/remote-config'` to `import { ... } from '@angular/fire/remote-config'` and follow the official documentation.

Coming soon.
[Getting Started](https://firebase.google.com/docs/remote-config/get-started?platform=web) | [API Reference](https://firebase.google.com/docs/reference/js/remote-config)
2 changes: 1 addition & 1 deletion docs/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export class StorageComponent {

AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.

Update the imports from `import { ... } from 'firebase/storage'` to `import { ... } from '@angular/fire/storage'` and follow the offical documentation.
Update the imports from `import { ... } from 'firebase/storage'` to `import { ... } from '@angular/fire/storage'` and follow the official documentation.

[Getting Started](https://firebase.google.com/docs/storage/web/start) | [API Reference](https://firebase.google.com/docs/reference/js/storage)

Expand Down
Loading