Capacitor Firebase App Plugin

Unofficial Capacitor plugin for Firebase App.[^1]

Use Cases

The Firebase App plugin is typically used to access the core Firebase configuration of your app, for example:

• Configuration checks: Read the Firebase configuration options such as the API key, application ID, and project ID at runtime to verify that the app is connected to the correct Firebase project.
• Multi-environment apps: Distinguish between staging and production builds by inspecting the Google Cloud project ID.
• Debug screens: Display Firebase project details such as the storage bucket or database URL in an internal debug view.

Compatibility

| Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 8.x.x | >=8.x.x | Active support | | 7.x.x | 7.x.x | Deprecated | | 6.x.x | 6.x.x | Deprecated | | 5.x.x | 5.x.x | Deprecated | | 1.x.x | 4.x.x | Deprecated |

Guides

• How to Use Firebase in a Capacitor App: The starting point for the whole plugin family and the setup every Firebase plugin shares.

Installation

You can use our AI-Assisted Setup to install the plugin. Add the Capawesome Skills to your AI tool using the following command:

npx skills add capawesome-team/skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capacitor-firebase/app` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

npm install @capacitor-firebase/app firebase
npx cap sync

Add Firebase to your project if you haven't already (Android / iOS / Web).

Android

Variables

If needed, you can define the following project variable in your app’s variables.gradle file to change the default version of the dependency:

• $firebaseCommonVersion version of com.google.firebase:firebase-common (default: 22.0.1)

This can be useful if you encounter dependency conflicts with other plugins in your project.

iOS

Swift Package Manager

Add the following to your capacitor.config.json (or capacitor.config.ts) to avoid a SwiftPM package identity collision:

{
  "experimental": {
    "ios": {
      "spm": {
        "packageOptions": {
          "@capacitor-firebase/app": {
            "symlink": true
          }
        }
      }
    }
  }
}

Attention: SPM packageOptions support requires Capacitor CLI 8.4.0+.

Configuration

No configuration required for this plugin.

Demo

A working example can be found here: robingenz/capacitor-firebase-plugin-demo

Usage

The following examples show how to get the Firebase app name and its configuration options.

Get the app name

Retrieve the unique name of the Firebase app:

import { FirebaseApp } from '@capacitor-firebase/app';

const getName = async () => {
  const result = await FirebaseApp.getName();
};

Get the Firebase configuration options

Retrieve the configuration options of the Firebase app, such as the API key, application ID, and project ID:

import { FirebaseApp } from '@capacitor-firebase/app';

const getOptions = async () => {
  const result = await FirebaseApp.getOptions();
};

API

• getName()
• getOptions()
• Interfaces

getName()

getName() => Promise<GetNameResult>

Get the name for this app.

Returns: Promise<GetNameResult>

Since: 0.1.0

getOptions()

getOptions() => Promise<GetOptionsResult>

Get the configuration options for this app.

Returns: Promise<GetOptionsResult>

Since: 0.1.0

Interfaces

GetNameResult

| Prop | Type | Description | Since | | ---------- | ------------------- | ---------------------------- | ----- | | name | string | The unique name of this app. | 0.1.0 |

GetOptionsResult

| Prop | Type | Description | Since | | ------------------- | ------------------- | -------------------------------------------------------------- | ----- | | apiKey | string | API key used for authenticating requests from your app. | 0.1.0 | | applicationId | string | Google App ID used to uniquely identify an instance of an app. | 0.1.0 | | databaseUrl | string | The database root URL. | 0.1.0 | | gcmSenderId | string | The Project Number. | 0.1.0 | | projectId | string | The Google Cloud project ID. | 0.1.0 | | storageBucket | string | The Google Cloud Storage bucket name. | 0.1.0 |

FAQ

Which platforms does this plugin support?

The plugin supports Android, iOS, and Web. Both getName() and getOptions() are available on all three platforms.

Do I need to configure anything before using this plugin?

No plugin-specific configuration is required. However, you must add Firebase to your project first. The Installation section links to the Firebase setup instructions for Android, iOS, and Web.

What information does getOptions return?

The getOptions() method returns the configuration options of the Firebase app: the API key used for authenticating requests, the Google App ID, the database root URL, the project number, the Google Cloud project ID, and the Google Cloud Storage bucket name.

How do I fix the SwiftPM package identity collision on iOS?

If you are using Swift Package Manager, add the symlink package option for @capacitor-firebase/app to your Capacitor configuration as described in the Installation section. Note that SPM packageOptions support requires Capacitor CLI 8.4.0 or later.

Is this an official Firebase plugin?

No, this is an unofficial Capacitor plugin for the Firebase App SDK. The project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries.

Can I use this plugin with Ionic, React, Vue or Angular?

Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects.

Related Plugins

• Firebase Analytics: Log events and track user interactions with Firebase Analytics.
• Firebase Authentication: Authenticate users with Firebase Authentication.
• Firebase Crashlytics: Track and report app crashes with Firebase Crashlytics.
• Firebase Cloud Messaging: Receive push notifications with Firebase Cloud Messaging.

Newsletter

Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our Capawesome Newsletter.

Changelog

See CHANGELOG.md.

License

See LICENSE.

[^1]: This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries.