One Logo Pool Ball
WidgetKit · IOS API REFERENCE

WidgetLocation

struct · iOS 17.0+ · SDK 27.1

struct WidgetLocation

Values that indicate different widget locations.

Members (5)

get · iOS 17.0+

homeScreen

TypeScript
static get homeScreen(): WidgetLocation
Swift declaration
static let homeScreen: WidgetLocation

The widget appears on the Home Screen or in Today View.

get · iOS 17.0+

lockScreen

TypeScript
static get lockScreen(): WidgetLocation
Swift declaration
static let lockScreen: WidgetLocation

The widget appears on the Lock Screen.

get · iOS 17.0+

iPhoneWidgetsOnMac

TypeScript
static get iPhoneWidgetsOnMac(): WidgetLocation
Swift declaration
static let iPhoneWidgetsOnMac: WidgetLocation

The widget originates from another device and appears on the Mac.

get · iOS 26.0+

carPlay

TypeScript
static get carPlay(): WidgetLocation
Swift declaration
static let carPlay: WidgetLocation

The CarPlay location for a widget.

get · iOS 17.0+

standBy

TypeScript
static get standBy(): WidgetLocation
Swift declaration
static let standBy: WidgetLocation

The widget appears in StandBy.

Skipped declarations

No declarations were skipped in this snapshot.

All WidgetKit types →