Compatibility

• Programming languages: The Android SDK supports and tracks content on any screen developed in Java or Kotlin.
• Android version: we support Android SDK API Level 21 (Android 5.0 - Lollipop) and later
• Android SDK version: The library is built and compiled against Android SDK version 34 (compileSdk = 34).

This version has been compiled on Java 17 (Bytecode version 61).

Contentsquare Android SDK is compiled with Kotlin version 1.8.22.

If you don’t use the 1.8.22 Kotlin version and you have conflict issues; you must exclude the Kotlin stdlib from our SDK.

implementation("com.contentsquare.android:library:4.31.0") {
  exclude group: "org.jetbrains.kotlin", module: "kotlin-stdlib-jdk8"
}

Contentsquare Compose SDK com.contentsquare.android:compose:4.31.0 is compiled using Jetpack Compose version 1.5.4 (bom 2023.10.01).

If you want to force the Compose version to match the one in your project, you have to use strictly ↗ Gradle mechanism for the 2 Compose dependencies we use in the CS Compose library: androidx.compose.ui:ui and androidx.compose.runtime:runtime.

Example of forcing Compose 1.5.0:

implementation 'com.contentsquare.android:library:4.31.0'
implementation 'com.contentsquare.android:compose:4.31.0'

implementation platform('androidx.compose:compose-bom:2023.08.00')
implementation('androidx.compose.ui:ui') {
  version {
      strictly "1.5.0"
  }
}
implementation('androidx.compose.runtime:runtime') {
  version {
      strictly "1.5.0"
  }
}

implementation("com.contentsquare.android:library:4.31.0")
implementation("com.contentsquare.android:compose:4.31.0")

implementation(platform('androidx.compose:compose-bom:2023.08.00'))
implementation("androidx.compose.ui:ui") {
  version {
      strictly("1.5.0")
  }
}
implementation("androidx.compose.runtime:runtime") {
  version {
      strictly("1.5.0")
  }
}

The Contentsquare SDK has a few dependencies. We try to be up-to-date as much as possible to avoid conflict issue.

We may sometimes have conflicts between your app dependencies VS SDK dependencies. In this case, you can exclude from our SDK any dependency we pull and use your version instead.

If you have a version of the recyclerview in your app which is older than the one we use, you can use the following to exclude it in your Gradle file.

implementation("com.contentsquare.android:library:4.31.0") {
  exclude group: "androidx.recyclerview", module: "recyclerview"
  exclude group: "androidx.swiperefreshlayout", module: "swiperefreshlayout"
}

By doing this, you skip the recyclerview and swiperefreshlayout dependencies provided by our SDK.

The list of dependencies for each artifact is searchable on mvnrepository.com:

• com.contentsquare.android:library:4.31.0 ↗
• com.contentsquare.android:compose:4.31.0 ↗

Symptom:

1. You capture snapshots but main elements of the screen are not appearing.
2. SDK does not log any gesture events when interacting with some native UI elements.

Explanation: Native UI Elements such as Bottom Sheets, Dialogs, Menus are currently not supported by the SDK.

Symptom: In some cases, we found that gestures tracked by the SDK are not attached to the right UI element of the screen. These gestures will be attached to an invisible view.

Explanation: The reason to this is that when the SDK attaches the gesture to a UI element, it generates a path regarding the visibility of the view when traversing the view hierarchy. If a view is visible and it matches the coordinates on where the gesture was performed it will be taken into account. Most of the time, the issue is that a layout is still present in the screen even if there is no content.

Best Practice: When designing your application UI, do not let any layout stray along if is not used. If a layout that contains widgets like progress bar, remember to set its visibility to GONE or INVISIBLE after its purpose is served.

Symptom: A tap is not assigned to the tapped view, but to a view higher in the view hierarchy.

Explanation: When a tap is captured, the view hierarchy is traversed to find all views that match the tap coordinates. The tap is assigned to the first clickable view, starting at the tail of the view list, meaning the search starts at the lowest hierarchy level. If no clickable view is found, then the tap is assigned to the view at the tail of the list.

Jetpack Compose example:

Button(
    onClick = { ... }
) {
    Text(text = "Simple Button")
}

A tap on the Text will be assigned to the Button, because the Button is clickable.

Best practice: If the described behavior does not fit your needs, you may add click listeners to the corresponding views. In the example above, you may add an identical click listener to the Text.