Skip to content

Commit dd611cd

Browse files
authored
docs(ui_auth): add docs links to the package README (#10104)
add naming conflicts resolution instructions
1 parent afc0105 commit dd611cd

File tree

5 files changed

+27
-12
lines changed

5 files changed

+27
-12
lines changed

packages/firebase_ui_auth/README.md

+14-3
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ Firebase UI Auth is a set of Flutter widgets and utilities designed to help you
2828
flutter pub add firebase_ui_auth
2929
```
3030

31-
## Getting Started
31+
## Example
3232

3333
Here's a quick example that shows how to build a `SignInScreen` and `ProfileScreen` in your app
3434

3535
```dart
3636
import 'package:flutter/material.dart';
37-
import 'package:firebase_auth/firebase_auth.dart';
37+
import 'package:firebase_auth/firebase_auth.dart' hide EmailAuthProvider;
3838
import 'package:firebase_ui_auth/firebase_ui_auth.dart';
3939
4040
class MyApp extends StatelessWidget {
@@ -71,7 +71,18 @@ class MyApp extends StatelessWidget {
7171
}
7272
```
7373

74-
Learn more [here](https://github.com/firebase/flutterfire/tree/master/packages/firebase_ui_auth/doc).
74+
## Docs
75+
76+
Find relevant documentation [here](https://github.com/firebase/flutterfire/tree/master/packages/firebase_ui_auth/doc)
77+
78+
- [Getting started](https://github.com/firebase/flutterfire/tree/master/packages/firebase_ui_auth/doc)
79+
- Auth providers.
80+
- [Email auth provider](https://github.com/firebase/flutterfire/blob/master/packages/firebase_ui_auth/doc/providers/email.md) – sign in using email and password.
81+
- [Email verification](https://github.com/firebase/flutterfire/blob/master/packages/firebase_ui_auth/doc/providers/email-verification.md) - verify email.
82+
- [Email link sign in](https://github.com/firebase/flutterfire/blob/master/packages/firebase_ui_auth/doc/providers/email-link.md) - sign in using a link sent to email.
83+
- [Phone auth provider](https://github.com/firebase/flutterfire/blob/master/packages/firebase_ui_auth/doc/providers/phone.md) - sign in using phone number.
84+
- [Universal email sign in](https://github.com/firebase/flutterfire/blob/master/packages/firebase_ui_auth/doc/providers/universal-email-sign-in.md) - resolve connected providers based on email and sign in using one of those.
85+
- [OAuth](https://github.com/firebase/flutterfire/blob/master/packages/firebase_ui_auth/doc/providers/oauth.md) - sign in using Apple, Google, Facebook or Twitter.
7586

7687
## Roadmap / Features
7788

packages/firebase_ui_auth/doc/providers/email-link.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Firebase UI Email provider
1+
# Firebase UI Email Link provider
22

33
## Configuration
44

packages/firebase_ui_auth/doc/providers/email.md

+3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ Configure email provider:
1313
import 'package:firebase_core/firebase_core.dart';
1414
import 'package:firebase_ui_auth/firebase_ui_auth.dart';
1515
16+
// If you need to use FirebaseAuth directly, make sure to hide EmailAuthProvider:
17+
// import 'package:firebase_auth/firebase_auth.dart' hide EmailAuthProvider;
18+
1619
import 'firebase_options.dart';
1720
1821
void main() {

packages/firebase_ui_auth/doc/providers/oauth.md

+5-8
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
## Google Sign In
44

5-
To support Google as a provider, first install the official [`google_sign_in`](https://pub.dev/packages/google_sign_in)
6-
plugin to your project as described in the README.
5+
To support Google as a provider, first install the official [`google_sign_in`](https://pub.dev/packages/google_sign_in) plugin to your project as described in the README.
6+
7+
❗️ Important: you need go through configuration steps for each platform as described on the [README](https://pub.dev/packages/google_sign_in).
78

89
Next, enable the "Google" provider in the Firebase Console:
910

@@ -40,11 +41,7 @@ See [Custom screens section](#custom-screens) to learn how to use a button on yo
4041

4142
## Sign in with Apple
4243

43-
To support Apple as a provider, first install the [`sign_in_with_apple`](https://pub.dev/packages/sign_in_with_apple)
44-
plugin to your project. Once added, follow the [Integration](https://pub.dev/packages/sign_in_with_apple#integration) steps
45-
for each platform.
46-
47-
Next, enable the "Apple" provider in the Firebase Console:
44+
To support Apple as a provider, enable the "Apple" provider in the Firebase Console:
4845

4946
![Enable Apple Provider](../images/ui-apple-provider.jpg)
5047

@@ -109,7 +106,7 @@ See [Custom screens section](#custom-screens) to learn how to use a button on yo
109106
## Twitter Login
110107

111108
To support Twitter as a provider, first install the [`twitter_login`](https://pub.dev/packages/twitter_login)
112-
plugin to your project.
109+
plugin to your project and make sure you've performed necessary configuration as described on [README](https://pub.dev/packages/twitter_login).
113110

114111
Next, enable the "Twitter" provider in the Firebase Console:
115112

packages/firebase_ui_auth/doc/providers/phone.md

+4
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ Configure phone provider:
1414

1515
```dart
1616
import 'package:firebase_core/firebase_core.dart';
17+
import 'package:firebase_ui_auth/firebase_ui_auth.dart';
18+
19+
// If you need to use FirebaseAuth directly, make sure to hide PhoneAuthProvider:
20+
// import 'package:firebase_auth/firebase_auth.dart' hide PhoneAuthProvider;
1721
1822
void main() {
1923
WidgetsFlutterBinding.ensureInitialized();

0 commit comments

Comments
 (0)