pullrefresh

Standalone pull to refresh library for Jetpack Compose multiplatform without the reliance on Material.

Use

Add to project

Gradle (Kotlin):

implementation("dev.materii.pullrefresh:pullrefresh:$pullRefreshVersion")

Gradle (Groovy):

implementation 'dev.materii.pullrefresh:pullrefresh:$pullRefreshVersion'

Gradle (Version Catalog):

materii-pullrefresh = { group = "dev.materii.pullrefresh", name = "pullrefresh", version.ref = "pullrefresh" }

Basic setup

Pull to refresh

See the sample.

| Default | Flipped | | ------- | ------- | | <img src="/.github/images/pullrefresh.gif" alt="Pull refresh demo" width="200px"> | <img src="/.github/images/pullrefresh-flipped.gif" alt="Flipped pull refresh demo" width="200px"> |

@Composable
fun Test() {
    var isRefreshing by remember {
        mutableStateOf(false)
    }
    var pullRefreshState = rememberPullRefreshState(refreshing = isRefreshing, onRefresh = { /* Refresh some data here */ })

    PullRefreshLayout(
        modifier = modifier,
        state = pullRefreshState
    ) {
        Text("Some content")
    }
}

Drag to refresh

See the sample.

| Default | Flipped | | ------- | ------- | | <img src="/.github/images/dragrefresh.gif" alt="Drag refresh demo" width="200px"> | <img src="/.github/images/dragrefresh-flipped.gif" alt="Flipped drag refresh demo" width="200px"> |

@Composable
fun Test() {
    var isRefreshing by remember {
       mutableStateOf(false)
    }
    var pullRefreshState = rememberPullRefreshState(refreshing = isRefreshing, onRefresh = { /* Refresh some data here */ })

    DragRefreshLayout(
        modifier = modifier,
        state = pullRefreshState
    ) {
        Text("Some content")
    }
}

Notice

All of the included components come directly from the official Jetpack Compose Material library, with only the bare minimum required.

Copyright 2022 The Android Open Source Project

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.