Skip to main content
161

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Apple docs
ActionsApple

Wearable action

Present one at-a-glance, round primary action on watchOS or Wear OS.

Public APILumenWatchActionButtonApple / SwiftUISwift product: LumenUI

Apple availability

Supported native targets

Import LumenUI in the target that uses this component. iPad support follows the iOS package baseline and uses native iPad layout behavior.

Apple Watch · watchOS 9+

Native example

Use Wearable action

Use for one essential wrist action. Keep haptics, health or safety policy, synchronization, and command handling in the application.

Wearable action rendered in the watchOS simulator Lumen playground
Verified runtime capturewatchOS simulator
swift
LumenWatchActionButton("Start contraction", action: startContraction) {
    TimerLabel()
}

Reference

Public API

The primary shared and platform-specific options exposed by LumenWatchActionButton.

APIValues or typeDefaultDescription
accessibilityLabelNative localized textRequiredNames the essential action.
action() -> UnitRequiredRuns application-owned behavior.
tonebrand · accent · success · warning · danger · neutralbrandApplies semantic intent.
dimensionNative display units120Clamps the round target to wearable-safe bounds.
enabledBooleantrueControls action and disabled presentation.

Native behavior

Design and accessibility

When to use it

Use for one essential wrist action. Keep haptics, health or safety policy, synchronization, and command handling in the application.

Accessibility

Requires one concise action label, preserves native button semantics, and exposes disabled state without duplicating visible content.

Shared component

Available on other platforms

Android / Compose
Apple docsSwiftUI package