---
title: "Preview(_:as:widget:timeline:)"
framework: widgetkit
role: symbol
role_heading: Macro
path: "widgetkit/preview(_:as:widget:timeline:)"
---

# Preview(_:as:widget:timeline:)

Preview a timeline-style widget.

## Declaration

```swift
@freestanding(declaration) macro Preview<Widget>(_ name: String? = nil, as family: WidgetFamily, widget: @escaping () -> Widget, @PreviewTimelineBuilder timeline: @escaping @MainActor () async -> [any TimelineEntry]) where Widget : Widget
```

## Parameters

- `name`: An optional display name for the preview that appears in the Xcode preview canvas.
- `family`: The widget family to display.
- `widget`: A closure producing the widget to be previewed.
- `timeline`: A closure building the timeline of entries to be previewed.

## Mentioned in

Previewing widgets and Live Activities in Xcode

## Overview

Overview Provide the preview with sample data and use it to step through the timeline while ignoring the dates of the entries, and test out the transitions between them. note: The timeline entries must be of the type that the widget expects.

## See Also

### Generating a widget preview

- [Preview(_:as:widget:timelineProvider:)](widgetkit/preview(_:as:widget:timelineprovider:).md)
- [Preview(_:as:using:widget:timelineProvider:)](widgetkit/preview(_:as:using:widget:timelineprovider:)-4ljg1.md)
- [Preview(_:as:using:widget:timelineProvider:)](widgetkit/preview(_:as:using:widget:timelineprovider:)-3df1l.md)
- [Preview(_:widget:relevanceEntries:)](widgetkit/preview(_:widget:relevanceentries:).md)
- [Preview(_:widget:relevanceProvider:)](widgetkit/preview(_:widget:relevanceprovider:).md)
- [Preview(_:widget:relevanceProvider:relevance:)](widgetkit/preview(_:widget:relevanceprovider:relevance:).md)