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
@@ -17,9 +16,15 @@ For managing static translations in your repository, consider using the [Tolgee
17
16
18
17
## Overview
19
18
20
-
Tolgee Mobile SDK for **Android** and **Compose Multiplatform** lets you localize Kotlin-based applications with **dynamic content delivery**, providing translations dynamically without needing to publish new app versions.
19
+
Tolgee Mobile SDK for **Android** and **Compose Multiplatform** lets you localize Kotlin-based applications with **dynamic content delivery**, adapting content to user behavior, preferences, and device data.
21
20
22
-
**Supports Over‑the‑Air (OTA)** translation updates, seamless integration with **Android Views**, **Jetpack Compose**, **Compose Multiplatform**, and **static translation fallbacks**.
21
+
**Supports Over‑the‑Air (OTA)** translation updates, providing translations dynamically **without needing to publish new app versions**.
22
+
23
+
The platform works offline with **caching**, **fallbacks**, **device-aware resource selection**, and **preloading** of critical namespaces for a smooth user experience. Tolgee **keeps UX consistent** by updating the UI automatically in response to locale changes, resulting in **fewer untranslated or mismatched strings**.
24
+
25
+
:::info
26
+
Tolgee gives you multiple hosting options: Cloud CDN (Cloud or self‑hosting) or your own CDN.
27
+
:::
23
28
24
29
## Features
25
30
@@ -50,6 +55,22 @@ Tolgee Mobile SDK for **Android** and **Compose Multiplatform** lets you localiz
50
55
}
51
56
]} />
52
57
58
+
59
+
## Modules
60
+
61
+
Tolgee Mobile SDK is split into modules so you only add what you need.
62
+
63
+
### When to use which module
64
+
-**Core**
65
+
- Use with traditional Android Views or any non-Compose UI.
This guide shows you how to integrate Tolgee Mobile SDK using the **Core module** for traditional Android Views.
28
28
29
29
The **Core module** is a Kotlin Multiplatform library that provides runtime support for Tolgee translations in your app. With Tolgee, you can update your translations **over-the-air** without releasing a new app version.
30
30
31
31
:::info
32
-
Using **Version Catalog** is recommended to keep your versions aligned, especially in bigger projects. This provides **readability, centralization, and consistency**.
32
+
Using **Version Catalog** is recommended to keep your versions aligned, especially in bigger projects. This provides **readability, centralization, and consistency**.
33
33
:::
34
34
35
35
:::note
@@ -38,34 +38,34 @@ To build configuration examples use Kotlin DSL (build.gradle.kts). Groovy DSL ma
38
38
39
39
1. Add dependency (Core):
40
40
41
-
In `gradle/libs.versions.toml` <u>add an alias for Tolgee library</u>.
41
+
In `gradle/libs.versions.toml` <u>add an alias for Tolgee library</u>.
42
42
43
-
```toml
44
-
# gradle/libs.versions.toml
45
-
[libraries]
46
-
tolgee = { group = "io.tolgee.mobile-kotlin-sdk", name = "core", version.ref = "tolgee" }
47
-
```
43
+
```toml
44
+
# gradle/libs.versions.toml
45
+
[libraries]
46
+
tolgee = { group = "io.tolgee.mobile-kotlin-sdk", name = "core", version.ref = "tolgee" }
47
+
```
48
48
49
-
Then, in `build.gradle.kts`, <u>use the created alias</u>.
49
+
Then, in `build.gradle.kts`, <u>use the created alias</u>.
50
50
51
-
```kotlin
52
-
// build.gradle.kts (module)
53
-
dependencies {
54
-
implementation(libs.tolgee)
55
-
}
56
-
```
51
+
```kotlin
52
+
// build.gradle.kts (module)
53
+
dependencies {
54
+
implementation(libs.tolgee)
55
+
}
56
+
```
57
57
58
58
For **smaller projects** you can also add dependency directly (the old way).
To use the library, **you need to have proper repositories configured** in your project.
79
80
Otherwise an error like:
80
81
81
82
```text
82
83
Could not find io.tolgee.mobile-kotlin-sdk:core
83
84
```
85
+
84
86
might pop up.
85
87
Make sure **Maven Central** is set up properly so the dependency can be resolved.
86
88
@@ -106,7 +108,7 @@ Add network security config to your `AndroidManifest.xml`:
106
108
</application>
107
109
```
108
110
109
-
:::note
111
+
:::info
110
112
Allowing `tolgee.io` and `tolg.ee` domains is required when using Tolgee Cloud CDN. If you only access your own self-hosted CDN, include your domain(s) accordingly.
111
113
:::
112
114
@@ -130,13 +132,14 @@ class MyApplication : Application() {
130
132
131
133
When your app boots up, Tolgee is globally initialized. The translations are downloaded from CDN and cached locally. Other parts of your app (such as activities and fragments) can now use Tolgee without additional configuration.
132
134
133
-
***Make sure that your app knows where to download translations***:
135
+
**_Make sure that your app knows where to download translations_**:
134
136
135
137
For your app to download translation files, you need to provide a CDN URL prefix specific to your project. This prefix points to the catalog that contains your app’s translations.
136
138
137
139
### How to get your CDN URL prefix (Content Delivery):
140
+
138
141
1. Open Tolgee Platform → your Project → Developer settings → Content Delivery.
139
-
2. Copy the full CDN URL prefix.
142
+
2. Copy the full CDN URL prefix.
140
143
3. You can use different prefixes per environment (dev/staging/prod).
141
144
142
145
### Optional: Verify connectivity locally:
@@ -145,31 +148,29 @@ For your app to download translation files, you need to provide a CDN URL prefix
If you get 403 (Forbidden) or 404 (Not found), double‑check the prefix.
150
153
151
154
:::tip
152
155
Dynamic updates without republishing
153
156
:::
154
157
155
-
To receive fresh translations without needing to publish new app versions, wrap the base context in your Activities.
156
-
This way, APIs like getString() will use Tolgee dynamically.
158
+
To receive **fresh translations without needing to publish new app versions**, wrap the base context in your Activities.
159
+
This way, APIs like getString will use Tolgee **dynamically**.
157
160
158
-
- With wrapped context → fresh translations from the Tolgee CDN will be provided automatically.
161
+
-**With wrapped context** → fresh translations from the Tolgee CDN will be provided automatically.
159
162
160
-
- Without wrapped context → only the translations already bundled or previously cached will be available.
163
+
-**Without wrapped context** → only the translations already bundled or previously cached will be available.
161
164
162
-
See the step-by-step guide in Usage.
165
+
**See the step-by-step guide in Usage.**
163
166
164
-
:::note
167
+
:::info
165
168
If you have a different integration setup (for example, using tolgee-cli and bundling JSON translation files in assets), the initialization may look different.
166
169
:::
167
170
168
-
169
171
## Next steps
170
172
171
-
- Not sure which artifact to use? See [`Modules overview`](./modules.mdx)
173
+
- Not sure which artifact to use? See ['overview`](./about.mdx)
172
174
- Learn how to fetch and render translations in Views: [`Usage`](./usage.mdx)
173
175
- Using Compose? Start here: [`Jetpack Installation`](./jetpack/installation.mdx)
174
176
- Having issues? Check [`Troubleshooting`](./troubleshooting.mdx)
0 commit comments