让我先吐槽下,这玩意让我踩了不少坑,网上的一些资料也都是在正式版出来之前的,在我开始整这个的时候,挺坑的。
言归正传,还记得在第一次创建Widget
的时候,有一个选项我们没有勾选,Include Configuration Intent
。这选项主要是用来支持你自定义一些属性配置(例如天气组件,用户可以选择城市,股票组件,用户可以选择代码等)
你可以试着重新创建一个
Widget
,并且勾选上,然后对比下Xcode
生成的代码实现跟未勾选的代码实现有什么区别。
首先你会发现左侧目录列表出现一个后缀名为
.intentdefinition
的文件,至于里面的东西先略过。
Provider
新的
Provider
现在不再是遵守TimelineProvider
,而是遵守IntentTimelineProvider
协议,并且内部的三个placeholder
、getSnapshot
、getTimeline
必实现方法的参数也多增加了一个ConfigurationIntent
。
SimpleEntry
SimpleEntry
也增加了一个ConfigurationIntent
类型的参数
Widget
Widgetd
的内部body实现的配置方法由静态的StaticConfiguration
换成了动态的IntentConfiguration
可以试着添加系统APP的小组件,比如天气,然后桌面上长按,会出现了一个编辑小组件的选项,点击进去可以看到允许用户编辑当前位置,用来展示不同地方的天气,具体截图不整了,自己手机看。
现在我们在已经勾选了配置选择的基础上进行操作,实现一个展示一个Text
文本的小组件,通过编辑输入内容,刷新桌面小组件的Text
文本。
进行.intentdefinition
的页面配置
记住左侧
CUSTOM INTENTS
的Configuration
这个名称,Xcode会根据这个名称,自动生成一个ConfigurationIntent
类,这个类就是接下来需要用到的。
再回到.intentdefinition
的配置页面,在下面的地方增加一个title
属性,String
类型,注意右边的四个选项只需要勾选第2个,根据说明就知道这个选项是允许编辑的,你可以不勾选试试效果。
回到代码实现页面,我们只要修改下WidgetEntryView
的body里面的Text
内容,从entry
里面获取到configuration
配置的title
属性:
struct LLLLWidgetEntryView : View {
var entry: Provider.Entry
var body: some View {
// Text(entry.date, style: .time)
Text(entry.configuration.title == nil ? "没有值" : entry.configuration.title!)
}
}
接下来就可以运行起来,体验下效果。
接下来说我碰到的坑!!!!!!。
上面都是基于一开始就勾选了Include Configuration Intent
的情况下,Xcode
默认生成的文件、代码。
下面来看看一开始没勾选,后期开发需求需要配置的情况下,如何处理。
- 菜单
File
->New
->File
然后找到Siri Intent Definition File
之后添加到WidgetExtension
中,命名的话,建议取个合适的名称。
重要的事情说三遍,箭头那边一定要勾选
不知道不是默认不勾选,我一开始没注意,导致后面代码里一直联想不出来它自动生成的那个swift
类。
- 添加
Intents
,命名啥的可以跟上面创建的命名一样,好记啊。
- 接下来的设置就跟上面默认生成的情况下一样,添加属性、该勾选的勾选。
- 代码部分的修改,小技巧就是你跟着默认生成的那种样式的代码对照,哪里不一样就改哪里。
先修改Widget
的配置,由StaticConfiguration
改成IntentConfiguration
。
@main
struct MyWidget: Widget {
let kind: String = "MyWidget"
var body: some WidgetConfiguration {
// StaticConfiguration(kind: kind, provider: Provider()) { entry in
// MyWidgetEntryView(entry: entry)
// }
// .configurationDisplayName("My Widget")
// .description("This is an example widget.")
IntentConfiguration(kind: kind, intent: MyIntentConfigurationIntent.self, provider: Provider()) { entry in
MyWidgetEntryView(entry: entry)
}
.configurationDisplayName("My Widget")
.description("This is an example widget.")
}
}
SimpleEntry
增加
struct SimpleEntry: TimelineEntry {
let date: Date
let configuration: MyIntentConfigurationIntent
}
Provider
的继承改成IntentTimelineProvider
开头的两个typealias
必须实现,不实现我这里会报错,暂时没整明白,因为网上有些文章没有实现也可以。
struct Provider: IntentTimelineProvider {
typealias Entry = SimpleEntry
typealias Intent = MyIntentConfigurationIntent
func placeholder(in context: Context) -> SimpleEntry {
SimpleEntry(date: Date(), configuration: MyIntentConfigurationIntent())
}
func getSnapshot(for configuration: MyIntentConfigurationIntent, in context: Context, completion: @escaping (SimpleEntry) -> Void) {
let entry = SimpleEntry(date: Date(), configuration: configuration)
completion(entry)
}
func getTimeline(for configuration: MyIntentConfigurationIntent, in context: Context, completion: @escaping (Timeline) -> Void) {
var entries: [SimpleEntry] = []
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)
}
}
参考资料
creating-a-widget-extension
https://swiftrocks.com
IntentConfiguration