https://github.com/tolgee/tolgee-mobile-kotlin-sdk
Compose Multiplatform localization wrapper for Tolgee
https://github.com/tolgee/tolgee-mobile-kotlin-sdk
compose compose-multiplatform i18n kotlin kotlin-android kotlin-library kotlin-multiplatform tolgee
Last synced: 4 months ago
JSON representation
Compose Multiplatform localization wrapper for Tolgee
- Host: GitHub
- URL: https://github.com/tolgee/tolgee-mobile-kotlin-sdk
- Owner: tolgee
- License: apache-2.0
- Created: 2025-01-11T16:03:55.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2025-08-29T15:22:54.000Z (4 months ago)
- Last Synced: 2025-08-31T13:32:49.997Z (4 months ago)
- Topics: compose, compose-multiplatform, i18n, kotlin, kotlin-android, kotlin-library, kotlin-multiplatform, tolgee
- Language: Kotlin
- Homepage: https://tolgee.github.io/tolgee-mobile-kotlin-sdk/
- Size: 2.01 MB
- Stars: 13
- Watchers: 4
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Tolgee Mobile SDK for Android and Compose Multiplatform 🐁
[](https://tolgee.io/)
[](https://github.com/tolgee/tolgee-mobile-kotlin-sdk/releases/latest)
[](https://github.com/tolgee/tolgee-mobile-kotlin-sdk/blob/master/LICENSE)
[](https://github.com/tolgee/tolgee-mobile-kotlin-sdk)
[](https://github.com/tolgee/tolgee-platform)
[](https://github.com/tolgee/tolgee-platform/discussions)
[](https://dev.to/tolgee_i18n)
[](https://docs.tolgee.io/)
[](https://tolg.ee/slack)
[](https://www.youtube.com/@tolgee)
[](https://www.linkedin.com/company/tolgee/)
[](https://x.com/Tolgee_i18n)
## What is Tolgee?
[Tolgee](https://tolgee.io/) is a powerful localization platform that simplifies the translation process for your applications.
This SDK provides integration for Kotlin-based projects, with a primary focus on Android.
Currently, Android is fully supported, but any Kotlin-based codebase can in theory use this library.
## Features
- **Over-the-air updates**: Update your translations without releasing a new app version
- **Multiple format support**:
- Sprintf (Android SDK) formatting
- ICU (Tolgee Native Flat JSON) formatting
- **Compose integration**: Full integration with Jetpack Compose and Compose Multiplatform
- **Kotlin Multiplatform**: Designed with multiplatform support in mind
## Modules
The SDK is split into multiple modules, each serving a specific purpose:
- **[Core](./core/README.md)**: Base library for fetching translations from CDN and querying them
- **[Compose](./compose/README.md)**: Extension for using the library with Jetpack Compose or Compose Multiplatform
## Which Module Should I Use?
- If you are using **traditional Android Views**, use the [Core](./core/README.md) module
- If you are using **Jetpack Compose** or **Compose Multiplatform**, use the [Compose](./compose/README.md) module
## Installation
> [!NOTE]
> For managing static translations (used as fallback), check out [tolgee-cli](https://github.com/tolgee/tolgee-cli).
> It provides tools for updating and syncing your static translation files.
>
> In each demo project you can find an example of `.tolgeerc` configuration file.
Using Version Catalog is highly recommended to keep your versions aligned.
### Core Module (Traditional Android)
```toml
# gradle/libs.versions.toml
[libraries]
tolgee = { group = "io.tolgee.mobile-kotlin-sdk", name = "core", version.ref = "tolgee" }
```
```kotlin
// build.gradle.kts
dependencies {
implementation(libs.tolgee)
}
```
### Compose Module (Jetpack Compose or Compose Multiplatform)
```toml
# gradle/libs.versions.toml
[libraries]
tolgee = { group = "io.tolgee.mobile-kotlin-sdk", name = "compose", version.ref = "tolgee" }
```
```kotlin
// build.gradle.kts
dependencies {
implementation(libs.tolgee)
}
```
## Basic Usage
For detailed usage instructions, please refer to the module-specific documentation:
- [Core Module Documentation](./core/README.md)—For traditional Android and base functionality
- [Compose Module Documentation](./compose/README.md)—For Jetpack Compose and Compose Multiplatform
### Quick Start
Here's a quick example of initializing Tolgee in an Android application:
```kotlin
class MyApplication : Application() {
override fun onCreate() {
super.onCreate()
Tolgee.init {
contentDelivery {
url = "https://cdn.tolg.ee/your-cdn-url-prefix"
storage = TolgeeStorageProviderAndroid(this@MyApplication, BuildConfig.VERSION_CODE)
}
}
}
}
```
## Example Projects
For complete examples of how to use the Tolgee SDK, check out the demo projects:
- [Example Android](./demo/exampleandroid)—Traditional Android Views example
- [Example Jetpack](./demo/examplejetpack)—Jetpack Compose example
- [Multiplatform Compose](./demo/multiplatform-compose)—Compose Multiplatform example
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Check out [guidelines.md](.junie/guidelines.md) for some information about the project internals and information about the workflow.
## License
This project is licensed under the Apache License 2.0—see the [LICENSE](LICENSE) file for details.
## Contributors
Let us know what you think! #FeedbackWanted ❤️
----
🧀