When to use it
Use for one essential wrist action. Keep haptics, health or safety policy, synchronization, and command handling in the application.
Present one at-a-glance, round primary action on watchOS or Wear OS.
Apple availability
Import LumenUI in the target that uses this component. iPad support follows the iOS package baseline and uses native iPad layout behavior.
Native example
Use for one essential wrist action. Keep haptics, health or safety policy, synchronization, and command handling in the application.
LumenWatchActionButton("Start contraction", action: startContraction) {
TimerLabel()
}Reference
The primary shared and platform-specific options exposed by LumenWatchActionButton.
| API | Values or type | Default | Description |
|---|---|---|---|
| accessibilityLabel | Native localized text | Required | Names the essential action. |
| action | () -> Unit | Required | Runs application-owned behavior. |
| tone | brand · accent · success · warning · danger · neutral | brand | Applies semantic intent. |
| dimension | Native display units | 120 | Clamps the round target to wearable-safe bounds. |
| enabled | Boolean | true | Controls action and disabled presentation. |
Native behavior
Use for one essential wrist action. Keep haptics, health or safety policy, synchronization, and command handling in the application.
Requires one concise action label, preserves native button semantics, and exposes disabled state without duplicating visible content.
Shared component