KFImageRenderer.swift 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. //
  2. // KFImageRenderer.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. /// A Kingfisher compatible SwiftUI `View` to load an image from a `Source`.
  30. /// Declaring a `KFImage` in a `View`'s body to trigger loading from the given `Source`.
  31. @available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
  32. struct KFImageRenderer<HoldingView> : View where HoldingView: KFImageHoldingView {
  33. @StateObject var binder: KFImage.ImageBinder = .init()
  34. let context: KFImage.Context<HoldingView>
  35. var body: some View {
  36. if context.startLoadingBeforeViewAppear && !binder.loadingOrSucceeded && !binder.animating {
  37. binder.markLoading()
  38. DispatchQueue.main.async { binder.start(context: context) }
  39. }
  40. return ZStack {
  41. renderedImage().opacity(binder.loaded ? 1.0 : 0.0)
  42. if binder.loadedImage == nil {
  43. ZStack {
  44. if let placeholder = context.placeholder {
  45. placeholder(binder.progress)
  46. } else {
  47. Color.clear
  48. }
  49. }
  50. .onAppear { [weak binder = self.binder] in
  51. guard let binder = binder else {
  52. return
  53. }
  54. if !binder.loadingOrSucceeded {
  55. binder.start(context: context)
  56. }
  57. }
  58. .onDisappear { [weak binder = self.binder] in
  59. guard let binder = binder else {
  60. return
  61. }
  62. if context.cancelOnDisappear {
  63. binder.cancel()
  64. }
  65. }
  66. }
  67. }
  68. // Workaround for https://github.com/onevcat/Kingfisher/issues/1988
  69. // on iOS 16 there seems to be a bug that when in a List, the `onAppear` of the `ZStack` above in the
  70. // `binder.loadedImage == nil` not get called. Adding this empty `onAppear` fixes it and the life cycle can
  71. // work again.
  72. //
  73. // There is another "fix": adding an `else` clause and put a `Color.clear` there. But I believe this `onAppear`
  74. // should work better.
  75. //
  76. // It should be a bug in iOS 16, I guess it is some kinds of over-optimization in list cell loading caused it.
  77. .onAppear()
  78. }
  79. @ViewBuilder
  80. private func renderedImage() -> some View {
  81. let configuredImage = context.configurations
  82. .reduce(HoldingView.created(from: binder.loadedImage, context: context)) {
  83. current, config in config(current)
  84. }
  85. if let contentConfiguration = context.contentConfiguration {
  86. contentConfiguration(configuredImage)
  87. } else {
  88. configuredImage
  89. }
  90. }
  91. }
  92. @available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
  93. extension Image {
  94. // Creates an Image with either UIImage or NSImage.
  95. init(crossPlatformImage: KFCrossPlatformImage?) {
  96. #if canImport(UIKit)
  97. self.init(uiImage: crossPlatformImage ?? KFCrossPlatformImage())
  98. #elseif canImport(AppKit)
  99. self.init(nsImage: crossPlatformImage ?? KFCrossPlatformImage())
  100. #endif
  101. }
  102. }
  103. #if canImport(UIKit)
  104. @available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
  105. extension UIImage.Orientation {
  106. func toSwiftUI() -> Image.Orientation {
  107. switch self {
  108. case .down: return .down
  109. case .up: return .up
  110. case .left: return .left
  111. case .right: return .right
  112. case .upMirrored: return .upMirrored
  113. case .downMirrored: return .downMirrored
  114. case .leftMirrored: return .leftMirrored
  115. case .rightMirrored: return .rightMirrored
  116. @unknown default: return .up
  117. }
  118. }
  119. }
  120. #endif
  121. #endif