灵动岛实际上是一个小组件,就像 iOS 14 小组件一样。
灵动岛创建Widget文件,系统会自动创建三个文件,这时候直接引用ActivityAttributes文件系统会报错,找不到这个文件,这个问题解决需要手动创建一个ActivityAttributes Swift文件
import Foundation
import ActivityKit
struct LiveActvityWidgetAttributes: ActivityAttributes {
typealias LiveActivityWidgetState = ContentState
public struct ContentState: Codable, Hashable {
// 可变的属性需要放在这里,activity调用update进行数据的更新 动态数据
var value: Int
}
// 灵动岛的初始化数据,描述不可变的数据 通知栏内通知 静态数据
var name: String
// var logo: String
// var subName: String
}
然后在Build Phases->Compile Sources中添加新创建的文件
//只后主页面中引用这个文件代码不会报错
var liveActivity: Activity<LiveActvityWidgetAttributes>? = nil
以下写以下灵动岛的完整配置
1 创建Target
创建一个新的 Widget Target,到 File -> New -> Target...,创建一个 Widget Extension
一定要勾选 Include live Activity(灵动岛),然后输入名称,点击Active完成既可。
2 在主程序添加info.plist配置
项目要启用灵动岛,需要在主程序 Info.plist 文件中添加 NSSupportsLiveActivities,并将其布尔值设置为 YES。
接下来就是代码配置部分
主要代码分为两部分,一部分是 ActivityAttributes,主要用来提供灵动岛上展示的数据
public struct ContentState: Codable, Hashable {
var emoji: String
}
var name: String
}
另一部分是灵动岛的 UI 展示:
struct MyLiveActivityLiveActivity: Widget {
var body: some WidgetConfiguration {
ActivityConfiguration(for: MyLiveActivityAttributes.self) { context in
// 展示锁屏页面的 UI
VStack {
Text("\(context.attributes.name) \(context.state.emoji)")
}
.activityBackgroundTint(Color.cyan)
.activitySystemActionForegroundColor(Color.black)
} dynamicIsland: { context in
DynamicIsland {
// 展开样式 UI
DynamicIslandExpandedRegion(.leading) {
Text("左侧")
}
DynamicIslandExpandedRegion(.trailing) {
Text("右侧")
}
DynamicIslandExpandedRegion(.bottom) {
Text("底部 \(context.state.emoji)")
Text("内容:\(context.attributes.name) 自定义内容")
}
} compactLeading: {
// 紧凑型样式左边 UI
Text("左")
} compactTrailing: {
// 紧凑型样式右边 UI
Text("右 \(context.state.emoji)")
} minimal: {
// 最小型样式 UI
Text(context.state.emoji)
}
.widgetURL(URL(string: "http://www.apple.com"))
.keylineTint(Color.red)
}
}
}
第一个 block 用来渲染展示锁屏页面的 UI,dynamicIsland 就是用来渲染灵动岛的内容了。
DynamicIsland 对象中,第一部分用来渲染展开样式的 UI,compactLeading 用来展示紧凑型样式左边 UI,compactTrailing 用来展示紧凑型样式右边 UI,minimal 用来展示最小型样式 UI。
启动灵动岛
我们在主 App 的 ViewController 中渲染三个按钮来模拟用户达到某个条件后启动/更新和关闭灵动岛:
代码都是大同小异
import ActivityKit
class ViewController: UIViewController {
var activity: Activity<MyLiveActivityAttributes>? = nil
override func viewDidLoad() {
super.viewDidLoad()
createButton(title: "启动灵动岛", y: view.center.y - 100, selector: #selector(start))
createButton(title: "更新灵动岛", y: view.center.y - 50, selector: #selector(update))
createButton(title: "关闭灵动岛", y: view.center.y, selector: #selector(end))
}
private func createButton(title: String, y: CGFloat, selector: Selector) {
let button = UIButton(type: .system)
button.setTitle(title, for: .normal)
button.sizeToFit()
view.addSubview(button)
button.center.x = view.center.x
button.frame.origin.y = y
button.addTarget(self, action: selector, for: .touchUpInside)
}
@objc
private func start() {
// 创建灵动岛
let attributes = MyLiveActivityAttributes(name: "测试123")
let state = MyLiveActivityAttributes.ContentState(emoji: " ")
let content = ActivityContent<MyLiveActivityAttributes.ContentState>(state: state, staleDate: nil)
do {
self.activity = try Activity<MyLiveActivityAttributes>.request(attributes: attributes, content: content)
} catch let error {
print("出错了:\(error.localizedDescription)")
}
}
@objc
private func update() {
let state = MyLiveActivityAttributes.ContentState(emoji: " ")
Task {
await activity?.update(using: state)
}
}
@objc
private func end() {
Task {
await activity?.end()
}
}
}
启动灵动岛需要创建一个 ActivityAttributes,和一个 ActivityContent,然后调用 request(attributes: content:) 方法既可,这个方法会返回一个 Activity 对象,我们保留这个对象,后面更新和关闭灵动岛的时候使用。
更新灵动岛只需要使用上边的 Activity 对象,调用 update(using:) 方法。
关闭灵动岛只需要使用上边的 Activity 对象,调用 end() 方法。