AgentSkillsCN

swiftui-async-button

在 SwiftUI 按钮操作中,使用 ButtonKit 的 AsyncButton 来执行 Task、调用 async/await、采用 do/catch 语法,或需要内置加载/进度/错误反馈时使用。适用于替换自定义 Button+Task 包装器时,或当按钮操作可能抛出异常、或本身为异步操作时触发。

SKILL.md
--- frontmatter
name: swiftui-async-button
description: Use ButtonKit's AsyncButton for SwiftUI button actions that start a Task, call async/await, use do/catch, or need built-in loading/progress/error feedback. Trigger when replacing custom Button+Task wrappers or when a button action can throw or is async.

SwiftUI Async Button

Overview

Prefer ButtonKit AsyncButton over custom Button { Task { ... } } or manual do/catch wrappers to get standardized loading, progress, and error feedback for async or throwing actions.

Core workflow

  1. Ensure ButtonKit is imported with import ButtonKit ; and that the dependency to ButtonKit is added to Swift Package Manager dependencies
  2. Replace any Button action that spawns Task { ... } or uses do { try await ... } catch { ... } with AsyncButton { try await ... }.
  3. Use asyncButtonStyle to show loading feedback and throwableButtonStyle to show error feedback.
  4. Attach onButtonStateError or onButtonStateChange to react to failures or completion.
  5. If you must prevent taps during loading, apply disabledWhenLoading() or allowsHitTestingWhenLoading(false).
  6. Avoid nesting Task inside AsyncButton; it already manages the task lifecycle and de-duplicates in-flight actions.

External triggers

When another UI event should trigger the same action (e.g., keyboard submit), assign an id to AsyncButton and use @Environment(\.triggerButton) to trigger it.

Progress

If the action can report progress, use AsyncButton(progress: ...) and update the provided progress object. For supported progress types, styles, and demo patterns, read skills/swiftui-async-button/references/asyncbutton.md.

References

  • skills/swiftui-async-button/references/asyncbutton.md