Skills cover SDK integration, building flows and paywalls, pre-publish audits, placement migration, and more. Describe the task in plain language and your agent picks the skill.
Follow this recipe to display the user’s progress as a Lottie animation — for example, a ring that fills up to indicate their daily streak. Your app renders the animation as a native Lottie view in a custom element.
Before you start
Update your app to Adapty Android SDK 4.4 or later. Earlier SDK versions show the fallback content for every custom element.
Add Lottie to your app with Gradle, from com.airbnb.android:lottie.
Prepare a Lottie animation in .json format, or download the sample streak_ring.json. The app plays the animation from the start and stops it in proportion to the progress, such as halfway through for 50%. To show the exact progress, the animation needs:
No progress on its first frame, and full progress on its last frame.
A steady speed, with no easing. If the animation starts slowly and then speeds up, it shows less than half of the progress halfway through.
1. Add the custom element to the screen
In the Flow & Paywall Builder, add a custom element to a flow screen, and set it up for the animation:
Type: lottie_animation.
ID: streak_ring. In this recipe, the ID is also the name of the animation file.
Height: Keep the default Fixed height. The animation scales to fit the custom element.
Inside the custom element, add an Image with a still picture of the ring. Users see it as the fallback when their version of your app doesn’t play the animation.
2. Add the animation file to your app
Put the animation file in src/main/assets, the assets folder of your app module. Keep it at the root of this folder, not in a subfolder.
The file name without .json must match the ID of the custom element, such as streak_ring.json for streak_ring.
3. Create the animation view
Create a model for the streak, and a view that plays the animation. Your app updates the model when the streak changes. The view reads the model, so the ring shows the current streak when the screen opens:
import androidx.compose.foundation.layout.fillMaxSizeimport androidx.compose.runtime.Composableimport androidx.compose.runtime.collectAsStateimport androidx.compose.runtime.getValueimport androidx.compose.ui.Modifierimport com.airbnb.lottie.compose.LottieAnimationimport com.airbnb.lottie.compose.LottieClipSpecimport com.airbnb.lottie.compose.LottieCompositionSpecimport com.airbnb.lottie.compose.rememberLottieCompositionimport kotlinx.coroutines.flow.MutableStateFlow// the streak that your app keeps up to dateclass StreakStore { val currentStreak = MutableStateFlow(0) // days in a row}@Composablefun StreakRing(animationFile: String, streakStore: StreakStore) { val composition by rememberLottieComposition(LottieCompositionSpec.Asset(animationFile)) val streak by streakStore.currentStreak.collectAsState() // 7 days fill the ring: from 0 for an empty ring to 1 for a full one val progress = minOf(streak / 7f, 1f) LottieAnimation( composition = composition, modifier = Modifier.fillMaxSize(), // scale the animation to fit the custom element clipSpec = LottieClipSpec.Progress(0f, progress), )}
clipSpec = LottieClipSpec.Progress(0f, progress) fills the ring once, from empty up to progress. If your app already keeps the streak in a StateFlow, use that StateFlow in place of StreakStore.
import android.content.Context;import androidx.lifecycle.MutableLiveData;import androidx.lifecycle.Observer;import com.airbnb.lottie.LottieAnimationView;// the streak that your app keeps up to datepublic class StreakStore { public final MutableLiveData<Integer> currentStreak = new MutableLiveData<>(0); // days in a row}public class StreakRingView extends LottieAnimationView { private final StreakStore streakStore; private final Observer<Integer> streakObserver = streak -> { // 7 days fill the ring: from 0 for an empty ring to 1 for a full one float progress = Math.min(streak / 7f, 1f); setMinAndMaxProgress(0f, progress); playAnimation(); }; public StreakRingView(Context context, String animationFile, StreakStore streakStore) { super(context); this.streakStore = streakStore; setAnimation(animationFile); } @Override protected void onAttachedToWindow() { super.onAttachedToWindow(); streakStore.currentStreak.observeForever(streakObserver); } @Override protected void onDetachedFromWindow() { streakStore.currentStreak.removeObserver(streakObserver); super.onDetachedFromWindow(); }}
setMinAndMaxProgress(0f, progress) and playAnimation() fill the ring once, from empty up to progress. If your app already keeps the streak in a LiveData, use that LiveData in place of StreakStore.
4. Match the animation to the custom element
In your app-wide resolver, add a property for the streak model. Then return the animation view for the lottie_animation Type and the streak_ring ID. The highlighted lines show what to add or change. If your app has no app-wide resolver yet, copy the whole code:
import android.content.Contextimport com.adapty.ui.AdaptyCustomElementContentimport com.adapty.ui.AdaptyCustomElementsResolverimport java.io.IOExceptionclass CustomElementsResolver( context: Context, private val streakStore: StreakStore,) : AdaptyCustomElementsResolver { // the animation files in the assets folder, listed once private val animationFiles: Set<String> = try { context.assets.list("").orEmpty().toSet() } catch (e: IOException) { emptySet() // no list of files: every Lottie element shows the fallback } override fun resolve(type: String, id: String): AdaptyCustomElementContent? = when (type) { "lottie_animation" -> { // the ID names the animation file, such as streak_ring.json val file = "$id.json" when { file !in animationFiles -> null // no file for this ID: show the fallback id == "streak_ring" -> AdaptyCustomElementContent.compose { StreakRing(file, streakStore) } // the other animations of your resolver else -> null } } // the other Types of your resolver else -> null }}
If the assets folder has no file for the ID, the resolver returns null, and users see the fallback. If your resolver already returns a view for every animation file, return that view instead of null when the ID isn’t streak_ring. This way, users still see the animations of your other lottie_animation custom elements.
import android.content.Context;import com.adapty.ui.AdaptyCustomElementContent;import com.adapty.ui.AdaptyCustomElementsResolver;import java.io.IOException;import java.util.Arrays;import java.util.HashSet;import java.util.Set;public class CustomElementsResolver implements AdaptyCustomElementsResolver { private final StreakStore streakStore; // the animation files in the assets folder, listed once private final Set<String> animationFiles = new HashSet<>(); public CustomElementsResolver(Context context, StreakStore streakStore) { this.streakStore = streakStore; try { String[] files = context.getAssets().list(""); if (files != null) { animationFiles.addAll(Arrays.asList(files)); } } catch (IOException e) { // no list of files: every Lottie element shows the fallback } } @Override public AdaptyCustomElementContent resolve(String type, String id) { if (type.equals("lottie_animation")) { // the ID names the animation file, such as streak_ring.json String file = id + ".json"; if (!animationFiles.contains(file)) { return null; // no file for this ID: show the fallback } if (id.equals("streak_ring")) { return AdaptyCustomElementContent.view( (context, elementContext) -> new StreakRingView(context, file, streakStore) ); } // the other animations of your resolver return null; } // the other Types of your resolver return null; }}
If the assets folder has no file for the ID, the resolver returns null, and users see the fallback. If your resolver already returns a view for every animation file, return that view instead of null when the ID isn’t streak_ring. This way, users still see the animations of your other lottie_animation custom elements.
Create the resolver with the streak model, and set it as the app-wide resolver. Call AdaptyUI.setCustomElementsResolver once, such as at app launch:
import android.app.Applicationimport com.adapty.ui.AdaptyUIclass App : Application() { // the streak model that your app updates val streakStore = StreakStore() // keep this instance: a resolver for one flow can reuse it // lazy: the context isn't attached yet while App is constructed val customElementsResolver by lazy { CustomElementsResolver(this, streakStore) } override fun onCreate() { super.onCreate() AdaptyUI.setCustomElementsResolver(customElementsResolver) }}
import android.app.Application;import com.adapty.ui.AdaptyUI;public class App extends Application { // the streak model that your app updates private final StreakStore streakStore = new StreakStore(); // keep this instance: a resolver for one flow can reuse it private CustomElementsResolver customElementsResolver; @Override public void onCreate() { super.onCreate(); customElementsResolver = new CustomElementsResolver(this, streakStore); AdaptyUI.setCustomElementsResolver(customElementsResolver); } public StreakStore getStreakStore() { return streakStore; } public CustomElementsResolver getCustomElementsResolver() { return customElementsResolver; }}
5. Test on a device
The Flow & Paywall Builder can’t run your app code, so its canvas only shows the fallback. To preview the animation:
Publish the flow. To see the latest published version instead of a cached one, register the device as a test device.
Run a build of your app that includes the resolver. Set the streak to 0 days, open the screen, and verify that the ring stays empty. Repeat with 4 and 7 days, and verify that the ring fills up to each value.
To test the fallback, remove the animation file from the build, and open the screen again.
To find out why the fallback appears instead of the animation, follow the instructions in the Test on a device section of the Android guide.