The Rokt UX Helper for Android enables partner applications to render tailored user experiences, improving the velocity of testing and relevancy for the customer. This library offers an easy way to perform rendering and provides event hooks for integration into backend systems.
- Thomson Thomas - [email protected]
- Sahil Suri - [email protected]
- Lewis Krishnamurti - [email protected]
| Environment | Build | Coverage |
|---|---|---|
| main |  |
 |
- The latest version of Android Studio.
- Android 5.0 (API level 21) and above
- Android Gradle Plugin 8.1.2
- Gradle 8.9+
- JDK 17
The library is published to Maven Central.
Add roktux to your app-level build.gradle.kts dependencies.
dependencies {
implementation("com.rokt:roktux:0.1.0")
}- You can find a summary of changes in the Changelog
- If there are any migrations between versions you will find instructions in the migration guide
- To learn about how to release the UX Helper modules, check out the releasing guide here
As roktux uses Jetpack Compose, consuming projects should use Compose libraries with compatible versions:
| roktux | Compose BOM |
|---|---|
| 0.1.0 - current | 2024.09.02 |
You can view the BOM to library version mapping here.
When making changes to UX Helper you can utilise the Demo app to validate your changes.
Before submitting changes ensure that:
- Builds succeed with
./gradlew build - Tests pass with
./gradlew test - Lint checks pass with
./gradlew lint
Additional checks are conducted using GitHub Actions which run on all pull requests and are required to pass before the changes are merged. You can find the details of the full pipeline here.
To publish the UX Helper modules locally for use in other projects, run
./gradlew publishMavenPublicationToMavenLocal -PVERSION=x.y.z
You should comment out the signAllPublications() line in MavenCentralPublish.kt if you do not wish to sign the modules.
| Module | Docs |
|---|---|
| roktux | Testing |
For detailed documentation, check the Android integration guide.