KFImageProtocol.swift 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. //
  2. // KFImageProtocol.swift
  3. // Kingfisher
  4. //
  5. // Created by onevcat on 2021/05/08.
  6. //
  7. // Copyright (c) 2021 Wei Wang <onevcat@gmail.com>
  8. //
  9. // Permission is hereby granted, free of charge, to any person obtaining a copy
  10. // of this software and associated documentation files (the "Software"), to deal
  11. // in the Software without restriction, including without limitation the rights
  12. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13. // copies of the Software, and to permit persons to whom the Software is
  14. // furnished to do so, subject to the following conditions:
  15. //
  16. // The above copyright notice and this permission notice shall be included in
  17. // all copies or substantial portions of the Software.
  18. //
  19. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  25. // THE SOFTWARE.
  26. #if canImport(SwiftUI) && canImport(Combine)
  27. import SwiftUI
  28. import Combine
  29. @available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
  30. public protocol KFImageProtocol: View, KFOptionSetter {
  31. associatedtype HoldingView: KFImageHoldingView
  32. var context: KFImage.Context<HoldingView> { get set }
  33. init(context: KFImage.Context<HoldingView>)
  34. }
  35. @available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
  36. extension KFImageProtocol {
  37. public var body: some View {
  38. ZStack {
  39. KFImageRenderer<HoldingView>(
  40. context: context
  41. ).id(context)
  42. }
  43. }
  44. /// Creates a Kingfisher compatible image view to load image from the given `Source`.
  45. /// - Parameters:
  46. /// - source: The image `Source` defining where to load the target image.
  47. public init(source: Source?) {
  48. let context = KFImage.Context<HoldingView>(source: source)
  49. self.init(context: context)
  50. }
  51. /// Creates a Kingfisher compatible image view to load image from the given `URL`.
  52. /// - Parameters:
  53. /// - source: The image `Source` defining where to load the target image.
  54. public init(_ url: URL?) {
  55. self.init(source: url?.convertToSource())
  56. }
  57. /// Configures current image with a `block` and return another `Image` to use as the final content.
  58. ///
  59. /// This block will be lazily applied when creating the final `Image`.
  60. ///
  61. /// If multiple `configure` modifiers are added to the image, they will be evaluated by order. If you want to
  62. /// configure the input image (which is usually an `Image` value) to a non-`Image` value, use `contentConfigure`.
  63. ///
  64. /// - Parameter block: The block applies to loaded image. The block should return an `Image` that is configured.
  65. /// - Returns: A `KFImage` view that configures internal `Image` with `block`.
  66. public func configure(_ block: @escaping (HoldingView) -> HoldingView) -> Self {
  67. context.configurations.append(block)
  68. return self
  69. }
  70. /// Configures current image with a `block` and return a `View` to use as the final content.
  71. ///
  72. /// This block will be lazily applied when creating the final `Image`.
  73. ///
  74. /// If multiple `contentConfigure` modifiers are added to the image, only the last one will be stored and used.
  75. ///
  76. /// - Parameter block: The block applies to the loaded image. The block should return a `View` that is configured.
  77. /// - Returns: A `KFImage` view that configures internal `Image` with `block`.
  78. public func contentConfigure<V: View>(_ block: @escaping (HoldingView) -> V) -> Self {
  79. context.contentConfiguration = { AnyView(block($0)) }
  80. return self
  81. }
  82. }
  83. @available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
  84. public protocol KFImageHoldingView: View {
  85. associatedtype RenderingView
  86. static func created(from image: KFCrossPlatformImage?, context: KFImage.Context<Self>) -> Self
  87. }
  88. @available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
  89. extension KFImageProtocol {
  90. public var options: KingfisherParsedOptionsInfo {
  91. get { context.options }
  92. nonmutating set { context.options = newValue }
  93. }
  94. public var onFailureDelegate: Delegate<KingfisherError, Void> { context.onFailureDelegate }
  95. public var onSuccessDelegate: Delegate<RetrieveImageResult, Void> { context.onSuccessDelegate }
  96. public var onProgressDelegate: Delegate<(Int64, Int64), Void> { context.onProgressDelegate }
  97. public var delegateObserver: AnyObject { context }
  98. }
  99. #endif