WidgetConfigurationプロトコルのメソッド

WidgetConfigurationプロトコルが持つメソッドについて

WidgetConfigurationとは

ウィジェットの設定を行うためのメソッドをまとめたプロトコル

コード

struct TestWidget: Widget {
    let kind: String = "PreNotToDoWidget"

    var body: some WidgetConfiguration {
        StaticConfiguration(kind: kind, provider: Provider()) { entry in
            ーーー 省略 ーーー
        }
        .configurationDisplayName("configurationDisplayName")
        .description("description")
        .supportedFamilies([.systemSmall, .systemMedium])
    }
}

configurationDisplayName

ユーザーがホーム画面からウィジェットを追加・編集するときに表示される名前

desciption

ユーザーがウィジェットを追加・編集するときに、ウィジェットに表示される説明

supportedFamilies

ウィジェットがサポートするサイズを設定する

disfavoredLocations

第一引数に指定した箇所での第二引数で指定した形式のウィジェットサイズを追加できなくする
以下の例では、ホーム画面での最小サイズのウィジェットの表示を禁止する。

.disfavoredLocations([.homeScreen], for: [.systemSmall])

第一引数は以下の４つの内から選択する。複数選択可。

• ロック画面
• ホーム画面
• スタンドバイ画面(iOS17からの新機能)
• Macに追加したiPhoneウィジェット

参考文献

https://developer.apple.com/documentation/swiftui/widgetconfiguration