Skip to content

A Jetpack compose modifier to add progress over your Composables

License

Notifications You must be signed in to change notification settings

nasrabadiAM/progress-modifier

Repository files navigation

Progress Modifier for jetpack compose

This is a modifier for drawing a progress over your Composable views.

To use this progress modifier on your views you can do it this way:

    Box(
        Modifier
            //..... other modifiers 
            .progressAnimation(durationMillis = 10_000)
    )

you should pass a duration which is a the duration for your progress. then it shows a progress animation on your view till it finished.

If you want to be notified when animation finished, you can add callback to it.

    Box(
        Modifier
            //..... other modifiers 
            .progressAnimation(durationMillis = 10_000, finishedListener = {
                Log.d("ProgressModifer", "animation finished!")
            })
    )

As the order of modifiers matters, you should add it after your bakground and clip modifier.