Repository files navigation

FirebaseUI is an open-source library for iOS that allows you to quickly connect common UI elements to theFirebase database for data storage, allowing views to be updated in realtime as they change, and providing simple interfaces for common tasks like displaying lists or collections of items.

Additionally, FirebaseUI provides modern SwiftUI authentication components that simplify Firebase authentication by integrating with common identity providers like Facebook, Twitter, Google, and Apple.

FirebaseUI clients are also available forAndroid andweb.

FirebaseUI supports iOS 17.0+ and Xcode 15+.

For SwiftUI authentication and modern features, use Swift Package Manager:

1. In Xcode, go to File > Add Package Dependencies
2. Enter the repository URL:https://github.com/firebase/FirebaseUI-iOS
3. Select the modules you need:
   • FirebaseAuthSwiftUI - Core SwiftUI authentication
   • FirebaseGoogleSwiftUI - Google Sign-In
   • FirebaseFacebookSwiftUI - Facebook Login
   • FirebasePhoneAuthSwiftUI - Phone Authentication
   • FirebaseAppleSwiftUI - Sign in with Apple
   • FirebaseTwitterSwiftUI - Twitter Login
   • FirebaseOAuthSwiftUI - Generic OAuth providers

For UIKit data binding features (Database, Firestore, Storage), useCocoaPods:

# Only pull in Firestore featurespod'FirebaseUI/Firestore'# Only pull in Database featurespod'FirebaseUI/Database'# Only pull in Storage featurespod'FirebaseUI/Storage'

If you're including FirebaseUI in a project, make sure you also have:

platform:ios,'13.0'use_frameworks!

The READMEs for components of FirebaseUI can be found in their respective project folders.

• SwiftUI Authentication

• Database
• Firestore
• Storage

If you'd like to contribute to FirebaseUI for iOS, you'll need to run the following commands to get your environment set up:

$ git clone https://github.com/firebase/FirebaseUI-iOS.git$cd FirebaseUI-iOS# For SwiftUI components (uses Swift Package Manager)$cd samples/swiftui/FirebaseSwiftUISample$ open FirebaseSwiftUISample.xcodeproj# For UIKit data binding components (uses CocoaPods)$cd FirebaseDatabaseUI# or FirebaseFirestoreUI, FirebaseStorageUI$ pod install

FirebaseUI includes several sample projects demonstrating different features:

Located insamples/swiftui/FirebaseSwiftUISample/, this sample demonstrates the modern SwiftUI authentication components.

Configuration:

1. DownloadGoogleService-Info.plist fromFirebase Console
2. Copy it to the sample project folder
3. Update URL Types (for OAuth providers) inProject Settings -> Info tab -> Url Types:
   • REVERSED_CLIENT_ID (fromGoogleService-Info.plist) - Required for Google Sign-In
   • fb{your-app-id} - Required for Facebook Login
4. For Facebook Login, updateInfo.plist withFacebookAppID and enable Keychain Sharing

Located insamples/objc/ andsamples/swift/, these samples demonstrate FirebaseUI's data binding capabilities for Realtime Database and Storage.

Configuration:

1. DownloadGoogleService-Info.plist fromFirebase Console
2. Copy it tosamples/objc/GoogleService-Info.plist orsamples/swift/GoogleService-Info.plist
3. Runpod install in the sample directory
4. Configure your Firebase Database and Storage in the Firebase Console
5. For the Chat sample, enable anonymous authentication in Firebase Console
6. For the Storage sample, configure appropriateStorage Security Rules

We'd love to accept your sample apps and patches! Before we can take them, wehave to jump a couple of legal hurdles.

Please fill out either the individual or corporate Contributor License Agreement(CLA).

• If you are an individual writing original source code and you're sure youown the intellectual property, then you'll need to sign an [individual CLA](https://developers.google.com/open-source/cla/individual).
• If you work for a company that wants to allow you to contribute your work,then you'll need to sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate).

Follow either of the two links above to access the appropriate CLA andinstructions for how to sign and return it. Once we receive it, we'll be able toaccept your pull requests.

1. Submit an issue describing your proposed change to the repo in question.
2. The repo owner will respond to your issue promptly.
3. If your proposed change is accepted, and you haven't already done so, sign aContributor License Agreement (see details above).
4. Fork the desired repo, develop and test your code changes.
5. Ensure that your code adheres to the existing style of the library to whichyou are contributing.
6. Ensure that your code has an appropriate set of unit tests which all pass.
7. Submit a pull request