Skip to main content
161

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Apple docs
WidgetKitApple

Widget icon

Render a labeled or decorative WidgetKit SF Symbol with semantic tone.

Public APILumenWidgetIconApple / 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 Widget icon

Use for compact WidgetKit SF Symbols. Keep product artwork and asset catalogs in the application.

Focused package reference

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

swift
LumenWidgetIcon(
    systemName: "timer",
    label: .verbatim("Active timer"),
    tone: .accent
)

Reference

Public API

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

APIValues or typeDefaultDescription
systemNameStringRequiredSelects an application-approved SF Symbol.
labelLumenWidgetTextContent?nilNames a meaningful icon.
toneLumenWidgetToneaccentAdapts the symbol across rendering modes.
sizeCGFloat18Sets the compact symbol dimension.

Native behavior

Design and accessibility

When to use it

Use for compact WidgetKit SF Symbols. Keep product artwork and asset catalogs in the application.

Accessibility

The SF Symbol is decorative without a label and exposes the supplied accessible name when it conveys meaning.

Apple docsSwiftUI package