Skip to content

docs: getting started on android FirebaseUI v10#2309

Open
russellwheatley wants to merge 4 commits intomasterfrom
getting-started-docs
Open

docs: getting started on android FirebaseUI v10#2309
russellwheatley wants to merge 4 commits intomasterfrom
getting-started-docs

Conversation

@russellwheatley
Copy link
Copy Markdown
Member

@russellwheatley russellwheatley commented Mar 20, 2026

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new getting started guide for FirebaseUI Auth v10 on Android. The guide focuses on the new Compose-based authentication library, detailing its integration, configuration, and customization capabilities. It aims to provide developers with a clear path to implement modern authentication flows using Jetpack Compose, while also offering guidance for migrating from previous versions.

Highlights

  • New Compose-based Authentication Flow: The recommended sign-in flow for FirebaseUI Auth v10 now leverages Jetpack Compose screens, moving away from Intent builders and ActivityResultLauncher callbacks for a more modern Android development experience.
  • Enhanced Features and UI: FirebaseUI Auth v10 introduces Credential Manager integration for faster sign-in, Material 3 UI that can inherit app themes, and built-in flows for multi-factor authentication, account management, linking, and anonymous user upgrades.
  • Comprehensive Provider Configuration: The guide details how to configure various authentication providers, including email/password, phone, Google, Facebook, Apple, GitHub, Microsoft, Yahoo, Twitter, anonymous auth, and custom OAuth, with specific setup instructions for Google Sign-In and Facebook Login.
  • Customization and Theming: Version 10.x offers significantly more customization options, allowing developers to set themes directly in authUIConfiguration, inherit app themes, or build fully custom AuthUITheme instances.
  • Migration Guidance: The documentation provides clear mapping for migrating from older FirebaseUI Auth flows (9.x), explaining how AuthUI.getInstance().createSignInIntentBuilder() and AuthUI.IdpConfig.*Builder() translate to the new Compose-based APIs.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

The pull request introduces a new GETTING_STARTED.md documentation file for FirebaseUI Auth for Android, detailing its features, setup, provider configuration, sign-in/out flows, customization, and migration guidance. A review comment suggests improving the dependency declarations in this new guide by replacing <latest-version> placeholders with specific, known-working versions to prevent potential build issues and enhance user experience.

@russellwheatley russellwheatley marked this pull request as ready for review March 24, 2026 09:44
Copy link
Copy Markdown
Member

@demolaf demolaf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

## Before you begin

1. [Add Firebase to your Android project](https://firebase.google.com/docs/android/setup).
2. Make sure your app is set up for Jetpack Compose.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does this mean? Is there a way for us to point developers to docs for them to check whether or not their app is setup for Jetpack Compose?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's assume developers reading this guide are already using Jetpack Compose and remove this line.

@@ -0,0 +1,270 @@
# FirebaseUI Auth for Android
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keeping the existing title

Suggested change
# FirebaseUI Auth for Android
# Easily add sign-in to your Android app with FirebaseUI

@@ -0,0 +1,270 @@
# FirebaseUI Auth for Android

FirebaseUI Auth is a modern, Compose-based authentication library for Firebase Authentication on Android.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep the existing text?

Suggested change
FirebaseUI Auth is a modern, Compose-based authentication library for Firebase Authentication on Android.
[FirebaseUI](https://github.com/firebase/firebaseui-android) Auth is a library built on top of the Firebase Authentication SDK that provides drop-in UI flows for use in your app.


FirebaseUI Auth is a modern, Compose-based authentication library for Firebase Authentication on Android.

`10.x` is currently a beta release.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`10.x` is currently a beta release.
Caution: Version 10.x is currently a **beta release**. This means that the functionality might change in backward-incompatible ways or have limited support. A beta release is not subject to any SLA or deprecation policy.

Using "Caution:" will render this paragraph as a warning similar to this:

Image


`10.x` is currently a beta release.

If you used the older FirebaseUI Auth guides, the biggest change in `10.x` is that the recommended sign-in flow now uses Compose screens instead of `Intent` builders and `ActivityResultLauncher` callbacks. For apps that still use Activities, see [Existing Activity-based apps](#existing-activity-based-apps).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you used the older FirebaseUI Auth guides, the biggest change in `10.x` is that the recommended sign-in flow now uses Compose screens instead of `Intent` builders and `ActivityResultLauncher` callbacks. For apps that still use Activities, see [Existing Activity-based apps](#existing-activity-based-apps).
If you used the older FirebaseUI Auth guides, the biggest change in `10.x` is that the recommended sign-in flow now uses Compose screens instead of `Intent` builders and `ActivityResultLauncher` callbacks. For apps that still use Activities, see the [Existing Activity-based apps](#existing-activity-based-apps) section.


## Before you begin

1. [Add Firebase to your Android project](https://firebase.google.com/docs/android/setup).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. [Add Firebase to your Android project](https://firebase.google.com/docs/android/setup).
1. If you haven't already, [add Firebase to your Android project](https://firebase.google.com/docs/android/setup).

Comment on lines +31 to +35
// Required: Jetpack Compose
// Find the latest Compose BOM version here:
// https://developer.android.com/develop/ui/compose/bom
implementation(platform("androidx.compose:compose-bom:2026.03.00"))
implementation("androidx.compose.material3:material3")
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need these

}
```

The high-level FirebaseUI Auth API is Compose-based, so if your app is not already using Compose you will need to enable it first.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove this too


### Google Sign-In

- Enable Google in the Firebase console.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Enable Google in the Firebase console.
- Enable Google Sign-in in the Firebase console.

Comment on lines +47 to +48
Some providers need additional setup before you can sign users in.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if we had a list pointing to the other docs instead of detailing the steps for each of the providers?

For example:

Suggested change
Some providers need additional setup before you can sign users in.
Some providers need additional setup before you can sign users in:
- [Sign in with Google](https://firebase.google.com/docs/auth/android/google-signin)
- [Facebook Login](https://firebase.google.com/docs/auth/android/facebook-login)

(this example is not exhaustive)


This gives you a complete authentication flow with:

- Email/password sign-in and sign-up.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Email/password sign-in and sign-up.
- Password Authentication.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants