<!--
{
  "availability" : [
    "iOS: 16.0.0 -",
    "iPadOS: 16.0.0 -",
    "macCatalyst: 16.0.0 -",
    "visionOS: 26.0.0 -",
    "watchOS: 9.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "SwiftUI",
  "identifier" : "/documentation/SwiftUI/View/widgetLabel(label:)",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "SwiftUI"
    ],
    "preciseIdentifier" : "s:7SwiftUI4ViewP9WidgetKitE11widgetLabel5labelQrqd__yXE_tAaBRd__lF"
  },
  "title" : "widgetLabel(label:)"
}
-->

# widgetLabel(label:)

Creates a label for displaying additional content outside an accessory
family widget’s main SwiftUI view.

```
@MainActor @preconcurrency func widgetLabel<Label>(@ViewBuilder label: () -> Label) -> some View where Label : View
```

## Parameters

`label`

A view that WidgetKit can display alongside the
accessory family widget’s main SwiftUI view. You can use a
<doc://com.apple.documentation/documentation/SwiftUI/Image>,
<doc://com.apple.documentation/documentation/SwiftUI/Text>,
<doc://com.apple.documentation/documentation/SwiftUI/Gauge>,
<doc://com.apple.documentation/documentation/SwiftUI/ProgressView>, or
a container with multiple subviews.

## Discussion

The system only displays labels on widget-based complications in
watchOS. The system ignores any labels attached to widgets on the Lock
Screen on iPhone. Therefore, you can use the same code to display an
accessory family widget on both iPhone and Apple Watch.

To create the widget label, call `widgetLabel(label:)`on
a complication’s main SwiftUI view. Pass the desired content as the
`label` parameter. The label can be
a <doc://com.apple.documentation/documentation/SwiftUI/Gauge>,
<doc://com.apple.documentation/documentation/SwiftUI/ProgressView>,
<doc://com.apple.documentation/documentation/SwiftUI/Text>, or
<doc://com.apple.documentation/documentation/SwiftUI/Image>. To provide
multiple views, wrap your views in a container, such as
a <doc://com.apple.documentation/documentation/SwiftUI/VStack>.
WidgetKit determines whether it can use any of the label’s content. If
it can’t, it ignores the label.

```swift
  struct Complication: View {
      @Environment(\.widgetFamily) var widgetFamily

      var body: some View {
          switch widgetFamily {
          case .accessoryCorner:
              Text("Hi")
                  .widgetLabel {
                      Gauge(value: 0.8)
                  }
          case .accessoryCircular:
              VStack {
                  Image(systemName: "emoji.globe")
                  Text("Hi")
              }
              .widgetLabel("World!")
          case .accessoryInline:
              Text("\(Image(systemName: "emoji.globe.face")) World!")
      }
  }
```

WidgetKit configures the label so that the watch face
presents a unified look. For example, it sets the size for an image, the
font for text, and can even render text and gauges along a curve.

The following widget families support widget labels:

- <doc://com.apple.documentation/documentation/WidgetKit/WidgetFamily/accessoryCorner>: In watchOS, this
  widget-based complication can display
  a <doc://com.apple.documentation/documentation/SwiftUI/Gauge>,
  a <doc://com.apple.documentation/documentation/SwiftUI/ProgressView>, or
  a <doc://com.apple.documentation/documentation/SwiftUI/Text>. Adding
  a label to an accessory corner causes the main SwiftUI view to shrink to
  make space for the label. If you pass a view containing multiple, valid
  subviews, the system picks which view to display as the
  widget label.
- <doc://com.apple.documentation/documentation/WidgetKit/WidgetFamily/accessoryCircular>: In watchOS, the
  widget-based complication can display either an
  <doc://com.apple.documentation/documentation/SwiftUI/Image> or
  a <doc://com.apple.documentation/documentation/SwiftUI/Text>. To pass
  both an image and text, wrap those views in a container.

However, WidgetKit only renders the label along the bezel on the
Infograph watch face (the top circular complication). On all other
circular complications — including widgets on all other platforms
— WidgetKit ignores the label.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)