rlziii/swiftui-async-button

SwiftUI Button Async Initializers

swiftui-async-button

Wrapper initializers for SwiftUI Button that allow async action arguments (i.e. asyncAction) instead of the built-in synchronous actions.

Usage

Add the following as a package in your Package.swift file or Xcode project:

[email protected]:rlziii/swiftui-async-button.git

Then simply import SwiftUIAsyncButton in a file that needs to use one of the new Button initializers (see below).

Initializers

All native SwiftUI Button initializers have asyncAction equivalents via this package. As in: any initializer that has an action-named parameter has an asyncAction-named parameter now as well. Therefore a Button can be used in this kind of way (or using a similar initializer):

Button("Some Title", asyncAction: someAsyncFunction)

Or using trailing-closure syntax:

Button("Some Title") {
  await someAsyncFunction()
}

Minimum Deployment Targets

macOS: 10.15
iOS/iPadOS: 13.0
tvOS: 13.0
watchOS: 6.0

However, some initializers (i.e. those with support for ButtonRole) require:

macOS: 12.0
iOS/iPadOS: 15.0
tvOS: 15.0
watchOS: 8.0

License

MIT License. See LICENSE file for more details.

swiftui-async-button's Issues

Create Restartable Tasks

Currently if a Button is tapped multiple times with a previous Task still in flight, news Tasks are just created. However this is perhaps unexpected. Instead, the option of have any previous in-flight Tasks "replaced"/"restarted" should instead be an option (the default?) should be constructed.

Create More Strict Task Lifetime

Button's Task lifetime right now is non-strict, meaning that long-running tasks may exceed the lifetime of the Button itself. This may be unexpected. Therefore a mechanism should be created to fix this problem.

Note: it might be necessary to make this opt-in so that some tasks always run to completion without being cancelled prematurely.

Expose `TaskPriority` for Button Async Initializers

Currently all Button async initializers spawn a new Task with a nil priority (i.e. therefore inheriting their outer context priority). This should instead be an option to pass into the Button's created Task.