Merge pull request #16468 from vector-im/travis/welcome-login

Docs for `loginForWelcome`
This commit is contained in:
Travis Ralston 2021-03-19 09:12:42 -06:00 committed by GitHub
commit a1c602c98e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -72,6 +72,9 @@ For a good example, see https://develop.element.io/config.json.
1. `homeUrl`: Content shown on the inside of the app when a specific room is 1. `homeUrl`: Content shown on the inside of the app when a specific room is
not selected. By default, no home page is configured. If one is set, a not selected. By default, no home page is configured. If one is set, a
button to access it will be shown in the top left menu. button to access it will be shown in the top left menu.
1. `loginForWelcome`: Overrides `welcomeUrl` to make the welcome page be the
same page as the login page when `true`. This effectively disables the
welcome page.
1. `defaultCountryCode`: The ISO 3166 alpha2 country code to use when showing 1. `defaultCountryCode`: The ISO 3166 alpha2 country code to use when showing
country selectors, like the phone number input on the registration page. country selectors, like the phone number input on the registration page.
Defaults to `GB` if the given code is unknown or not provided. Defaults to `GB` if the given code is unknown or not provided.