WidgetKitApple

Widget badge

Present a compact rendering-mode-aware WidgetKit status badge.

Public APILumenWidgetBadgeApple / SwiftUISwift product: LumenWidgetUI

Apple availability

Supported native targets

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

iPhone · iOS 16+iPad · iPadOS 16+Mac · macOS 13+Apple Watch · watchOS 9+

Native example

Use for short WidgetKit status. Keep actions as native Button or App Intent interactions outside the badge.

Focused package reference

This API ships in LumenWidgetUI. No application-playground capture is published for this extension-only product yet.

LumenWidgetBadge(
    .verbatim("Ready"),
    iconSystemName: "checkmark.circle.fill",
    tone: .success
)

Reference

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

API	Values or type	Default	Description
label	`LumenWidgetTextContent`	`Required`	Provides the compact status text.
iconSystemName	`String?`	`nil`	Adds a decorative SF Symbol.
tone	`LumenWidgetTone`	`accent`	Selects the semantic status treatment.

Native behavior

Use for short WidgetKit status. Keep actions as native Button or App Intent interactions outside the badge.

Icon and text combine into one concise status, while increased contrast strengthens the visible outline.