mirror of
https://github.com/home-assistant/iOS.git
synced 2026-06-24 20:17:30 -05:00
72f0688b95
<!-- Thank you for submitting a Pull Request and helping to improve Home Assistant. Please complete the following sections to help the processing and review of your changes. Please do not delete anything from this template. --> ## Summary <!-- Provide a brief summary of the changes you have made and most importantly what they aim to achieve --> Some users experience their "WidgetCustom" interaction to not happen, meanwhile the entity states in the widget update normally. This PR adds more logs to help evaluate what's happening. ## Screenshots <!-- If this is a user-facing change not in the frontend, please include screenshots in light and dark mode. --> ## Link to pull request in Documentation repository <!-- Pull requests that add, change or remove functionality must have a corresponding pull request in the Companion App Documentation repository (https://github.com/home-assistant/companion.home-assistant). Please add the number of this pull request after the "#" --> Documentation: home-assistant/companion.home-assistant# ## Any other notes <!-- If there is any other information of note, like if this Pull Request is part of a bigger change, please include it here. -->
402 lines
14 KiB
Swift
402 lines
14 KiB
Swift
import AppIntents
|
|
import Intents
|
|
import SFSafeSymbols
|
|
import Shared
|
|
import SwiftUI
|
|
import WidgetKit
|
|
|
|
@available(iOS 17, *)
|
|
struct WidgetCustom: Widget {
|
|
var body: some WidgetConfiguration {
|
|
AppIntentConfiguration(
|
|
kind: WidgetsKind.custom.rawValue,
|
|
provider: WidgetCustomTimelineProvider()
|
|
) { timelineEntry in
|
|
if let widget = timelineEntry.widget {
|
|
WidgetBasicContainerView(emptyViewGenerator: {
|
|
AnyView(emptyView)
|
|
}, contents: modelsForWidget(
|
|
widget,
|
|
infoProvider: timelineEntry.magicItemInfoProvider,
|
|
states: timelineEntry.entitiesState,
|
|
showStates: timelineEntry.showStates
|
|
), type: .custom, showLastUpdate: timelineEntry.showLastUpdateTime)
|
|
} else {
|
|
emptyView
|
|
.widgetBackground(Color.clear)
|
|
}
|
|
}
|
|
.contentMarginsDisabledIfAvailable()
|
|
.configurationDisplayName(L10n.Widgets.Preview.Custom.title)
|
|
.description(L10n.Widgets.Preview.Custom.description)
|
|
.supportedFamilies(WidgetCustomSupportedFamilies.families)
|
|
}
|
|
|
|
private var emptyView: some View {
|
|
Link(destination: AppConstants.createCustomWidgetURL.withWidgetAuthenticity()) {
|
|
VStack(spacing: DesignSystem.Spaces.two) {
|
|
Image(systemSymbol: .squareBadgePlusFill)
|
|
.foregroundStyle(Color.haPrimary)
|
|
.font(.system(size: 55))
|
|
Text(verbatim: L10n.Widgets.Preview.Empty.Create.button)
|
|
.foregroundStyle(.secondary)
|
|
.font(.footnote)
|
|
}
|
|
}
|
|
}
|
|
|
|
private func modelsForWidget(
|
|
_ widget: CustomWidget?,
|
|
infoProvider: MagicItemProviderProtocol,
|
|
states: [MagicItem: WidgetEntityState],
|
|
showStates: Bool
|
|
) -> [WidgetBasicViewModel] {
|
|
guard let widget else { return [] }
|
|
|
|
return widget.items.map { magicItem in
|
|
let info = infoProvider.getInfo(for: magicItem)
|
|
let state: WidgetEntityState? = states[magicItem]
|
|
|
|
var backgroundColor: Color? = nil
|
|
var textColor: Color? = nil
|
|
|
|
if let backgroundColorHex = magicItem.customization?.backgroundColor {
|
|
backgroundColor = Color(hex: backgroundColorHex)
|
|
}
|
|
|
|
if let textColorHex = magicItem.customization?.textColor {
|
|
textColor = Color(hex: textColorHex)
|
|
}
|
|
|
|
let icon: MaterialDesignIcons = {
|
|
if let info {
|
|
return magicItem.icon(info: info)
|
|
} else {
|
|
return .gridIcon
|
|
}
|
|
}()
|
|
|
|
let iconColor: Color = {
|
|
let magicItemIconColor = {
|
|
if let iconColor = magicItem.customization?.iconColor {
|
|
return Color(hex: iconColor)
|
|
} else {
|
|
return Color.haPrimary
|
|
}
|
|
}()
|
|
|
|
if !widget.itemsStates.isEmpty {
|
|
return Color.gray
|
|
} else if showStates, [.light, .switch, .inputBoolean, .cover, .fan].contains(magicItem.domain) {
|
|
if state?.domainState?.isActive ?? false {
|
|
return state?.color ?? magicItemIconColor
|
|
} else {
|
|
return Color.gray
|
|
}
|
|
} else {
|
|
return magicItemIconColor
|
|
}
|
|
}()
|
|
|
|
let title: String = {
|
|
if let info {
|
|
return magicItem.name(info: info)
|
|
} else {
|
|
return magicItem.id
|
|
}
|
|
}()
|
|
|
|
let useCustomColors = backgroundColor != nil || textColor != nil
|
|
|
|
let showConfirmation = {
|
|
if let itemState = widget.itemsStates.first(where: { $0.key == magicItem.serverUniqueId })?.value {
|
|
return itemState == .pendingConfirmation
|
|
} else {
|
|
return false
|
|
}
|
|
}()
|
|
|
|
let interactionType = magicItem.widgetInteractionType
|
|
Current.Log.verbose(
|
|
"""
|
|
WidgetCustom: generated item model, widgetId: \(widget.id), itemId: \(magicItem.id), \
|
|
serverId: \(magicItem.serverId), domain: \(String(describing: magicItem.domain?.rawValue)), \
|
|
action: \(String(describing: magicItem.action?.id)), requiresConfirmation: \(
|
|
magicItem.customization?
|
|
.requiresConfirmation ?? true
|
|
), \
|
|
showStates: \(showStates), hasState: \(
|
|
state !=
|
|
nil
|
|
), interactionType: \(String(describing: interactionType))
|
|
"""
|
|
)
|
|
let showIconBackground = {
|
|
switch interactionType {
|
|
case .widgetURL:
|
|
return true
|
|
case let .appIntent(widgetIntentType):
|
|
return widgetIntentType != .refresh
|
|
}
|
|
}()
|
|
|
|
return WidgetBasicViewModel(
|
|
id: magicItem.serverUniqueId,
|
|
title: title,
|
|
subtitle: state?.value,
|
|
interactionType: interactionType,
|
|
icon: icon,
|
|
showIconBackground: showIconBackground,
|
|
textColor: textColor ?? Color(uiColor: .label),
|
|
iconColor: iconColor,
|
|
backgroundColor: backgroundColor ?? Color.tileBackground,
|
|
useCustomColors: useCustomColors,
|
|
showConfirmation: showConfirmation,
|
|
requiresConfirmation: magicItem.customization?.requiresConfirmation ?? true,
|
|
widgetId: widget.id,
|
|
disabled: !widget.itemsStates.isEmpty
|
|
)
|
|
}
|
|
}
|
|
}
|
|
|
|
enum WidgetCustomSupportedFamilies {
|
|
@available(iOS 16.0, *)
|
|
static let families: [WidgetFamily] = [
|
|
.systemSmall,
|
|
.systemMedium,
|
|
.systemLarge,
|
|
]
|
|
}
|
|
|
|
#if DEBUG
|
|
|
|
// UNCOMMENT ON DEMAND: If all previews are uncommented, Xcode will, most probably, fail to render them all at once.
|
|
|
|
// @available(iOS 17, *)
|
|
// #Preview("Small empty", as: .systemSmall) {
|
|
// WidgetCustom()
|
|
// } timeline: {
|
|
// WidgetCustomEntry(
|
|
// date: .now,
|
|
// widget: .init(id: "123", name: "My widget", items: []),
|
|
// magicItemInfoProvider: MockMagicItemProvider(),
|
|
// entitiesState: [:],
|
|
// showLastUpdateTime: true,
|
|
// showStates: true
|
|
// )
|
|
// }
|
|
|
|
// @available(iOS 17, *)
|
|
// #Preview("Small 1 Item", as: .systemSmall) {
|
|
// WidgetCustom()
|
|
// } timeline: {
|
|
// WidgetCustomEntry(
|
|
// date: .now,
|
|
// widget: .init(id: "123", name: "My widget", items: [
|
|
// .init(id: "light.one", serverId: "1", type: .entity, action: .navigate("/lovelace/0")),
|
|
// ]),
|
|
// magicItemInfoProvider: MockMagicItemProvider(),
|
|
// entitiesState: [:],
|
|
// showLastUpdateTime: true,
|
|
// showStates: true
|
|
// )
|
|
// }
|
|
//
|
|
// @available(iOS 17, *)
|
|
// #Preview("Small 2 Items", as: .systemSmall) {
|
|
// WidgetCustom()
|
|
// } timeline: {
|
|
// WidgetCustomEntry(
|
|
// date: .now,
|
|
// widget: .init(id: "123", name: "My widget", items: [
|
|
// .init(id: "light.one", serverId: "1", type: .entity, action: .navigate("/lovelace/0")),
|
|
// .init(id: "2", serverId: "2", type: .entity),
|
|
// ]),
|
|
// magicItemInfoProvider: MockMagicItemProvider(),
|
|
// entitiesState: [:],
|
|
// showLastUpdateTime: true,
|
|
// showStates: true
|
|
// )
|
|
// }
|
|
//
|
|
// @available(iOS 17, *)
|
|
// #Preview("Small 3 Items", as: .systemSmall) {
|
|
// WidgetCustom()
|
|
// } timeline: {
|
|
// WidgetCustomEntry(
|
|
// date: .now,
|
|
// widget: .init(id: "123", name: "My widget", items: [
|
|
// .init(id: "light.one", serverId: "1", type: .entity, action: .navigate("/lovelace/0")),
|
|
// .init(id: "2", serverId: "2", type: .entity),
|
|
// .init(id: "3", serverId: "3", type: .entity),
|
|
// ]),
|
|
// magicItemInfoProvider: MockMagicItemProvider(),
|
|
// entitiesState: [.init(id: "3", serverId: "3", type: .entity): .init(value: "On", domainState: .on)],
|
|
// showLastUpdateTime: true,
|
|
// showStates: true
|
|
// )
|
|
// }
|
|
|
|
// @available(iOS 17, *)
|
|
// #Preview("Medium 1 item", as: .systemMedium) {
|
|
// WidgetCustom()
|
|
// } timeline: {
|
|
// WidgetCustomEntry(
|
|
// date: .now,
|
|
// widget: .init(id: "123", name: "My widget", items: [
|
|
// .init(id: "light.one", serverId: "1", type: .entity, action: .navigate("/lovelace/0")),
|
|
// ]),
|
|
// magicItemInfoProvider: MockMagicItemProvider(),
|
|
// entitiesState: [:],
|
|
// showLastUpdateTime: true,
|
|
// showStates: true
|
|
// )
|
|
// }
|
|
//
|
|
// @available(iOS 17, *)
|
|
// #Preview("Medium 2 items", as: .systemMedium) {
|
|
// WidgetCustom()
|
|
// } timeline: {
|
|
// WidgetCustomEntry(
|
|
// date: .now,
|
|
// widget: .init(id: "123", name: "My widget", items: [
|
|
// .init(id: "light.one", serverId: "1", type: .entity, action: .navigate("/lovelace/0")),
|
|
// .init(id: "2", serverId: "2", type: .entity),
|
|
// ]),
|
|
// magicItemInfoProvider: MockMagicItemProvider(),
|
|
// entitiesState: [.init(id: "2", serverId: "2", type: .entity): .init(value: "On", domainState: .on)],
|
|
// showLastUpdateTime: true,
|
|
// showStates: true
|
|
// )
|
|
// }
|
|
|
|
// @available(iOS 17, *)
|
|
// #Preview("Medium 3 items", as: .systemMedium) {
|
|
// WidgetCustom()
|
|
// } timeline: {
|
|
// WidgetCustomEntry(
|
|
// date: .now,
|
|
// widget: .init(id: "123", name: "My widget", items: [
|
|
// .init(id: "light.one", serverId: "1", type: .entity, action: .navigate("/lovelace/0")),
|
|
// .init(id: "2", serverId: "2", type: .entity),
|
|
// .init(id: "3", serverId: "3", type: .entity),
|
|
// ]),
|
|
// magicItemInfoProvider: MockMagicItemProvider(),
|
|
// entitiesState: [.init(id: "2", serverId: "2", type: .entity): .init(value: "On", domainState: .on)],
|
|
// showLastUpdateTime: true,
|
|
// showStates: true
|
|
// )
|
|
// }
|
|
|
|
// @available(iOS 17, *)
|
|
// #Preview("Medium 4 items", as: .systemMedium) {
|
|
// WidgetCustom()
|
|
// } timeline: {
|
|
// WidgetCustomEntry(
|
|
// date: .now,
|
|
// widget: .init(id: "123", name: "My widget", items: [
|
|
// .init(id: "light.one", serverId: "1", type: .entity, action: .navigate("/lovelace/0")),
|
|
// .init(id: "2", serverId: "2", type: .entity),
|
|
// .init(id: "3", serverId: "3", type: .entity),
|
|
// .init(id: "4", serverId: "4", type: .entity),
|
|
// ]),
|
|
// magicItemInfoProvider: MockMagicItemProvider(),
|
|
// entitiesState: [:],
|
|
// showLastUpdateTime: true,
|
|
// showStates: true
|
|
// )
|
|
// }
|
|
|
|
// @available(iOS 17, *)
|
|
// #Preview("Medium 5 items", as: .systemMedium) {
|
|
// WidgetCustom()
|
|
// } timeline: {
|
|
// WidgetCustomEntry(
|
|
// date: .now,
|
|
// widget: .init(id: "123", name: "My widget", items: [
|
|
// .init(id: "light.one", serverId: "1", type: .entity, action: .navigate("/lovelace/0")),
|
|
// .init(id: "2", serverId: "2", type: .entity),
|
|
// .init(id: "3", serverId: "3", type: .entity),
|
|
// .init(id: "4", serverId: "4", type: .entity),
|
|
// .init(id: "5", serverId: "5", type: .entity),
|
|
// ]),
|
|
// magicItemInfoProvider: MockMagicItemProvider(),
|
|
// entitiesState: [:],
|
|
// showLastUpdateTime: true,
|
|
// showStates: true
|
|
// )
|
|
// }
|
|
//
|
|
// @available(iOS 17, *)
|
|
// #Preview("Medium 6 items", as: .systemMedium) {
|
|
// WidgetCustom()
|
|
// } timeline: {
|
|
// WidgetCustomEntry(
|
|
// date: .now,
|
|
// widget: .init(id: "123", name: "My widget", items: [
|
|
// .init(id: "light.one", serverId: "1", type: .entity, action: .navigate("/lovelace/0")),
|
|
// .init(id: "2", serverId: "2", type: .entity),
|
|
// .init(id: "3", serverId: "3", type: .entity),
|
|
// .init(id: "4", serverId: "4", type: .entity),
|
|
// .init(id: "5", serverId: "5", type: .entity),
|
|
// .init(id: "6", serverId: "6", type: .entity),
|
|
// ]),
|
|
// magicItemInfoProvider: MockMagicItemProvider(),
|
|
// entitiesState: [:],
|
|
// showLastUpdateTime: true,
|
|
// showStates: true
|
|
// )
|
|
// }
|
|
//
|
|
// @available(iOS 17, *)
|
|
// #Preview("Medium empty", as: .systemMedium) {
|
|
// WidgetCustom()
|
|
// } timeline: {
|
|
// WidgetCustomEntry(
|
|
// date: .now,
|
|
// widget: nil,
|
|
// magicItemInfoProvider: MockMagicItemProvider(),
|
|
// entitiesState: [:],
|
|
// showLastUpdateTime: true,
|
|
// showStates: true
|
|
// )
|
|
// }
|
|
//
|
|
// @available(iOS 17, *)
|
|
// #Preview("Large empty", as: .systemLarge) {
|
|
// WidgetCustom()
|
|
// } timeline: {
|
|
// WidgetCustomEntry(
|
|
// date: .now,
|
|
// widget: nil,
|
|
// magicItemInfoProvider: MockMagicItemProvider(),
|
|
// entitiesState: [:],
|
|
// showLastUpdateTime: true,
|
|
// showStates: true
|
|
// )
|
|
// }
|
|
|
|
final class MockMagicItemProvider: MagicItemProviderProtocol {
|
|
func loadInformation(completion: @escaping ([String: [Shared.HAAppEntity]]) -> Void) {
|
|
/* no-op */
|
|
}
|
|
|
|
func loadInformation() async -> [String: [Shared.HAAppEntity]] {
|
|
[:]
|
|
}
|
|
|
|
func getInfo(for item: Shared.MagicItem) -> Shared.MagicItem.Info? {
|
|
if item.id == "light.one" {
|
|
return .init(id: "1", name: "Abc", iconName: "script", customization: nil)
|
|
} else {
|
|
return .init(id: "2", name: "Cba", iconName: "heart", customization: .init(iconColor: "#FFFFFF"))
|
|
}
|
|
}
|
|
|
|
func getAreaName(for item: Shared.MagicItem) -> String? {
|
|
nil
|
|
}
|
|
}
|
|
#endif
|