<!--
{
  "availability" : [
    "watchOS: 26.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "WidgetKit",
  "identifier" : "/documentation/WidgetKit/Preview(_:widget:relevanceProvider:)",
  "metadataVersion" : "0.1.0",
  "role" : "Macro",
  "symbol" : {
    "kind" : "Macro",
    "modules" : [
      "WidgetKit"
    ],
    "preciseIdentifier" : "s:9WidgetKit7Preview_6widget17relevanceProviderySSSg_xyScMYccq_yScMYcctc7SwiftUI0A0RzAA016RelevanceEntriesF0R_r0_lufm"
  },
  "title" : "Preview(_:widget:relevanceProvider:)"
}
-->

# Preview(_:widget:relevanceProvider:)

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

```
@freestanding(declaration) macro Preview<Widget, Provider>(_ name: String? = nil, widget: @escaping @MainActor () -> Widget, relevanceProvider: @escaping @MainActor () -> Provider) where Widget : Widget, Provider : RelevanceEntriesProvider
```

## Parameters

`name`

An optional display name for the preview that appears in the Xcode preview canvas.

`widget`

A closure producing the widget to be previewed.

`relevanceProvider`

A closure producing the relevance provider that generates the preview’s relevances and entries.

## Overview

Use sample data for your relevance provider and use it to step through the entries in the Xcode proview canvas.

> Note: The relevance provider must be of the type that the widget expects.

---

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)