terrakok/PullToRefresh

PullToRefresh Composable

This repository contains Jetpack Compose implementation of pull to refresh layout.

Here's what its basic usage looks like:

@Composable
fun composableFun() {
    var isRefreshing: Boolean by remember { mutableStateOf(false) }
    var items by remember { mutableStateOf( /** items **/ ) }

    PullToRefresh(
        isRefreshing = isRefreshing,
        onRefresh = {
            isRefreshing = true
            // update items and set isRefreshing = false
        }
    ) {
        // Any scrollable composable content can go here
        LazyColumn {
            items.map { Text("I'm $it") }
        }
    }
}

You can put any composable in closure as long, as it is scrollable. If you are using LazyColumn, it is scrollable by default. With Column or Box use Modifier.verticalScroll(rememberScrollState()) modifier.

You can find more in sample

Dependency

You can include PullToRefresh in your project from mavenCentral():

    implementation 'com.puculek.pulltorefresh:pull-to-refresh-compose:1.0.5'

Showcase

Have fun!