<!--
{
  "availability" : [
    "iOS: 18.0.0 -",
    "iPadOS: 18.0.0 -",
    "macCatalyst: -",
    "macOS: 15.0.0 -",
    "visionOS: 26.0.0 -",
    "watchOS: 11.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "WidgetKit",
  "identifier" : "/documentation/WidgetKit/TimelineProvider/relevance()",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "WidgetKit"
    ],
    "preciseIdentifier" : "s:9WidgetKit16TimelineProviderP9relevanceAA0A9RelevanceVyytGyYaF"
  },
  "title" : "relevance()"
}
-->

# relevance()

Provides an object containing attributes that describe when a specific
widget is relevant.

```
func relevance() async -> WidgetRelevance<Void>
```

## Return Value

The object that contains attributes that describe when a specific
widget is relevant.

## Discussion

The system can use the relevance to show this widget in the Smart Stack
when the provided relevance matches a person’s context. For example,
if you indicate relevance at a specific location, the system could
show the widget when a person is at or close to the location.

By default, this method returns no relevances. Implement this
requirement to tell the system that your widget is relevant.

> Note: Smart Stacks are available in iOS, iPadOS, and watchOS.
> However, functionality provided by RelevanceKit API is only available
> in watchOS. Calling its API on other platforms doesn’t have any effect.
> For more information, refer to <doc://com.apple.WidgetKit/documentation/WidgetKit/Widget-Suggestions-In-Smart-Stacks>.

---

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)