You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: en/includes/guides/branding/localization/localization-overview.md
+41-29Lines changed: 41 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,21 @@
1
1
# Localization in {{ product_name }}
2
2
3
-
{{ product_name }} enables a language picker on the following interfaces exposed to business users, allowing business users to select their preferred language.
3
+
{{ product_name }} lets you pick the language for the following interfaces exposed to business users.
4
4
5
-
-Interfaces related to the business user registration/sign-up flow, login flows (including MFA), and the account recovery flow.
6
-
-Interfaces of the self-care portal (My Account)
5
+
-User registration, sign-up, login and the account recovery flows.
6
+
-Self-care portal, **My Account**.
7
7
8
8
The **default language** on these interfaces is configured as explained in the [language settings](#language-settings) section.
9
9
10
10
!!! note "Important"
11
-
When [user attributes]({{base_path}}/guides/users/attributes/manage-attributes/) configured on {{ product_name }} are displayed to users (during user sign-up and consent management flows), only the default user attributes get translated.
12
11
13
-
These interfaces are i18n-supported, which allows {{ product_name }} to update the text content from i18n resource files. This feature allows your business users to experience these use cases in their preferred language. The languages that {{ product_name }} currently supports are listed below.
12
+
In the user **sign-up** and **attribute consent** screens, {{product_name}} only translates the default user attributes.
13
+
14
+
These interfaces support i18n, allowing {{product_name}} to load text content from i18n resource files. This ensures that your business users can experience these use cases in their preferred language.
14
15
15
16
## Supported languages
16
17
17
-
Below are the languages currently available for the i18n-supported user interfaces of {{ product_name }}.
18
+
{{product_name}} provides i18n-supported user interfaces in the following languages.
18
19
19
20
<table>
20
21
<tr>
@@ -99,46 +100,53 @@ Below are the languages currently available for the i18n-supported user interfac
99
100
</tr>
100
101
</table>
101
102
102
-
## Language settings
103
+
## Configure language settings
103
104
104
-
The following methods can set the language used by {{ product_name}} interfaces exposed to business users.
105
+
You can use the following language settings to configure the {{product_name}} interfaces exposed to the business user.
105
106
106
107
### Language switcher
107
108
108
-
The language switcher is available at the footer of the (i18n-supported) {{ product_name }} interfaces, which allows business users to select the preferred language for {{ product_name }}.
109
+
Users can use the language switcher available at the footer of the i18n-supported {{ product_name }} interfaces to select the preferred language.
110
+
111
+
!!! note
109
112
110
-
Note that {{ product_name }} will remember the language selected from this switcher, and it will be applied to all i18n-supported interfaces.
113
+
{{ product_name }} remembers this setting and applies it to all i18n-supported interfaces.
111
114
112
115
### Browser-level settings
113
116
114
-
{{product_name}} interfaces automatically adapt to the language preference set in the user's browser, as long as the language is supported by {{ product_name }}. However, the user can still change the language on the {{ product_name }} interfaces by using the [language switcher](#language-switcher).
117
+
{{product_name}} automatically adapts to each user's browser language preference as long as it's a supported language. Users can still manually change the language using the [language switcher](#language-switcher).
115
118
116
119
### Application-level settings
117
120
118
-
As an application developer, you can configure the application to send the `ui_locales` parameter in the sign-in request or authorization request when the user signs in to the application.
121
+
You can configure the application to send the `ui_locales` parameter in the sign-in or authorization request when a user signs in to the application.
122
+
123
+
It works as follows,
124
+
125
+
- You provide a list of strings, separated by a space, to define the locales.
126
+
127
+
- {{ product_name }} searches through the list until it finds a supported locale.
128
+
129
+
- If found, {{product_name}} sets that language as the default locale. If not, it uses the [browser-level](#browser-level-settings) setting.
119
130
120
131
!!! note "Important"
121
-
The `ui_locale` parameter is only available for OIDC flows and not for SAML flows.
122
132
123
-
You can provide a list of strings, separated by a space, to define the locales. {{ product_name }} will search through the list until an {{ product_name }}-supported locale is found, and the first {{ product_name }}-supported locale in the list will be used as the default locale. If a supported locale is not found, {{ product_name }} will use the [browser-level locale](#browser-level-settings).
133
+
The `ui_locale` parameter works only with OIDC flows and not with SAML flows.
124
134
125
135
Consider the following examples:
126
136
127
-
- If the `ui_locales`is sent as `fr_FR`, **French**is used as the default locale.
128
-
- If the `ui_locales`is sent as `fr_FR en_US`, **French**will be the default locale since it's the first {{ product_name }}-support locale in the list.
129
-
- If the `ui_locales`is sent as `it_IT en_US`, **English (en_US)**will be used as the default locale because the first given locale (`it_IT`) is not supported.
137
+
- If the `ui_locales`set to `fr_FR`, {{product_name}} sets **French** as the default locale.
138
+
- If the `ui_locales`set to `fr_FR en_US`, {{product_name}} sets **French**as the default locale since it's the first language in the list that {{ product_name }} supports.
139
+
- If the `ui_locales`set to `it_IT en_US`, {{product_name}} sets **English (en_US)** as the default locale as it doesn't support `it_IT`.
130
140
131
-
The following examples demonstrate how to set the `ui_locales` parameter in your application.
141
+
The following examples show how to set the `ui_locales` parameter in your application.
132
142
133
-
-**Example 1:**Setting the default locale from the `signIn` request.
143
+
-**Example 1:**Using the SDK.
134
144
135
-
You can send the `ui_locales` in the signIn request as a parameter.
145
+
The following sample illustrates how to set the `ui_locales`parameter in the `signIn` request using the JS/React SDK.
136
146
137
147
!!! note
138
148
Learn more about [setting the signIn request](https://github.com/asgardeo/asgardeo-auth-spa-sdk#signin){:target="_blank"} using the {{ product_name }} SDKs.
139
149
140
-
The following sample illustrates the `signIn` request using the JS/React SDK.
141
-
142
150
```Js
143
151
<SecureApp
144
152
fallback={<div>Loading</div>}
@@ -152,13 +160,17 @@ The following examples demonstrate how to set the `ui_locales` parameter in your
152
160
</SecureApp>
153
161
```
154
162
155
-
-**Example 2:**Setting the default locale from the authorization request.
163
+
-**Example 2:**Directly in the authorization request.
156
164
157
-
If you are sending the locale in the authorization request directly, you can append the `ui_locales`query parameterwith the list of locales as shown below.
165
+
You can append the `ui_locales` directly in the authorization request as a query parameter as shown below.
158
166
159
-
```
160
-
{{ product_url_format }}/oauth2/userinfo?scope={scope}&response_type=code&redirect_uri={redirect_uri}&client_id={client_id}&ui_locales={ locales list }
!!! note "Privacy policy and Terms of conditions URLs"
164
-
The privacy policy and terms of conditions URLs are specified in your [branding configurations]({{base_path}}/guides/branding/configure-ui-branding/#advanced-preferences). The `ui_locales={ locales list }` parameter is appended to these URLs, which allows you to show the translated content for the user from your end.
175
+
!!! note "Translation of privacy policy and terms of conditions"
176
+
{{product_name}} attaches the `ui_locales={ locales list }` parameter to the privacy policy and terms of condition URLs set in the [branding configurations]({{base_path}}/guides/branding/configure-ui-branding/#advanced-preferences). This allows you to show users the translated content.
0 commit comments