2
0

KFImageProtocol.swift 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  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. KFImageRenderer<HoldingView>(context: context)
  39. .id(context)
  40. }
  41. /// Creates a Kingfisher compatible image view to load image from the given `Source`.
  42. /// - Parameters:
  43. /// - source: The image `Source` defining where to load the target image.
  44. public init(source: Source?) {
  45. let context = KFImage.Context<HoldingView>(source: source)
  46. self.init(context: context)
  47. }
  48. /// Creates a Kingfisher compatible image view to load image from the given `URL`.
  49. /// - Parameters:
  50. /// - source: The image `Source` defining where to load the target image.
  51. public init(_ url: URL?) {
  52. self.init(source: url?.convertToSource())
  53. }
  54. /// Configures current image with a `block`. This block will be lazily applied when creating the final `Image`.
  55. /// - Parameter block: The block applies to loaded image.
  56. /// - Returns: A `KFImage` view that configures internal `Image` with `block`.
  57. public func configure(_ block: @escaping (HoldingView) -> HoldingView) -> Self {
  58. context.configurations.append(block)
  59. return self
  60. }
  61. }
  62. @available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
  63. public protocol KFImageHoldingView: View {
  64. static func created(from image: KFCrossPlatformImage) -> Self
  65. }
  66. @available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
  67. extension KFImageProtocol {
  68. public var options: KingfisherParsedOptionsInfo {
  69. get { context.options }
  70. nonmutating set { context.options = newValue }
  71. }
  72. public var onFailureDelegate: Delegate<KingfisherError, Void> { context.onFailureDelegate }
  73. public var onSuccessDelegate: Delegate<RetrieveImageResult, Void> { context.onSuccessDelegate }
  74. public var onProgressDelegate: Delegate<(Int64, Int64), Void> { context.onProgressDelegate }
  75. public var delegateObserver: AnyObject { context }
  76. }
  77. #endif