Skip to content

Commit 58f7ba2

Browse files
author
Thomas Cesare-Herriau
committed
Fixed README formatting issues
Change-Id: I999e2be06aa038444f214b3f8cbe565e23960135
1 parent 5298a8b commit 58f7ba2

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,8 @@ The FirebaseUI component implements best practices for authentication on mobile
1212
websites, helping to sign-in and sign-up conversion for your app. It also handles cases like account
1313
recovery and account linking that can be security sensitive and error-prone to handle.
1414

15-
FirebaseUI Auth clients are also available for
16-
[iOS](https://github.com/firebase/firebaseui-ios/tree/master/auth) and
17-
[Android](https://github.com/firebase/firebaseui-android/tree/master/auth).
15+
FirebaseUI Auth clients are also available for [iOS](https://github.com/firebase/firebaseui-ios) and
16+
[Android](https://github.com/firebase/firebaseui-android).
1817

1918
## Table of Contents
2019

@@ -38,6 +37,7 @@ You just need to include the following code in the `<head>` tag of your page:
3837
## Using FirebaseUI for Authentication
3938

4039
FirebaseUI includes the following flows:
40+
4141
1. Interaction with Identity Providers such as Google and Facebook
4242
2. Sign-up and sign-in with email accounts
4343
3. Password reset
@@ -98,7 +98,6 @@ The following example shows how to set up a sign-in screen with all supported pr
9898
'tosUrl': '<your-tos-url>',
9999
};
100100
101-
102101
// Initialize the FirebaseUI Widget using Firebase.
103102
var app = firebase.initializeApp(config);
104103
var auth = app.auth();
@@ -214,22 +213,27 @@ FirebaseUI supports the following configuration parameters.
214213

215214
Currently only one callback is supported. Some will be added soon to monitor UI changes.
216215

217-
#### `signInSuccess(currentUser: !firebase.User, credential : ?firebase.auth.AuthCredential, redirectUrl : ?string):boolean`
216+
`signInSuccess(currentUser, credential, redirectUrl)`
217+
218+
**Parameters:**
218219

219-
- `currentUser`: The logged in user.
220-
- `credential`: Optional. The credential used to sign in the user.
221-
- `redirectUrl`: Optional. The URL where the user is redirected after the callback finishes. It will
222-
only be given if you [overwrite the sign-in success URL](#overwriting-the-sign-in-success-url).
220+
|Name |Type | Optional|Description |
221+
|-------------|------------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
222+
|`currentUser`|`firebase.User` |No |The logged in user. |
223+
|`credential` |`firebase.auth.AuthCredential`|Yes |he credential used to sign in the user. |
224+
|`redirectUrl`|`string` |Yes |The URL where the user is redirected after the callback finishes. It will only be given if you [overwrite the sign-in success URL](#overwriting-the-sign-in-success-url).|
223225

224-
If the callback returns true, then the page is automatically redirected depending on the case:
226+
**Should return: `boolean`**
227+
228+
If the callback returns `true`, then the page is automatically redirected depending on the case:
225229

226230
- If no `signInSuccessUrl` parameter was given in the URL (See:
227231
[Overwriting the sign-in success URL](#overwriting-the-sign-in-success-url)) then the default
228232
`signInSuccessUrl` in config is used.
229233
- If the value is provided in the URL, that value will be used instead of the static
230234
`signInSuccessUrl` in config.
231235

232-
If the callback returns false or nothing, the page is not automatically redirected.
236+
If the callback returns `false` or nothing, the page is not automatically redirected.
233237

234238

235239
### Example with all parameters used
@@ -275,7 +279,6 @@ If the callback returns false or nothing, the page is not automatically redirect
275279
}
276280
};
277281
278-
279282
// Initialize the FirebaseUI Widget using Firebase.
280283
var app = firebase.initializeApp(config);
281284
var auth = app.auth();

0 commit comments

Comments
 (0)