Skip to content

Commit

Permalink
docs(ui_auth): Removed extra header and fixed typos (#10248)
Browse files Browse the repository at this point in the history
* Removed extra header and fixed typo

* ActionCodeSettings, added missing i

* updated action names; fixed typo

* verificatioN typo

* typo: a -> as a

* typo - emaiL

* typos
  • Loading branch information
EnduringBeta authored Jan 12, 2023
1 parent a541e9a commit 66a1ab5
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 12 deletions.
4 changes: 1 addition & 3 deletions packages/firebase_ui_auth/doc/navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,7 @@ To learn more about the available actions, check out the [FirebaseUIActions API

## Other topics

## Other topics

- [EmaiAuthProvider](./providers/email.md) - allows registering and signing using email and password.
- [EmailAuthProvider](./providers/email.md) - allows registering and signing using email and password.
- [EmailLinkAuthProvider](./providers/email-link.md) - allows registering and signing using a link sent to email.
- [PhoneAuthProvider](./providers/phone.md) - allows registering and signing using a phone number
- [UniversalEmailSignInProvider](./providers/universal-email-sign-in.md) - gets all connected auth providers for a given email.
Expand Down
6 changes: 3 additions & 3 deletions packages/firebase_ui_auth/doc/providers/email-link.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ See [this doc](https://firebase.google.com/docs/auth/flutter/email-link-auth) fo

## Using screen

After adding `EmailLinkAuthProvider` to the `FirebaseUIAuth.configureProviders`, `SignInScreen` or `RegisterScren` will have a button that will trigger `EmailLinkSignInAction`, or, if no action provided, will open `EmailLinkSignInScreen` using `Navigator.push`.
After adding `EmailLinkAuthProvider` to the `FirebaseUIAuth.configureProviders`, `SignInScreen` or `RegisterScreen` will have a button that will trigger `EmailLinkSignInAction`, or, if no action provided, will open `EmailLinkSignInScreen` using `Navigator.push`.

```dart
MaterialApp(
intiialRoute: '/login',
initialRoute: '/login',
routes: {
'/login': (context) {
return SignInScreen(
Expand Down Expand Up @@ -248,7 +248,7 @@ class _CustomEmailLinkSignInState extends State<CustomEmailLinkSignIn>

## Other topics

- [EmaiAuthProvider](./email.md) - allows registering and signing using email and password.
- [EmailAuthProvider](./email.md) - allows registering and signing using email and password.
- [Email verification](./email-verification.md)
- [PhoneAuthProvider](./phone.md) - allows registering and signing using a phone number
- [UniversalEmailSignInProvider](./universal-email-sign-in.md) - gets all connected auth providers for a given email.
Expand Down
10 changes: 5 additions & 5 deletions packages/firebase_ui_auth/doc/providers/email-verification.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ class App extends StatelessWidget {
},
'/profile': (context) => ProfileScreen(),
'/verify-email': (context) => EmailVerificationScreen(
actionCodeSettings: ActionCodeSettngs(...),
actionCodeSettings: ActionCodeSettings(...),
actions: [
EmailVerified(() {
EmailVerifiedAction(() {
Navigator.pushReplacementNamed(context, '/profile');
}),
Cancel((context) {
AuthCancelledAction((context) {
FirebaseUIAuth.signOut(context: context);
Navigator.pushReplacementNamed(context, '/');
}),
Expand All @@ -45,7 +45,7 @@ class App extends StatelessWidget {

Once opened, it triggers a verification email to be sent and will wait for a dynamic link to be received by the app (on supported platforms).

## Using `EmailVerificatioController`
## Using `EmailVerificationController`

If you want to build a custom email verification screen, you could use `EmailVerificationController`:

Expand Down Expand Up @@ -103,7 +103,7 @@ class _MyEmailVerificationScreenState extends State<MyEmailVerificationScreen> {

## Other topics

- [EmaiAuthProvider](./email.md) - allows registering and signing using email and password.
- [EmailAuthProvider](./email.md) - allows registering and signing using email and password.
- [EmailLinkAuthProvider](./email-link.md) - allows registering and signing using a link sent to email.
- [PhoneAuthProvider](./phone.md) - allows registering and signing using a phone number
- [UniversalEmailSignInProvider](./universal-email-sign-in.md) - gets all connected auth providers for a given email.
Expand Down
2 changes: 1 addition & 1 deletion packages/firebase_ui_auth/doc/providers/email.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Configuration

To support email a provider, first ensure that the "Email/Password" provider is
To support email as a provider, first ensure that the "Email/Password" provider is
enabled in the [Firebase Console](https://console.firebase.google.com/project/_/authentication/providers):

![Enable Email/Password Provider](../images/ui-email-provider.jpg)
Expand Down

0 comments on commit 66a1ab5

Please sign in to comment.