IOS Widget(4-1):創建可配置小組件(靜態配置數據)

引言

  經過前面幾篇文章閱讀,已經掌握開發一款小組件的基本技能了,接下來開始掌握一些相對高級一點的技能。本文創建一個可配置小組件,通過修改時間類型,讓Text空間顯示不同格式的時間。

本文大綱

  • 添加動態配置 Custom Intent Definition
  • 可配置小組件框架代碼解析
  • 修改 .intentdefinition 文件實現修改時間類型
  • 代碼讀取配置信息,實現動態布局

添加動態配置

方式1:新建組件的時候勾選 「Include Configuration Intent」 複選框。

方式2:在您的Xcode項目中,選擇「File」>「New File」,然後選擇「SiriKit Intent Definition File」。單擊」Next「,並在出現提示時保存文件。Xcode在項目中會生成一個新的.intentdefinition 文件。

可配置小組件框架代碼解析

  如果默認用方式1 創建組件,代碼如下,如果通過方式2,請參考下面的代碼對應修改即可,注釋中已經標明與普通小組件代碼的不同點。

//
//  WidgetConfigIntent.swift
//  WidgetConfigIntent
//

import WidgetKit
import SwiftUI
import Intents

struct Provider: IntentTimelineProvider {
    func placeholder(in context: Context) -> SimpleEntry {
        // 不同點3:傳遞默認參數
        SimpleEntry(date: Date(), configuration: ConfigurationIntent())
    }

    // 不同點4:比使用StaticConfiguration時多了一個配置參數
    func getSnapshot(for configuration: ConfigurationIntent, in context: Context, completion: @escaping (SimpleEntry) -> ()) {
        let entry = SimpleEntry(date: Date(), configuration: configuration)
        completion(entry)
    }

    // 不同點5:比使用StaticConfiguration時多了一個配置參數
    func getTimeline(for configuration: ConfigurationIntent, in context: Context, completion: @escaping (Timeline<Entry>) -> ()) {
        var entries: [SimpleEntry] = []

        // Generate a timeline consisting of five entries an hour apart, starting from the current date.
        let currentDate = Date()
        for hourOffset in 0 ..< 5 {
            let entryDate = Calendar.current.date(byAdding: .hour, value: hourOffset, to: currentDate)!
            let entry = SimpleEntry(date: entryDate, configuration: configuration)
            entries.append(entry)
        }

        let timeline = Timeline(entries: entries, policy: .atEnd)
        completion(timeline)
    }
}

struct SimpleEntry: TimelineEntry {
    let date: Date
    // 不同點2: 多了一個配置參數,小組件編輯界面設置參數會通過這個傳遞進來
    let configuration: ConfigurationIntent
}

struct WidgetConfigIntentEntryView : View {
    var entry: Provider.Entry

    var body: some View {
        Text(entry.date, style: .time)
    }
}

// 小組件入口
@main
struct WidgetConfigIntent: Widget {
    let kind: String = "WidgetConfigIntent"

    var body: some WidgetConfiguration {
        //不同點1: 這裡使用 IntentConfiguration, 對比 StaticConfiguration
        //這裡還多了一個參數 intent: ConfigurationIntent.self
        IntentConfiguration(kind: kind, intent: ConfigurationIntent.self, provider: Provider()) { entry in
            WidgetConfigIntentEntryView(entry: entry)
        }
        .configurationDisplayName("可配置小組件")
        .description("選擇不同的時間類型")
    }
}
// 調試預覽
struct WidgetConfigIntent_Previews: PreviewProvider {
    static var previews: some View {
        WidgetConfigIntentEntryView(entry: SimpleEntry(date: Date(), configuration: ConfigurationIntent()))
            .previewContext(WidgetPreviewContext(family: .systemSmall))
    }
}

修改 .intentdefinition 文件實現修改時間類型

  1. 修改配置名稱為TimeTypeConfiguration
  2. 添加參數類型TimeTypeEnum,這裡先用枚舉類型

  1. 添加參數timeType參數,類型指定為TimeTypeEnum

代碼讀取配置信息,實現動態布局

  現在編譯應該不通過,需要修改一下WidgetConfigIntent.swift中的代碼

  1. 把代碼中 ConfigurationIntent 替換為 TimeTypeConfigurationIntent(希望到這裡你能領悟到點什麼)
    運行代碼,在桌面添加組件,長按組件 > 編輯小組件可以看到如下圖所示(目前點了還沒有什麼效果)

    代碼中獲取配置信息,動態改變布局。接下來再編輯小組件,切換時間time/date時界面會發生響應的變化
struct WidgetConfigIntentEntryView : View {
    var entry: Provider.Entry

    var body: some View {
        // 根據配置信息動態改變布局
        if (entry.configuration.timeType == TimeTypeEnum.time) {
            Text(entry.date, style: .time)
        } else {
            Text(entry.date, style: .date)
        }
    }
}

結語

  本文講解了實現一個簡單的可配置小組件,不過數據都是靜態配置,下一節講解動態修改配置數據,這個在實際開發中也是比較重要的環節。