https://github.com/materiiapps/pullrefresh

Standalone pull to refresh library for Jetpack Compose multiplatform.
https://github.com/materiiapps/pullrefresh

Last synced: 3 months ago
JSON representation

Standalone pull to refresh library for Jetpack Compose multiplatform.

• Host: GitHub
• URL: https://github.com/materiiapps/pullrefresh
• Owner: MateriiApps
• License: mit
• Created: 2023-08-15T22:08:01.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-27T18:29:20.000Z (10 months ago)
• Last Synced: 2025-05-19T22:09:00.593Z (5 months ago)
• Language: Kotlin
• Size: 2.86 MB
• Stars: 84
• Watchers: 1
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# pullrefresh

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

[![Maven Central](https://img.shields.io/maven-central/v/dev.materii.pullrefresh/pullrefresh?style=for-the-badge&label=Maven%20Central)](https://central.sonatype.com/artifact/dev.materii.pullrefresh/pullrefresh/)

[![Repo stars](https://img.shields.io/github/stars/MateriiApps/pullrefresh?style=for-the-badge&logo=github)](https://github.com/MateriiApps/pullrefresh/stargazers)

![Build status](https://img.shields.io/github/actions/workflow/status/MateriiApps/pullrefresh/build.yml?style=for-the-badge&logo=github)

## Use

### Add to project

Gradle (Kotlin): 

```kts

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

```

Gradle (Groovy):

```groovy

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

```

Gradle (Version Catalog): 

```toml

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

```

### Basic setup

#### Pull to refresh

> See the [sample](https://github.com/MateriiApps/pullrefresh/blob/main/demo/src/main/java/dev/materii/pullrefresh/demo/sample/PullRefreshSample.kt).

| Default | Flipped |

| ------- | ------- |

|  |  |

```kt

@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](https://github.com/MateriiApps/pullrefresh/blob/main/demo/src/main/java/dev/materii/pullrefresh/demo/sample/DragRefreshSample.kt).

| Default | Flipped |

| ------- | ------- |

|  |  |

```kt

@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.

```