ButtonKit provide two SwiftUI buttons to deal with throwable and asynchronous actions. By default, SwiftUI button only accept a closure.
With ButtonKit, you'll have access to:
ThrowableButton
, accepting a() throws -> Void
closureAsyncButton
, accepting a() async throws -> Void
closure
- Swift 5.7+ (Xcode 14+)
- iOS 15+, iPadOS 15+, tvOS 15+, watchOS 8+, macOS 12+, visionOS 1+
Install using Swift Package Manager
dependencies: [
.package(url: "https://github.com/Dean151/ButtonKit.git", from: "0.1.0"),
],
targets: [
.target(name: "MyTarget", dependencies: [
.product(name: "ButtonKit", package: "ButtonKit"),
]),
]
And import it:
import SwiftUI
import ButtonKit
Use it as any SwiftUI button, but throw if you want in the closure:
ThrowableButton {
try doSomethingThatCanFail()
} label {
Text("Do something")
}
When the button closure throws, the button will shake by default
For now, only this shake behavior is built-in:
.throwableButtonStyle(.shake) |
You can disable still it by passing .none
to throwableButtonStyle:
ThrowableButton {
try doSomethingThatCanFail()
} label {
Text("Do something")
}
.throwableButtonStyle(.none)
You can also bring your own behavior using the ThrowableButtonStyle
protocol.
In ThrowableButtonStyle, you can implement makeLabel
, makeButton
or both to alterate the button look and behavior.
public struct TryAgainThrowableButtonStyle: ThrowableButtonStyle {
public init() {}
public func makeLabel(configuration: LabelConfiguration) -> some View {
if configuration.errorCount > 0 {
Text("Try again!")
} else {
configuration.label
}
}
}
extension ThrowableButtonStyle where Self == TryAgainThrowableButtonStyle {
public static var tryAgain: some ThrowableButtonStyle {
TryAgainThrowableButtonStyle()
}
}
Then, use it:
ThrowableButton {
try doSomethingThatCanFail()
} label {
Text("Do something")
}
.throwableButtonStyle(.tryAgain)
Use it as any SwiftUI button, but the closure will support both try and await.
AsyncButton {
try await doSomethingThatTakeTime()
} label {
Text("Do something")
}
When the process is in progress, another button press will not result in a new Task being issued. But the button is still enabled and hittable.
You can disable the button on loading using disabledWhenLoading
modifier.
AsyncButton {
...
}
.disabledWhenLoading()
You can also disable hitTesting when loading with allowsHitTestingWhenLoading
modifier.
AsyncButton {
...
}
.allowsHitTestingWhenLoading(false)
Access and react to the underlying task using asyncButtonTaskStarted
or asyncButtonTaskEnded
modifier.
AsyncButton {
...
}
.asyncButtonTaskStarted { task in
// Task started
}
.asyncButtonTaskEnded {
// Task ended or was cancelled
}
You can summarize both using asyncButtonTaskChanged
modifier.
AsyncButton {
...
}
.asyncButtonTaskChanged { task in
if let task {
// Task started
} else {
// Task ended or was cancelled
}
}
While the progress is loading, the button will animate, defaulting by replacing the label of the button with a ProgressIndicator
.
All sort of styles are built-in:
.asyncButtonStyle(.overlay) | .asyncButtonStyle(.pulse) |
.asyncButtonStyle(.leading) | .asyncButtonStyle(.trailing) |
You can disable this behavior by passing .none
to asyncButtonStyle
AsyncButton {
try await doSomethingThatTakeTime()
} label {
Text("Do something")
}
.asyncButtonStyle(.none)
AsyncButton
also support throwableButtonStyle modifier.
You can also build your own customization by implementing AsyncButtonStyle
protocol.
Just like ThrowableButtonStyle
, AsyncButtonStyle
allow you to implement either makeLabel
, makeButton
or both to alterate the button look and behavior while loading is in progress.
You are encouraged to contribute to this repository, by opening issues, or pull requests for bug fixes, improvement requests, or support. Suggestions for contributing:
- Improving documentation
- Adding some automated tests 😜
- Helping me out to remove/improve all the type erasure stuff if possible?
- Adding some new built-in styles, options or properties for more use cases