<!--
{
  "documentType" : "article",
  "framework" : "WidgetKit",
  "identifier" : "/documentation/WidgetKit/Preview-macros",
  "metadataVersion" : "0.1.0",
  "role" : "collectionGroup",
  "title" : "Preview macros"
}
-->

# Preview macros

Use Swift macros to create widget previews in Xcode.

## Topics

### Generating a widget preview

[`Preview(_:as:widget:timelineProvider:)`](/documentation/WidgetKit/Preview(_:as:widget:timelineProvider:))

Preview a widget with a static configuration, using the specified timeline provider.

[`Preview(_:as:using:widget:timelineProvider:)`](/documentation/WidgetKit/Preview(_:as:using:widget:timelineProvider:)-4ljg1)

Preview a widget with an app intent configuration, using the specified timeline provider.

[`Preview(_:as:using:widget:timelineProvider:)`](/documentation/WidgetKit/Preview(_:as:using:widget:timelineProvider:)-3df1l)

Preview a widget with an intent configuration, using the specified timeline provider.

[`Preview(_:as:widget:timeline:)`](/documentation/WidgetKit/Preview(_:as:widget:timeline:))

Preview a timeline-style widget.

[`Preview(_:widget:relevanceEntries:)`](/documentation/WidgetKit/Preview(_:widget:relevanceEntries:))

Preview a relevance configuration widget.

[`Preview(_:widget:relevanceProvider:)`](/documentation/WidgetKit/Preview(_:widget:relevanceProvider:))

Preview a widget with a relevance configuration, using the specified relevance provider.

[`Preview(_:widget:relevanceProvider:relevance:)`](/documentation/WidgetKit/Preview(_:widget:relevanceProvider:relevance:))

Preview a widget with a relevance configuration, using the specified relevances.

### Generating a Live Activity preview

[`Preview(_:as:using:widget:contentStates:)`](/documentation/WidgetKit/Preview(_:as:using:widget:contentStates:))

Preview a widget with an activity configuration, using the specified attributes and content states.

### Generated structures

[`PreviewActivityBuilder`](/documentation/WidgetKit/PreviewActivityBuilder)

[`PreviewRelevanceEntryBuilder`](/documentation/WidgetKit/PreviewRelevanceEntryBuilder)

A builder that allows you to construct a list of relevance entries to preview your widget.

[`PreviewTimelineBuilder`](/documentation/WidgetKit/PreviewTimelineBuilder)


---

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)