// // KFImage.swift // Kingfisher // // Created by onevcat on 2019/06/26. // // Copyright (c) 2019 Wei Wang // // 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 Combine import SwiftUI @available(iOS 13.0, OSX 10.15, tvOS 13.0, watchOS 6.0, *) public struct KFImage: KFImageProtocol { public typealias HoldingView = Image public internal (set) var context: Context /// Creates a Kingfisher compatible image view to load image from the given `Source`. /// - Parameters: /// - source: The image `Source` defining where to load the target image. /// - isLoaded: Whether the image is loaded or not. This provides a way to inspect the internal loading /// state. `true` if the image is loaded successfully. Otherwise, `false`. Do not set the /// wrapped value from outside. public init(source: Source?, isLoaded: Binding = .constant(false)) { let binder = ImageBinder(source: source, isLoaded: isLoaded) self.init(binder: binder) } /// Creates a Kingfisher compatible image view to load image from the given `URL`. /// - Parameters: /// - source: The image `Source` defining where to load the target image. /// - isLoaded: Whether the image is loaded or not. This provides a way to inspect the internal loading /// state. `true` if the image is loaded successfully. Otherwise, `false`. Do not set the /// wrapped value from outside. public init(_ url: URL?, isLoaded: Binding = .constant(false)) { self.init(source: url?.convertToSource(), isLoaded: isLoaded) } init(binder: ImageBinder) { self.context = Context(binder: binder) } } @available(iOS 13.0, OSX 10.15, tvOS 13.0, watchOS 6.0, *) extension KFImage { public struct Context { var binder: ImageBinder var configurations: [(HoldingView) -> HoldingView] = [] var cancelOnDisappear: Bool = false var placeholder: AnyView? = nil init(binder: ImageBinder) { self.binder = binder } } } // MARK: - Image compatibility. @available(iOS 13.0, OSX 10.15, tvOS 13.0, watchOS 6.0, *) extension KFImage { /// Configures current image with a `block`. This block will be lazily applied when creating the final `Image`. /// - Parameter block: The block applies to loaded image. /// - Returns: A `KFImage` view that configures internal `Image` with `block`. public func configure(_ block: @escaping (Image) -> Image) -> KFImage { var result = self result.context.configurations.append(block) return result } public func resizable( capInsets: EdgeInsets = EdgeInsets(), resizingMode: Image.ResizingMode = .stretch) -> KFImage { configure { $0.resizable(capInsets: capInsets, resizingMode: resizingMode) } } public func renderingMode(_ renderingMode: Image.TemplateRenderingMode?) -> KFImage { configure { $0.renderingMode(renderingMode) } } public func interpolation(_ interpolation: Image.Interpolation) -> KFImage { configure { $0.interpolation(interpolation) } } public func antialiased(_ isAntialiased: Bool) -> KFImage { configure { $0.antialiased(isAntialiased) } } } // MARK: - Deprecated @available(iOS 13.0, OSX 10.15, tvOS 13.0, watchOS 6.0, *) extension KFImage { /// Creates a Kingfisher compatible image view to load image from the given `Source`. /// - Parameter source: The image `Source` defining where to load the target image. /// - Parameter options: The options should be applied when loading the image. /// Some UIKit related options (such as `ImageTransition.flip`) are not supported. /// - Parameter isLoaded: Whether the image is loaded or not. This provides a way to inspect the internal loading /// state. `true` if the image is loaded successfully. Otherwise, `false`. Do not set the /// wrapped value from outside. /// - Deprecated: Some options are not available in SwiftUI yet. Use `KFImage(source:isLoaded:)` to create a /// `KFImage` and configure the options through modifier instead. See methods of `KFOptionSetter` /// for more. @available(*, deprecated, message: "Some options are not available in SwiftUI yet. Use `KFImage(source:isLoaded:)` to create a `KFImage` and configure the options through modifier instead.") public init(source: Source?, options: KingfisherOptionsInfo? = nil, isLoaded: Binding = .constant(false)) { let binder = KFImage.ImageBinder(source: source, options: options, isLoaded: isLoaded) self.init(binder: binder) } /// Creates a Kingfisher compatible image view to load image from the given `URL`. /// - Parameter url: The image URL from where to load the target image. /// - Parameter options: The options should be applied when loading the image. /// Some UIKit related options (such as `ImageTransition.flip`) are not supported. /// - Parameter isLoaded: Whether the image is loaded or not. This provides a way to inspect the internal loading /// state. `true` if the image is loaded successfully. Otherwise, `false`. Do not set the /// wrapped value from outside. /// - Deprecated: Some options are not available in SwiftUI yet. Use `KFImage(_:isLoaded:)` to create a /// `KFImage` and configure the options through modifier instead. See methods of `KFOptionSetter` /// for more. @available(*, deprecated, message: "Some options are not available in SwiftUI yet. Use `KFImage(_:isLoaded:)` to create a `KFImage` and configure the options through modifier instead.") init(_ url: URL?, options: KingfisherOptionsInfo? = nil, isLoaded: Binding = .constant(false)) { self.init(source: url?.convertToSource(), options: options, isLoaded: isLoaded) } } #if DEBUG @available(iOS 13.0, OSX 10.15, tvOS 13.0, watchOS 6.0, *) struct KFImage_Previews : PreviewProvider { static var previews: some View { Group { KFImage(source: .network(URL(string: "https://raw.githubusercontent.com/onevcat/Kingfisher/master/images/logo.png")!)) .onSuccess { r in print(r) } .resizable() .aspectRatio(contentMode: .fit) .padding() } } } #endif #endif