mirror of
https://github.com/home-assistant/iOS.git
synced 2026-04-28 18:22:59 -05:00
Add "Script" iOS 18 ControlWidget (#2952)
<!-- 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 --> This PR also adds a dependency: `SFSafeSymbols` to safely iterate over SFSymbols. For ControlWidget we can't use MaterialDesign icons, unless they are converted into custom SFSymbols and embedded in the App but this would increase a lot the App size ## 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. -->
This commit is contained in:
committed by
GitHub
parent
bed6928a4a
commit
d8c561d85d
@@ -0,0 +1,29 @@
|
||||
import Foundation
|
||||
import Shared
|
||||
import SwiftUI
|
||||
import WidgetKit
|
||||
|
||||
@available(iOS 18, *)
|
||||
struct ControlScript: ControlWidget {
|
||||
var body: some ControlWidgetConfiguration {
|
||||
AppIntentControlConfiguration(
|
||||
kind: WidgetsKind.controlScript.rawValue,
|
||||
provider: ControlScriptsValueProvider()
|
||||
) { template in
|
||||
ControlWidgetButton(action: {
|
||||
let intent = ScriptAppIntent()
|
||||
intent.script = .init(
|
||||
id: template.intentScriptEntity.id,
|
||||
serverId: template.intentScriptEntity.serverId,
|
||||
serverName: template.intentScriptEntity.serverName,
|
||||
displayString: template.intentScriptEntity.displayString,
|
||||
iconName: template.icon.id
|
||||
)
|
||||
return intent
|
||||
}()) {
|
||||
// ControlWidget can only display SF Symbol
|
||||
Label(template.intentScriptEntity.displayString, systemImage: template.icon.id)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,75 @@
|
||||
import AppIntents
|
||||
import Foundation
|
||||
import Shared
|
||||
import WidgetKit
|
||||
|
||||
@available(iOSApplicationExtension 18, *)
|
||||
struct ControlScriptItem {
|
||||
let intentScriptEntity: IntentScriptEntity
|
||||
let icon: SFSymbolEntity
|
||||
}
|
||||
|
||||
@available(iOSApplicationExtension 18, *)
|
||||
struct ControlScriptsValueProvider: AppIntentControlValueProvider {
|
||||
func currentValue(configuration: ControlScriptsConfiguration) async throws -> ControlScriptItem {
|
||||
.init(
|
||||
intentScriptEntity: configuration.script ?? placeholder(),
|
||||
icon: configuration.icon ?? placeholderIcon()
|
||||
)
|
||||
}
|
||||
|
||||
func placeholder(for configuration: ControlScriptsConfiguration) -> ControlScriptItem {
|
||||
.init(
|
||||
intentScriptEntity: configuration.script ?? placeholder(),
|
||||
icon: configuration.icon ?? placeholderIcon()
|
||||
)
|
||||
}
|
||||
|
||||
func previewValue(configuration: ControlScriptsConfiguration) -> ControlScriptItem {
|
||||
.init(
|
||||
intentScriptEntity: configuration.script ?? placeholder(),
|
||||
icon: configuration.icon ?? placeholderIcon()
|
||||
)
|
||||
}
|
||||
|
||||
private func placeholder() -> IntentScriptEntity {
|
||||
.init(
|
||||
id: UUID().uuidString,
|
||||
serverId: "",
|
||||
serverName: "",
|
||||
displayString: L10n.Widgets.Controls.Scripts.placeholderTitle,
|
||||
iconName: ""
|
||||
)
|
||||
}
|
||||
|
||||
private func placeholderIcon() -> SFSymbolEntity {
|
||||
.init(id: "applescript.fill")
|
||||
}
|
||||
}
|
||||
|
||||
@available(iOSApplicationExtension 18.0, *)
|
||||
struct ControlScriptsConfiguration: ControlConfigurationIntent {
|
||||
static var title: LocalizedStringResource = .init("widgets.scripts.description", defaultValue: "Run Scripts")
|
||||
|
||||
@Parameter(
|
||||
title: "Script"
|
||||
)
|
||||
var script: IntentScriptEntity?
|
||||
@Parameter(
|
||||
title: "Icon"
|
||||
)
|
||||
var icon: SFSymbolEntity?
|
||||
|
||||
@Parameter(
|
||||
title: LocalizedStringResource(
|
||||
"app_intents.scripts.show_confirmation_dialog.title",
|
||||
defaultValue: "Confirmation notification"
|
||||
),
|
||||
description: LocalizedStringResource(
|
||||
"app_intents.scripts.show_confirmation_dialog.description",
|
||||
defaultValue: "Shows confirmation notification after executed"
|
||||
),
|
||||
default: true
|
||||
)
|
||||
var showConfirmationDialog: Bool
|
||||
}
|
||||
@@ -0,0 +1,44 @@
|
||||
import AppIntents
|
||||
import Foundation
|
||||
import SFSafeSymbols
|
||||
|
||||
@available(iOS 16.4, macOS 13.0, watchOS 9.0, *)
|
||||
struct SFSymbolEntity: AppEntity {
|
||||
static let typeDisplayRepresentation = TypeDisplayRepresentation(name: "Icon")
|
||||
|
||||
static let defaultQuery = IntentSFSymbolAppEntityQuery()
|
||||
|
||||
var id: String
|
||||
var displayRepresentation: DisplayRepresentation {
|
||||
DisplayRepresentation(title: "\(id)", image: .init(systemName: id))
|
||||
}
|
||||
|
||||
init(
|
||||
id: String
|
||||
) {
|
||||
self.id = id
|
||||
}
|
||||
}
|
||||
|
||||
@available(iOS 16.4, macOS 13.0, watchOS 9.0, *)
|
||||
struct IntentSFSymbolAppEntityQuery: EntityQuery, EntityStringQuery {
|
||||
func entities(for identifiers: [String]) async throws -> [SFSymbolEntity] {
|
||||
let allSymbols = SFSymbol.allSymbols.map(\.rawValue).map({ SFSymbolEntity(id: $0) })
|
||||
if identifiers.isEmpty {
|
||||
return allSymbols
|
||||
} else {
|
||||
return allSymbols.filter { identifiers.contains($0.id) }
|
||||
}
|
||||
}
|
||||
|
||||
func entities(matching string: String) async throws -> IntentItemCollection<SFSymbolEntity> {
|
||||
let allSymbols = SFSymbol.allSymbols.map(\.rawValue).map({ SFSymbolEntity(id: $0) })
|
||||
.filter { $0.id.contains(string) }
|
||||
return .init(items: allSymbols)
|
||||
}
|
||||
|
||||
func suggestedEntities() async throws -> IntentItemCollection<SFSymbolEntity> {
|
||||
let allSymbols = SFSymbol.allSymbols.map(\.rawValue).map({ SFSymbolEntity(id: $0) })
|
||||
return .init(items: allSymbols)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user