Skip to content

Commit 37903bd

Browse files
docs: update README with info on URLS
1 parent 1017208 commit 37903bd

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

FirebaseSwiftUI/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@ public struct AuthConfiguration {
7575
// custom string bundle for string localizations
7676
let customStringsBundle: Bundle?
7777
// terms of service URL
78-
let tosUrl: URL
78+
let tosUrl: URL?
7979
// privacy policy URL
80-
let privacyPolicyUrl: URL
80+
let privacyPolicyUrl: URL?
8181
// action code settings for email sign in link
8282
let emailLinkSignInActionCodeSettings: ActionCodeSettings?
8383
// action code settings verifying email address
@@ -87,13 +87,15 @@ public struct AuthConfiguration {
8787
interactiveDismissEnabled: Bool = true,
8888
shouldAutoUpgradeAnonymousUsers: Bool = false,
8989
customStringsBundle: Bundle? = nil,
90-
tosUrl: URL = URL(string: "https://example.com/tos")!,
91-
privacyPolicyUrl: URL = URL(string: "https://example.com/privacy")!,
90+
tosUrl: URL? = nil,
91+
privacyPolicyUrl: URL? = nil,
9292
emailLinkSignInActionCodeSettings: ActionCodeSettings? = nil,
9393
verifyEmailActionCodeSettings: ActionCodeSettings? = nil)
9494
}
9595
```
9696

97+
> Note: Both `tosUrl` and `privacyPolicyUrl` have to be set for them to be rendered in the UI.
98+
9799
## Configuring providers
98100

99101
1. Ensure the provider is installed from step 1 (e.g. if configuring Google provider, you need to install `FirebaseGoogleSwiftUI` package).

0 commit comments

Comments
 (0)