Add locale documentation

uphold · May 3, 2024 · 6327303 · 6327303
1 parent a947b85
commit 6327303
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 2 deletions.
diff --git a/docs/locale.md b/docs/locale.md
@@ -0,0 +1,25 @@
+---
+sidebar_position: 9
+---
+
+# Locale
+
+**What are the languages supported by Topper?**
+
+Topper supports English and Brazilian Portuguese.
+
+**How to set a specific locale?**
+
+By default, Topper will use the locale set on the user's browser. If that locale is not supported it will default to English.
+
+To set a specific locale, you can set it as query parameter such as: `https://app.topperpay.com/?bt=<bootstrap token>&locale=en`. The supported values are `en` and `pt`.
+
+When the user user authenticates in Topper, the locale will be set accordingly with the user preferences.
+
+**Using the [Web SDK](./web-sdk.md):**
+
+```js
+const topper = new TopperWebSdk({ locale: TOPPER_LOCALES.PT });
+
+topper.initialize({ bootstrapToken: <bootstrap token> });
+```
diff --git a/docs/theming.md b/docs/theming.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 9
+sidebar_position: 10
 ---
 
 # Theming

diff --git a/docs/web-sdk.md b/docs/web-sdk.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 10
+sidebar_position: 11
 ---
 
 # Web SDK