Skip to content

Commit b824fed

Browse files
committed
chore(ui): add migration guide (#9733)
* chore(ui_auth): add migration guide * chore(ui_auth): add firestore and datatable sections
1 parent a85d4b2 commit b824fed

File tree

1 file changed

+122
-0
lines changed

1 file changed

+122
-0
lines changed

Diff for: packages/firebase_ui_auth/doc/migration.md

+122
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# FlutterFireUI ➡️ FirebaseUI migration guide
2+
3+
To migrate from `flutterfire_ui` package to `firebase_ui_*` family, you need to do the following:
4+
5+
## Updating dependencies
6+
7+
For Firebase Auth widgets:
8+
9+
```diff
10+
dependencies:
11+
- flutterfire_ui: ^0.4.0
12+
+ firebase_ui_auth: ^1.0.0
13+
```
14+
15+
If you're using OAuth providers:
16+
17+
```diff
18+
dependencies:
19+
# ...
20+
+ firebase_ui_oauth: ^1.0.0
21+
+ firebase_ui_oauth_google: ^1.0.0
22+
+ firebase_ui_oauth_apple: ^1.0.0
23+
```
24+
25+
Please make sure to depend only on those providers that are actually being used in your app. Having the provider included, but not configured might lead to unexpected behaviour.
26+
27+
All supported OAuth providers:
28+
29+
- [firebase_ui_oauth_apple](https://pub.dev/packages/firebase_ui_oauth_apple)
30+
- [firebase_ui_oauth_facebook](https://pub.dev/packages/firebase_ui_oauth_facebook)
31+
- [firebase_ui_oauth_google](https://pub.dev/packages/firebase_ui_oauth_google)
32+
- [firebase_ui_oauth_twitter](https://pub.dev/packages/firebase_ui_oauth_twitter)
33+
34+
Make sure to update your imports as well:
35+
36+
```diff
37+
- import 'package:flutterfire_ui/auth.dart';
38+
+ import 'package:firebase_ui_auth/firebase_ui_auth.dart';
39+
```
40+
41+
If you're using OAuth providers, you need to import those from corresponding packages:
42+
43+
```diff
44+
// All OAuth providers used to be under flutterfire_ui
45+
- import 'package:flutterfire_ui/auth.dart';
46+
+ import 'package:firebase_ui_oauth_google/firebase_ui_oauth_google.dart';
47+
```
48+
49+
## Code adjustments
50+
51+
Below is the list of necessary changes that you have to make to migrate to `firebase_ui_*` packages.
52+
53+
### Configuration
54+
55+
- `FlutterFireUIAuth` was renamed to `FirebaseUIAuth`
56+
- instead of passing an instance of `<provider name>ProviderConfiguration` you need to pass an instance of the `<provider name>Provider`
57+
58+
```diff
59+
- FlutterFireUIAuth.configureProviders([
60+
- const EmailProviderConfiguration(),
61+
- ]);
62+
63+
+ FirebaseUIAuth.configureProviders([
64+
+ const EmailProvider(),
65+
+ ]);
66+
```
67+
68+
## Sign out
69+
70+
```diff
71+
- await FlutterFireUIAuth.signOut();
72+
+ await FirebaseUIAuth.signOut();
73+
```
74+
75+
## Profile screen
76+
77+
If you're using `ProfileScreen` – make sure to add the following to your `pubspec.yaml`:
78+
79+
```yaml
80+
fonts:
81+
- family: SocialIcons
82+
fonts:
83+
- asset: packages/firebase_ui_auth/fonts/SocialIcons.ttf
84+
```
85+
86+
## Migrating to `firebase_ui_firestore`
87+
88+
To migrate from `flutterfire_ui` to `firebase_ui_firestore` you need to update your dependencies:
89+
90+
```diff
91+
dependencies:
92+
- flutterfire_ui: ^0.4.0
93+
+ firebase_ui_firestore: ^1.0.0
94+
```
95+
96+
and imports:
97+
98+
```diff
99+
- import 'package:flutterfire_ui/firestore.dart';
100+
+ import 'package:firebase_ui_firestore/firebase_ui_firestore.dart';
101+
```
102+
103+
## Migrating to `firebase_ui_database`
104+
105+
To migrate from `flutterfire_ui` to `firebase_ui_database` you need to update your dependencies:
106+
107+
```diff
108+
dependencies:
109+
- flutterfire_ui: ^0.4.0
110+
+ firebase_ui_database: ^1.0.0
111+
```
112+
113+
and imports:
114+
115+
```diff
116+
- import 'package:flutterfire_ui/database.dart';
117+
+ import 'package:firebase_ui_database/firebase_ui_database.dart';
118+
```
119+
120+
---
121+
122+
> Check out [full documentation](./README.md) for more details.

0 commit comments

Comments
 (0)