Skip to content

ROKT/rokt-ux-helper-android

Repository files navigation

Rokt UX Helper Andriod

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.

Resident Experts

Environment Build
main Build status

Requirements

  • 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

Installation

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")
}

Jetpack Compose Compatibility

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.

Development and useful commands

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 may be conducted using Buildkite which runs on all pull requests and are required to pass before the changes are merged. You can find the details of the full pipeline here.

FAQ

Documentation

For detailed documentation, check the Android integration guide.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages