Skip to content

Commit 9da1d5d

Browse files
docs: api reference regarding buttons being rendered
1 parent 10e76f1 commit 9da1d5d

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

FirebaseSwiftUI/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -770,7 +770,7 @@ Creates a new `AuthService` instance.
770770
public func withEmailSignIn() -> AuthService
771771
```
772772

773-
Enables email/password and email link authentication. Uses default behavior (navigates to email link view when tapped).
773+
Enables email/password and email link authentication and will register an email button that is rendered in AuthPickerView (default Views) or can be rendered in custom Views by calling `AuthService.renderButtons()`. Uses default behavior (navigates to email link view when tapped).
774774

775775
**Example:**
776776

@@ -783,7 +783,7 @@ authService
783783
public func withEmailSignIn(onTap: @escaping () -> Void) -> AuthService
784784
```
785785

786-
Enables email authentication with a custom callback (i.e where to navigate when tapped) when the email button is tapped.
786+
Enables email authentication and will register an email button that is rendered in AuthPickerView (default Views) or can be rendered in custom Views by calling `AuthService.renderButtons()`. Uses a custom callback (i.e where to navigate when tapped) when the email button is tapped.
787787

788788
**Example:**
789789

@@ -803,7 +803,7 @@ authService
803803
public func withPhoneSignIn() -> AuthService
804804
```
805805

806-
Enables phone number authentication with SMS verification. Uses default behavior (navigates to enter phone number view when tapped).
806+
Enables phone number authentication with SMS verification and will register a phone button that is rendered in AuthPickerView (default Views) or can be rendered in custom Views by calling `AuthService.renderButtons()`. Uses default behavior (navigates to enter phone number view when tapped).
807807

808808
**Example:**
809809

@@ -816,7 +816,7 @@ authService
816816
public func withPhoneSignIn(onTap: @escaping () -> Void) -> AuthService
817817
```
818818

819-
Enables phone authentication with a custom callback (i.e where to navigate when tapped) when the phone button is tapped.
819+
Enables phone authentication and will register a phone button that is rendered in AuthPickerView (default Views) or can be rendered in custom Views by calling `AuthService.renderButtons()`. Uses a custom callback (i.e where to navigate when tapped) when the phone button is tapped.
820820

821821
**Example:**
822822

@@ -836,7 +836,7 @@ authService
836836
public func withAppleSignIn() -> AuthService
837837
```
838838

839-
Enables Sign in with Apple authentication.
839+
Enables Sign in with Apple authentication and will register an apple button that is rendered in `AuthPickerView` (default Views) or can be rendered in custom Views by calling `AuthService.renderButtons()`.
840840

841841
**Example:**
842842

@@ -854,7 +854,7 @@ authService
854854
public func withGoogleSignIn() -> AuthService
855855
```
856856

857-
Enables Sign in with Google authentication.
857+
Enables Sign in with Google authentication and will register a Google button that is rendered in AuthPickerView (default Views) or can be rendered in custom Views by calling `AuthService.renderButtons()`.
858858

859859
**Example:**
860860

@@ -872,7 +872,7 @@ authService
872872
public func withFacebookSignIn(_ provider: FacebookProviderSwift) -> AuthService
873873
```
874874

875-
Enables Sign in with Facebook authentication.
875+
Enables Sign in with Facebook authentication and will register a Facebook button that is rendered in AuthPickerView (default Views) or can be rendered in custom Views by calling `AuthService.renderButtons()`.
876876

877877
**Parameters:**
878878
- `provider`: An instance of `FacebookProviderSwift()` for classic login or `FacebookProviderSwift(useClassicLogin: false)` for limited login.
@@ -893,7 +893,7 @@ authService
893893
public func withTwitterSignIn() -> AuthService
894894
```
895895

896-
Enables Sign in with Twitter authentication.
896+
Enables Sign in with Twitter authentication and will register a Twitter button that is rendered in AuthPickerView (default Views) or can be rendered in custom Views by calling `AuthService.renderButtons()`.
897897

898898
**Example:**
899899

@@ -911,7 +911,7 @@ authService
911911
public func withOAuthSignIn(_ provider: OAuthProviderSwift) -> AuthService
912912
```
913913

914-
Enables authentication with generic OAuth/OIDC providers.
914+
Enables authentication with generic OAuth/OIDC providers and will register an OAuth button that is rendered in AuthPickerView (default Views) or can be rendered in custom Views by calling `AuthService.renderButtons()`.
915915

916916
**Built-in Providers:**
917917
- `OAuthProviderSwift.github()`

0 commit comments

Comments
 (0)