--- description: Unofficial Capacitor plugin for Firebase App SDK to initialize Firebase in your app with support for Android, iOS, and Web. title: Capacitor Firebase App Plugin for Android, iOS & Web - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/firebase/app.png --- [Skip to content ](#capacitor-firebaseapp) [πŸ” Introducing the **Capacitor Vault** plugin β€” store secrets behind biometrics or a device passcode. ](/blog/announcing-the-capacitor-vault-plugin/) * [ SDKs ](/docs/sdks/) * [ iOS ](#ios) * [ Configuration ](#configuration) * [ Demo ](#demo) * [ Usage ](#usage) * [ API ](#api) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ License ](#license) * [ App Check ](/docs/sdks/capacitor/firebase/app-check/) * [ Authentication ](/docs/sdks/capacitor/firebase/authentication/) * [ Crashlytics ](/docs/sdks/capacitor/firebase/crashlytics/) * [ Cloud Firestore ](/docs/sdks/capacitor/firebase/cloud-firestore/) * [ Cloud Functions ](/docs/sdks/capacitor/firebase/cloud-functions/) * [ Cloud Messaging ](/docs/sdks/capacitor/firebase/cloud-messaging/) * [ Cloud Storage ](/docs/sdks/capacitor/firebase/cloud-storage/) * [ Performance Monitoring ](/docs/sdks/capacitor/firebase/performance-monitoring/) * [ Remote Config ](/docs/sdks/capacitor/firebase/remote-config/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ Gyroscope ](/docs/sdks/capacitor/gyroscope/) * [ Haptics ](/docs/sdks/capacitor/haptics/) * [ Home Indicator ](/docs/sdks/capacitor/home-indicator/) * [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/) * [ Install Referrer ](/docs/sdks/capacitor/install-referrer/) * [ Keep Awake ](/docs/sdks/capacitor/keep-awake/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Light Sensor ](/docs/sdks/capacitor/light-sensor/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Localization ](/docs/sdks/capacitor/localization/) * [ Mail Composer ](/docs/sdks/capacitor/mail-composer/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Maps Launcher ](/docs/sdks/capacitor/maps-launcher/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ Network ](/docs/sdks/capacitor/network/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ Node.js ](/docs/sdks/capacitor/nodejs/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Passkeys ](/docs/sdks/capacitor/passkeys/) * [ Password Autofill ](/docs/sdks/capacitor/password-autofill/) * [ PDF Generator ](/docs/sdks/capacitor/pdf-generator/) * [ PDF Viewer ](/docs/sdks/capacitor/pdf-viewer/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Permissions ](/docs/sdks/capacitor/permissions/) * [ Phone Dialer ](/docs/sdks/capacitor/phone-dialer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ Photo Manipulator ](/docs/sdks/capacitor/photo-manipulator/) * [ PixLive ](/docs/sdks/capacitor/pixlive/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/) * [ Proximity Sensor ](/docs/sdks/capacitor/proximity-sensor/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Root Detection ](/docs/sdks/capacitor/root-detection/) * [ Screen Brightness ](/docs/sdks/capacitor/screen-brightness/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screen Reader ](/docs/sdks/capacitor/screen-reader/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Settings Launcher ](/docs/sdks/capacitor/settings-launcher/) * [ Shake ](/docs/sdks/capacitor/shake/) * [ Silent Mode ](/docs/sdks/capacitor/silent-mode/) * [ SIM ](/docs/sdks/capacitor/sim/) * [ SMS Composer ](/docs/sdks/capacitor/sms-composer/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ System WebView ](/docs/sdks/capacitor/system-webview/) * [ Text Interaction ](/docs/sdks/capacitor/text-interaction/) * [ Text Zoom ](/docs/sdks/capacitor/text-zoom/) * [ Thermal State ](/docs/sdks/capacitor/thermal-state/) * [ Toast ](/docs/sdks/capacitor/toast/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Volume ](/docs/sdks/capacitor/volume/) * [ Wallet ](/docs/sdks/capacitor/wallet/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * [ Zip ](/docs/sdks/capacitor/zip/) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * APIs and SDKs * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ Blog ](/blog/) * Categories * [ iOS ](#ios) * [ Configuration ](#configuration) * [ Demo ](#demo) * [ Usage ](#usage) * [ API ](#api) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ License ](#license) # @capacitor-firebase/app[ΒΆ](#capacitor-firebaseapp "Permanent link") Unofficial Capacitor plugin for [Firebase App](https://firebase.google.com/docs).[1](#fn:1) [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Use Cases[ΒΆ](#use-cases "Permanent link") 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[ΒΆ](#compatibility "Permanent link") | 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 | ## Installation[ΒΆ](#installation "Permanent link") You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1)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: `[](#%5F%5Fcodelineno-2-1)npm install @capacitor-firebase/app firebase [](#%5F%5Fcodelineno-2-2)npx cap sync ` Add Firebase to your project if you haven't already ([Android](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#android) / [iOS](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#ios) / [Web](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#web)). ### Android[ΒΆ](#android "Permanent link") #### Variables[ΒΆ](#variables "Permanent link") 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[ΒΆ](#ios "Permanent link") #### Swift Package Manager[ΒΆ](#swift-package-manager "Permanent link") Add the following to your `capacitor.config.json` (or `capacitor.config.ts`) to avoid a [SwiftPM package identity collision](https://github.com/capawesome-team/capacitor-firebase/issues/959): `[](#%5F%5Fcodelineno-3-1){ [](#%5F%5Fcodelineno-3-2) "experimental": { [](#%5F%5Fcodelineno-3-3) "ios": { [](#%5F%5Fcodelineno-3-4) "spm": { [](#%5F%5Fcodelineno-3-5) "packageOptions": { [](#%5F%5Fcodelineno-3-6) "@capacitor-firebase/app": { [](#%5F%5Fcodelineno-3-7) "symlink": true [](#%5F%5Fcodelineno-3-8) } [](#%5F%5Fcodelineno-3-9) } [](#%5F%5Fcodelineno-3-10) } [](#%5F%5Fcodelineno-3-11) } [](#%5F%5Fcodelineno-3-12) } [](#%5F%5Fcodelineno-3-13)} ` **Attention**: SPM `packageOptions` support requires Capacitor CLI **8.4.0+**. ## Configuration[ΒΆ](#configuration "Permanent link") No configuration required for this plugin. ## Demo[ΒΆ](#demo "Permanent link") A working example can be found here: [robingenz/capacitor-firebase-plugin-demo](https://github.com/robingenz/capacitor-firebase-plugin-demo) ## Usage[ΒΆ](#usage "Permanent link") The following examples show how to get the Firebase app name and its configuration options. ### Get the app name[ΒΆ](#get-the-app-name "Permanent link") Retrieve the unique name of the Firebase app: `[](#%5F%5Fcodelineno-4-1)import { FirebaseApp } from '@capacitor-firebase/app'; [](#%5F%5Fcodelineno-4-2) [](#%5F%5Fcodelineno-4-3)const getName = async () => { [](#%5F%5Fcodelineno-4-4) const result = await FirebaseApp.getName(); [](#%5F%5Fcodelineno-4-5)}; ` ### Get the Firebase configuration options[ΒΆ](#get-the-firebase-configuration-options "Permanent link") Retrieve the configuration options of the Firebase app, such as the API key, application ID, and project ID: `[](#%5F%5Fcodelineno-5-1)import { FirebaseApp } from '@capacitor-firebase/app'; [](#%5F%5Fcodelineno-5-2) [](#%5F%5Fcodelineno-5-3)const getOptions = async () => { [](#%5F%5Fcodelineno-5-4) const result = await FirebaseApp.getOptions(); [](#%5F%5Fcodelineno-5-5)}; ` ## API[ΒΆ](#api "Permanent link") * [getName()](#getname) * [getOptions()](#getoptions) * [Interfaces](#interfaces) ### getName()[ΒΆ](#getname "Permanent link") `[](#%5F%5Fcodelineno-6-1)getName() => Promise ` Get the name for this app. **Returns:** `Promise<[GetNameResult](#getnameresult)>` **Since:** 0.1.0 --- ### getOptions()[ΒΆ](#getoptions "Permanent link") `[](#%5F%5Fcodelineno-7-1)getOptions() => Promise ` Get the configuration options for this app. **Returns:** `Promise<[GetOptionsResult](#getoptionsresult)>` **Since:** 0.1.0 --- ### Interfaces[ΒΆ](#interfaces "Permanent link") #### GetNameResult[ΒΆ](#getnameresult "Permanent link") | Prop | Type | Description | Since | | -------- | ------ | ---------------------------- | ----- | | **name** | string | The unique name of this app. | 0.1.0 | #### GetOptionsResult[ΒΆ](#getoptionsresult "Permanent link") | 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[ΒΆ](#faq "Permanent link") ### Which platforms does this plugin support?[ΒΆ](#which-platforms-does-this-plugin-support "Permanent link") 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?[ΒΆ](#do-i-need-to-configure-anything-before-using-this-plugin "Permanent link") No plugin-specific configuration is required. However, you must add Firebase to your project first. The [Installation](#installation) section links to the Firebase setup instructions for Android, iOS, and Web. ### What information does `getOptions` return?[ΒΆ](#what-information-does-getoptions-return "Permanent link") 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?[ΒΆ](#how-do-i-fix-the-swiftpm-package-identity-collision-on-ios "Permanent link") 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](#installation) section. Note that SPM `packageOptions` support requires Capacitor CLI 8.4.0 or later. ### Is this an official Firebase plugin?[ΒΆ](#is-this-an-official-firebase-plugin "Permanent link") 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?[ΒΆ](#can-i-use-this-plugin-with-ionic-react-vue-or-angular "Permanent link") 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[ΒΆ](#related-plugins "Permanent link") * [Firebase Analytics](https://capawesome.io/docs/sdks/capacitor/firebase/analytics/): Log events and track user interactions with Firebase Analytics. * [Firebase Authentication](https://capawesome.io/docs/sdks/capacitor/firebase/authentication/): Authenticate users with Firebase Authentication. * [Firebase Crashlytics](https://capawesome.io/docs/sdks/capacitor/firebase/crashlytics/): Track and report app crashes with Firebase Crashlytics. * [Firebase Cloud Messaging](https://capawesome.io/docs/sdks/capacitor/firebase/cloud-messaging/): Receive push notifications with Firebase Cloud Messaging. ## Newsletter[ΒΆ](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Changelog[ΒΆ](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/app/CHANGELOG.md). ## License[ΒΆ](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/app/LICENSE). --- 1. This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries. [↩](#fnref:1 "Jump back to footnote 1 in the text") July 8, 2026 Back to top ```json {"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/firebase/app/#article", "headline": "Capacitor Firebase App Plugin for Android, iOS & Web", "name": "Capacitor Firebase App Plugin for Android, iOS & Web", "description": "Unofficial Capacitor plugin for Firebase App SDK to initialize Firebase in your app with support for Android, iOS, and Web.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/firebase/app/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/firebase/app/", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "about": {"@id": "https://capawesome.io/docs/sdks/capacitor/firebase/app/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/firebase/app/#software", "name": "Capacitor Firebase App Plugin for Android, iOS & Web", "description": "Unofficial Capacitor plugin for Firebase App SDK to initialize Firebase in your app with support for Android, iOS, and Web.", "url": "https://capawesome.io/docs/sdks/capacitor/firebase/app/", "programmingLanguage": "TypeScript", "runtimePlatform": "Capacitor", "codeRepository": "https://github.com/capawesome-team", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}}]} {"@context": "https://schema.org", "@type": "FAQPage", "mainEntity": [{"@type": "Question", "name": "Which platforms does this plugin support?", "acceptedAnswer": {"@type": "Answer", "text": "The plugin supports Android, iOS, and Web. Both getName() and getOptions() are available on all three platforms."}}, {"@type": "Question", "name": "Do I need to configure anything before using this plugin?", "acceptedAnswer": {"@type": "Answer", "text": "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."}}, {"@type": "Question", "name": "What information does getOptions return?", "acceptedAnswer": {"@type": "Answer", "text": "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."}}, {"@type": "Question", "name": "How do I fix the SwiftPM package identity collision on iOS?", "acceptedAnswer": {"@type": "Answer", "text": "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."}}, {"@type": "Question", "name": "Is this an official Firebase plugin?", "acceptedAnswer": {"@type": "Answer", "text": "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."}}, {"@type": "Question", "name": "Can I use this plugin with Ionic, React, Vue or Angular?", "acceptedAnswer": {"@type": "Answer", "text": "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."}}], "url": "https://capawesome.io/docs/sdks/capacitor/firebase/app/"} ```