update

Pods/Kingfisher/Sources/SwiftUI/KFImageOptions.swift

@@ -0,0 +1,158 @@
+//
+//  KFImageOptions.swift
+//  Kingfisher
+//
+//  Created by onevcat on 2020/12/20.
+//
+//  Copyright (c) 2020 Wei Wang <onevcat@gmail.com>
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
+
+#if canImport(SwiftUI) && canImport(Combine)
+import SwiftUI
+import Combine
+
+// MARK: - KFImage creating.
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
+extension KFImageProtocol {
+
+    /// Creates a `KFImage` for a given `Source`.
+    /// - Parameters:
+    ///   - source: The `Source` object defines data information from network or a data provider.
+    /// - Returns: A `KFImage` for future configuration or embedding to a `SwiftUI.View`.
+    public static func source(
+        _ source: Source?
+    ) -> Self
+    {
+        Self.init(source: source)
+    }
+
+    /// Creates a `KFImage` for a given `Resource`.
+    /// - Parameters:
+    ///   - source: The `Resource` object defines data information like key or URL.
+    /// - Returns: A `KFImage` for future configuration or embedding to a `SwiftUI.View`.
+    public static func resource(
+        _ resource: Resource?
+    ) -> Self
+    {
+        source(resource?.convertToSource())
+    }
+
+    /// Creates a `KFImage` for a given `URL`.
+    /// - Parameters:
+    ///   - url: The URL where the image should be downloaded.
+    ///   - cacheKey: The key used to store the downloaded image in cache.
+    ///               If `nil`, the `absoluteString` of `url` is used as the cache key.
+    /// - Returns: A `KFImage` for future configuration or embedding to a `SwiftUI.View`.
+    public static func url(
+        _ url: URL?, cacheKey: String? = nil
+    ) -> Self
+    {
+        source(url?.convertToSource(overrideCacheKey: cacheKey))
+    }
+
+    /// Creates a `KFImage` for a given `ImageDataProvider`.
+    /// - Parameters:
+    ///   - provider: The `ImageDataProvider` object contains information about the data.
+    /// - Returns: A `KFImage` for future configuration or embedding to a `SwiftUI.View`.
+    public static func dataProvider(
+        _ provider: ImageDataProvider?
+    ) -> Self
+    {
+        source(provider?.convertToSource())
+    }
+
+    /// Creates a builder for some given raw data and a cache key.
+    /// - Parameters:
+    ///   - data: The data object from which the image should be created.
+    ///   - cacheKey: The key used to store the downloaded image in cache.
+    /// - Returns: A `KFImage` for future configuration or embedding to a `SwiftUI.View`.
+    public static func data(
+        _ data: Data?, cacheKey: String
+    ) -> Self
+    {
+        if let data = data {
+            return dataProvider(RawImageDataProvider(data: data, cacheKey: cacheKey))
+        } else {
+            return dataProvider(nil)
+        }
+    }
+}
+
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
+extension KFImageProtocol {
+    /// Sets a placeholder `View` which shows when loading the image, with a progress parameter as input.
+    /// - Parameter content: A view that describes the placeholder.
+    /// - Returns: A `KFImage` view that contains `content` as its placeholder.
+    public func placeholder<P: View>(@ViewBuilder _ content: @escaping (Progress) -> P) -> Self {
+        context.placeholder = { progress in
+            return AnyView(content(progress))
+        }
+        return self
+    }
+    
+    /// Sets a placeholder `View` which shows when loading the image.
+    /// - Parameter content: A view that describes the placeholder.
+    /// - Returns: A `KFImage` view that contains `content` as its placeholder.
+    public func placeholder<P: View>(@ViewBuilder _ content: @escaping () -> P) -> Self {
+        placeholder { _ in content() }
+    }
+
+    /// Sets cancelling the download task bound to `self` when the view disappearing.
+    /// - Parameter flag: Whether cancel the task or not.
+    /// - Returns: A `KFImage` view that cancels downloading task when disappears.
+    public func cancelOnDisappear(_ flag: Bool) -> Self {
+        context.cancelOnDisappear = flag
+        return self
+    }
+
+    /// Sets a fade transition for the image task.
+    /// - Parameter duration: The duration of the fade transition.
+    /// - Returns: A `KFImage` with changes applied.
+    ///
+    /// Kingfisher will use the fade transition to animate the image in if it is downloaded from web.
+    /// The transition will not happen when the
+    /// image is retrieved from either memory or disk cache by default. If you need to do the transition even when
+    /// the image being retrieved from cache, also call `forceRefresh()` on the returned `KFImage`.
+    public func fade(duration: TimeInterval) -> Self {
+        context.options.transition = .fade(duration)
+        return self
+    }
+    
+    /// Sets whether to start the image loading before the view actually appears.
+    ///
+    /// By default, Kingfisher performs a lazy loading for `KFImage`. The image loading won't start until the view's
+    /// `onAppear` is called. However, sometimes you may want to trigger an aggressive loading for the view. By enabling
+    /// this, the `KFImage` will try to load the view when its `body` is evaluated when the image loading is not yet
+    /// started or a previous loading did fail.
+    ///
+    /// - Parameter flag: Whether the image loading should happen before view appear. Default is `true`.
+    /// - Returns: A `KFImage` with changes applied.
+    ///
+    /// - Note: This is a temporary workaround for an issue from iOS 16, where the SwiftUI view's `onAppear` is not
+    /// called when it is deeply embedded inside a `List` or `ForEach`.
+    /// See [#1988](https://github.com/onevcat/Kingfisher/issues/1988). It may cause performance regression, especially
+    /// if you have a lot of images to load in the view. Use it as your own risk.
+    ///
+    public func startLoadingBeforeViewAppear(_ flag: Bool = true) -> Self {
+        context.startLoadingBeforeViewAppear = flag
+        return self
+    }
+}
+#endif