KFImage.swift 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. //
  2. // KFImage.swift
  3. // Kingfisher
  4. //
  5. // Created by onevcat on 2019/06/26.
  6. //
  7. // Copyright (c) 2019 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 struct KFImage: KFImageProtocol {
  31. public var context: Context<Image>
  32. public init(context: Context<Image>) {
  33. self.context = context
  34. }
  35. }
  36. @available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
  37. extension Image: KFImageHoldingView {
  38. public typealias RenderingView = Image
  39. public static func created(from image: KFCrossPlatformImage?, context: KFImage.Context<Self>) -> Image {
  40. Image(crossPlatformImage: image)
  41. }
  42. }
  43. // MARK: - Image compatibility.
  44. @available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
  45. extension KFImage {
  46. public func resizable(
  47. capInsets: EdgeInsets = EdgeInsets(),
  48. resizingMode: Image.ResizingMode = .stretch) -> KFImage
  49. {
  50. configure { $0.resizable(capInsets: capInsets, resizingMode: resizingMode) }
  51. }
  52. public func renderingMode(_ renderingMode: Image.TemplateRenderingMode?) -> KFImage {
  53. configure { $0.renderingMode(renderingMode) }
  54. }
  55. public func interpolation(_ interpolation: Image.Interpolation) -> KFImage {
  56. configure { $0.interpolation(interpolation) }
  57. }
  58. public func antialiased(_ isAntialiased: Bool) -> KFImage {
  59. configure { $0.antialiased(isAntialiased) }
  60. }
  61. /// Starts the loading process of `self` immediately.
  62. ///
  63. /// By default, a `KFImage` will not load its source until the `onAppear` is called. This is a lazily loading
  64. /// behavior and provides better performance. However, when you refresh the view, the lazy loading also causes a
  65. /// flickering since the loading does not happen immediately. Call this method if you want to start the load at once
  66. /// could help avoiding the flickering, with some performance trade-off.
  67. ///
  68. /// - Deprecated: This is not necessary anymore since `@StateObject` is used for holding the image data.
  69. /// It does nothing now and please just remove it.
  70. ///
  71. /// - Returns: The `Self` value with changes applied.
  72. @available(*, deprecated, message: "This is not necessary anymore since `@StateObject` is used. It does nothing now and please just remove it.")
  73. public func loadImmediately(_ start: Bool = true) -> KFImage {
  74. return self
  75. }
  76. }
  77. #if DEBUG
  78. @available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
  79. struct KFImage_Previews: PreviewProvider {
  80. static var previews: some View {
  81. Group {
  82. KFImage.url(URL(string: "https://raw.githubusercontent.com/onevcat/Kingfisher/master/images/logo.png")!)
  83. .onSuccess { r in
  84. print(r)
  85. }
  86. .placeholder { p in
  87. ProgressView(p)
  88. }
  89. .resizable()
  90. .aspectRatio(contentMode: .fit)
  91. .padding()
  92. }
  93. }
  94. }
  95. #endif
  96. #endif