https://github.com/swiftui-plus/refreshable

A backport of the new `refreshable` modifier with support for all SwiftUI versions. (iOS, tvOS, watchOS, macOS)
https://github.com/swiftui-plus/refreshable

ios macos refresh refreshable swift swiftui tvos watchos

Last synced: about 1 month ago
JSON representation

A backport of the new `refreshable` modifier with support for all SwiftUI versions. (iOS, tvOS, watchOS, macOS)

• Host: GitHub
• URL: https://github.com/swiftui-plus/refreshable
• Owner: SwiftUI-Plus
• License: mit
• Created: 2021-08-28T19:49:24.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-07-06T21:54:53.000Z (over 2 years ago)
• Last Synced: 2023-03-06T06:37:05.011Z (almost 2 years ago)
• Topics: ios, macos, refresh, refreshable, swift, swiftui, tvos, watchos
• Language: Swift
• Homepage: https://benkau.com/packages.json
• Size: 6.84 KB
• Stars: 14
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
![ios](https://img.shields.io/badge/iOS-13-green)

![tv](https://img.shields.io/badge/tvOS-13-green)

![watch](https://img.shields.io/badge/watchOS-6-green)

![mac](https://img.shields.io/badge/macOS-10.15-green)

----

> This backport is now available as `Backport.Refreshable`, in a single Backports library, with a LOT more additions. This should simply my efforts and allow me and others to contribute more backports in the near future.

> [SwiftUI Backports](https://github.com/shaps80/SwiftUIBackports)

----

# Refreshable

> Also available as a part of my [SwiftUI+ Collection](https://benkau.com/packages.json) – just add it to Xcode 13+

A backport of the new `refreshable` modifier with support for all SwiftUI versions.

This includes support for a `refreshAction` in the `Environment` as well as a convenient `RefreshableView` that makes it easy to build your own trigger's for _any_ refresh action.

> Note: This package does not (_yet_) include a pull-to-refresh like component.

## Example

To avoid naming issues, the modifier is called `onRefresh` and to provide a familiar API for ending the refresh, the closure returns a `Refresh` instance that can be used (similary to `presentationMode`), to notify the UI that it should stop refreshing.

```swift

ScrollView {

    // content

}

.onRefresh { refresh in

    URLSession.shared.dataTask(with: url) { _, _, _ in

        refresh.wrappedValue.end()

    }

}

```

Then, to provide some UI that triggers the refresh:

```swift

RefreshableView { phase in

    switch phase {

    case let .idle(refresher, action):

        Button {

            refresher.perform(action)

        } label: {

            Text(title)

        }

    case .refreshing:

        ProgressView()

    case .notSupported:

        // `onRefresh` modifier has not been added

        Text("Not refreshable")

    }

}

```

## Installation

The code is packaged as a framework. You can install manually (by copying the files in the `Sources` directory) or using Swift Package Manager (**preferred**)

To install using Swift Package Manager, add this to the `dependencies` section of your `Package.swift` file:

`.package(url: "https://github.com/SwiftUI-Plus/Refreshable.git", .upToNextMinor(from: "1.0.0"))`

## Other Packages

If you want easy access to this and more packages, add the following collection to your Xcode 13+ configuration:

`https://benkau.com/packages.json`