a67559299a
* Update the template screen to use the new(ish) Observation framework. * Add a variant of deferFulfillment that supports observables. * Update snapshot fulfilment to work with either a publisher or a stream.
82 lines
3.5 KiB
Swift
82 lines
3.5 KiB
Swift
//
|
|
// Copyright 2022-2024 New Vector Ltd.
|
|
//
|
|
// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
|
|
// Please see LICENSE files in the repository root for full details.
|
|
//
|
|
|
|
import Combine
|
|
import SwiftUI
|
|
|
|
struct SnapshotPrecisionPreferenceKey: PreferenceKey {
|
|
static var defaultValue: Float = 1.0
|
|
|
|
static func reduce(value: inout Float, nextValue: () -> Float) {
|
|
value = nextValue()
|
|
}
|
|
}
|
|
|
|
struct SnapshotPerceptualPrecisionPreferenceKey: PreferenceKey {
|
|
static var defaultValue: Float = 0.98
|
|
|
|
static func reduce(value: inout Float, nextValue: () -> Float) {
|
|
value = nextValue()
|
|
}
|
|
}
|
|
|
|
struct SnapshotFulfillmentPreferenceKey: PreferenceKey {
|
|
static var defaultValue: Wrapper?
|
|
|
|
static func reduce(value: inout Wrapper?, nextValue: () -> Wrapper?) {
|
|
value = nextValue()
|
|
}
|
|
|
|
enum Source {
|
|
case publisher(AnyPublisher<Bool, Never>)
|
|
case stream(AsyncStream<Bool>)
|
|
}
|
|
|
|
struct Wrapper: Equatable {
|
|
let id = UUID()
|
|
let source: Source
|
|
|
|
static func == (lhs: Wrapper, rhs: Wrapper) -> Bool {
|
|
lhs.id == rhs.id // Not ideal, but it's good enough for snapshots.
|
|
}
|
|
}
|
|
}
|
|
|
|
extension SwiftUI.View {
|
|
/// Use this modifier when you want to apply snapshot-specific preferences,
|
|
/// like delay and precision, to the view.
|
|
/// These preferences can then be retrieved and used elsewhere in your view hierarchy.
|
|
///
|
|
/// - Parameters:
|
|
/// - expect: A publisher that indicates when the preview is ready for snapshotting.
|
|
/// - precision: The percentage of pixels that must match.
|
|
/// - perceptualPrecision: The percentage a pixel must match the source pixel to be considered a match. 98-99% mimics the precision of the human eye.
|
|
func snapshotPreferences(expect fulfillmentPublisher: (any Publisher<Bool, Never>)? = nil,
|
|
precision: Float = 1.0,
|
|
perceptualPrecision: Float = 0.98) -> some SwiftUI.View {
|
|
preference(key: SnapshotPrecisionPreferenceKey.self, value: precision)
|
|
.preference(key: SnapshotPerceptualPrecisionPreferenceKey.self, value: perceptualPrecision)
|
|
.preference(key: SnapshotFulfillmentPreferenceKey.self, value: fulfillmentPublisher.map { SnapshotFulfillmentPreferenceKey.Wrapper(source: .publisher($0.eraseToAnyPublisher())) })
|
|
}
|
|
|
|
/// Use this modifier when you want to apply snapshot-specific preferences,
|
|
/// like delay and precision, to the view.
|
|
/// These preferences can then be retrieved and used elsewhere in your view hierarchy.
|
|
///
|
|
/// - Parameters:
|
|
/// - expect: A stream that indicates when the preview is ready for snapshotting.
|
|
/// - precision: The percentage of pixels that must match.
|
|
/// - perceptualPrecision: The percentage a pixel must match the source pixel to be considered a match. 98-99% mimics the precision of the human eye.
|
|
func snapshotPreferences(expect fulfillmentStream: AsyncStream<Bool>? = nil,
|
|
precision: Float = 1.0,
|
|
perceptualPrecision: Float = 0.98) -> some SwiftUI.View {
|
|
preference(key: SnapshotPrecisionPreferenceKey.self, value: precision)
|
|
.preference(key: SnapshotPerceptualPrecisionPreferenceKey.self, value: perceptualPrecision)
|
|
.preference(key: SnapshotFulfillmentPreferenceKey.self, value: fulfillmentStream.map { SnapshotFulfillmentPreferenceKey.Wrapper(source: .stream($0)) })
|
|
}
|
|
}
|