Skip to content

Commit 0b36775

Browse files
authored
Docs for version 7.0 (#1863)
1 parent 7254e91 commit 0b36775

File tree

3 files changed

+71
-1
lines changed

3 files changed

+71
-1
lines changed

auth/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ and [Web](https://github.com/firebase/firebaseui-web/).
3232
1. [Demo](#demo)
3333
1. [Configuration](#configuration)
3434
1. [Provider config](#identity-provider-configuration)
35+
1. [Auth emulator config](#auth-emulator-configuration)
3536
1. [Usage instructions](#using-firebaseui-for-authentication)
3637
1. [AuthUI sign-in](#authui-sign-in)
3738
1. [Handling responses](#handling-the-sign-in-response)
@@ -150,6 +151,25 @@ Note: unlike other sign-in methods, signing in with these providers involves the
150151
You must enable the "Request email addresses from users" permission in the "Permissions" tab of your
151152
Twitter app.
152153

154+
### Auth emulator configuration
155+
156+
As of version `7.0.0` FirebaseUI is compatible with the Firebase Authentication emulator:
157+
https://firebase.google.com/docs/emulator-suite
158+
159+
Use the `useEmulator` method to point an AuthUI instance at the emulator:
160+
161+
```java
162+
AuthUI authUI = AuthUI.getInstance();
163+
164+
// "10.0.2.2" is the special host value for contacting "localhost" from within
165+
// the Android Emulator
166+
authUI.useEmulator("10.0.2.2", 9099);
167+
```
168+
169+
By default Android blocks connections to `http://` endpoints such as the Auth emulator.
170+
To allow your app to communicate with the Auth emulator, use a [network security configuration](https://developer.android.com/training/articles/security-config)
171+
or set `android:usesCleartextTraffic="true"` in `AndroidManifest.xml`.
172+
153173
## Using FirebaseUI for authentication
154174

155175
Before invoking the FirebaseUI authentication flow, your app should check

buildSrc/src/main/kotlin/Config.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ object Config {
5050
}
5151

5252
object PlayServices {
53-
const val auth = "com.google.android.gms:play-services-auth:18.0.0"
53+
const val auth = "com.google.android.gms:play-services-auth:19.0.0"
5454
}
5555

5656
object Provider {

docs/upgrade-to-7.0.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Upgrading to FirebaseUI 7.0
2+
3+
FirebaseUI version `7.0.0` has no breaking API changes from version `6.4.0` but updates
4+
critical dependencies to new major versions.
5+
6+
Below is a comprehensive list of all of the relevant dependencies for each module of FirebaseUI.
7+
8+
**Auth**
9+
10+
```
11+
androidx.browser:browser:1.0.0
12+
androidx.cardview:cardview:1.0.0
13+
androidx.constraintlayout:constraintlayout:2.0.4 (breaking)
14+
androidx.lifecycle:lifecycle-extensions:2.2.0
15+
androidx.legacy:legacy-support-v4:1.0.0
16+
com.google.android.material:material:1.2.1
17+
com.google.android.gms:play-services-auth:19.0.0 (breaking)
18+
com.google.firebase:firebase-auth:20.0.0 (breaking)
19+
```
20+
21+
**Common**
22+
23+
```
24+
androidx.annotation:annotation:1.1.0
25+
androidx.lifecycle:lifecycle-runtime:2.2.0
26+
androidx.lifecycle:lifecycle-viewmodel:2.2.0
27+
```
28+
29+
**Database**
30+
31+
```
32+
androidx.legacy:legacy-support-v4:1.0.0
33+
androidx.recyclerview:recyclerview:1.1.0
34+
com.google.firebase:firebase-database:19.5.1
35+
```
36+
37+
**Firestore**
38+
39+
```
40+
androidx.legacy:legacy-support-v4:1.0.0
41+
androidx.recyclerview:recyclerview:1.1.0
42+
com.google.firebase:firebase-firestore:22.0.0 (breaking)
43+
```
44+
45+
**Storage**
46+
47+
```
48+
androidx.legacy:legacy-support-v4:1.0.0
49+
com.google.firebase:firebase-storage:19.2.0
50+
```

0 commit comments

Comments
 (0)