Merge branch 'SDWebImage:master' into master

Author: WendellXY

CHANGELOG.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.1.0] - 2024-06-27
+- Re-implements the aspectRatio support on AnimatedImage, fix issue like cornerRadius #324
+- Add Image scale support in WebImage init #323
+- Update platform names in `available` attributes #321
+- - This is source compatible but binary incompatible version
+
 ## [3.0.4] - 2024-04-30
 - Trying to move the initial state setup before onAppear to fix the watchOS switching url or any other state issue #316
 - This solve a issue in history when sometimes SwiftUI does not trigger the `onAppear` and cause state error, like #312 #314

Example/SDWebImageSwiftUIDemo/ContentView.swift

@@ -17,6 +17,19 @@ class UserSettings: ObservableObject {
  #endif
 }
 
+#if !os(watchOS)
+struct ContentView4: View {
+ var url = URL(string: "https://github.com/SDWebImage/SDWebImageSwiftUI/assets/97430818/72d27f90-e9d8-48d7-b144-82ada828a027")!
+ var body: some View {
+ AnimatedImage(url: url)
+ .resizable()
+ .scaledToFit()
+// .aspectRatio(nil, contentMode: .fit)
+ .clipShape(RoundedRectangle(cornerRadius: 50, style: .continuous))
+ }
+}
+#endif
+
 // Test Switching nil url
 struct ContentView3: View {
  @State var isOn = false

README.md

@@ -117,7 +117,7 @@ For downstream framework author, you should create a `Package.swift` file into y
 ```swift
 let package = Package(
  dependencies: [
- .package(url: "https://github.com/SDWebImage/SDWebImageSwiftUI.git", from: "2.0.0")
+ .package(url: "https://github.com/SDWebImage/SDWebImageSwiftUI.git", from: "3.0.0")
  ],
 )
 ```
@@ -655,7 +655,7 @@ class ViewController: UIViewController {
 }
 
 // ContentView.swift
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 struct ContentView : View {
  var body: some View {
  Group {

SDWebImageSwiftUI.podspec

@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
  s.name = 'SDWebImageSwiftUI'
- s.version = '3.0.4'
+ s.version = '3.1.0'
  s.summary = 'SwiftUI Image loading and Animation framework powered by SDWebImage'
 
  s.description = <<-DESC

SDWebImageSwiftUI/Classes/AnimatedImage.swift

@@ -12,7 +12,7 @@ import SDWebImage
 #if !os(watchOS)
 
 /// A coordinator object used for `AnimatedImage`native view bridge for UIKit/AppKit.
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 public final class AnimatedImageCoordinator: NSObject {
 
  /// Any user-provided object for actual coordinator, such as delegate method, taget-action
@@ -25,7 +25,7 @@ public final class AnimatedImageCoordinator: NSObject {
 }
 
 /// Data Binding Object, only properties in this object can support changes from user with @State and refresh
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 final class AnimatedImageModel : ObservableObject {
  enum Kind {
  case url
@@ -53,7 +53,7 @@ final class AnimatedImageModel : ObservableObject {
 }
 
 /// Loading Binding Object, only properties in this object can support changes from user with @State and refresh
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 final class AnimatedLoadingModel : ObservableObject {
  @Published var image: PlatformImage? // loaded image, note when progressive loading, this will published multiple times with different partial image
  @Published var isLoading: Bool = false // whether network is loading or cache is querying, should only be used for indicator binding
@@ -66,7 +66,7 @@ final class AnimatedLoadingModel : ObservableObject {
 }
 
 /// Completion Handler Binding Object, supports dynamic @State changes
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 final class AnimatedImageHandler: ObservableObject {
  // Completion Handler
  @Published var successBlock: ((PlatformImage, Data?, SDImageCacheType) -> Void)?
@@ -78,7 +78,7 @@ final class AnimatedImageHandler: ObservableObject {
 }
 
 /// Layout Binding Object, supports dynamic @State changes
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 final class AnimatedImageLayout : ObservableObject {
  var contentMode: ContentMode?
  var aspectRatio: CGFloat?
@@ -90,7 +90,7 @@ final class AnimatedImageLayout : ObservableObject {
 }
 
 /// Configuration Binding Object, supports dynamic @State changes
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 final class AnimatedImageConfiguration: ObservableObject {
  var incrementalLoad: Bool?
  var maxBufferSize: UInt?
@@ -106,7 +106,7 @@ final class AnimatedImageConfiguration: ObservableObject {
 }
 
 /// A Image View type to load image from url, data or bundle. Supports animated and static image format.
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 public struct AnimatedImage : PlatformViewRepresentable {
  @ObservedObject var imageModel: AnimatedImageModel
  @ObservedObject var imageHandler = AnimatedImageHandler()
@@ -275,6 +275,8 @@ public struct AnimatedImage : PlatformViewRepresentable {
  self.imageModel.placeholderView?.isHidden = false
  self.imageHandler.failureBlock?(error ?? NSError())
  }
+ // Finished loading, async
+ finishUpdateView(view, context: context, image: image)
  }
  }
 
@@ -361,22 +363,9 @@ public struct AnimatedImage : PlatformViewRepresentable {
  break // impossible
  }
 
- #if os(macOS)
- if self.isAnimating != view.wrapped.animates {
- view.wrapped.animates = self.isAnimating
- }
- #else
- if self.isAnimating != view.wrapped.isAnimating {
- if self.isAnimating {
- view.wrapped.startAnimating()
- } else {
- view.wrapped.stopAnimating()
- }
- }
- #endif
+ // Finished loading, sync
+ finishUpdateView(view, context: context, image: view.wrapped.image)
 
- configureView(view, context: context)
- layoutView(view, context: context)
  if let viewUpdateBlock = imageHandler.viewUpdateBlock {
  viewUpdateBlock(view.wrapped, context)
  }
@@ -394,6 +383,17 @@ public struct AnimatedImage : PlatformViewRepresentable {
  }
  }
 
+ func finishUpdateView(_ view: AnimatedImageViewWrapper, context: Context, image: PlatformImage?) {
+ // Finished loading
+ if let imageSize = image?.size {
+ view.imageSize = imageSize
+ } else {
+ view.imageSize = nil
+ }
+ configureView(view, context: context)
+ layoutView(view, context: context)
+ }
+ 
  func layoutView(_ view: AnimatedImageViewWrapper, context: Context) {
  // AspectRatio && ContentMode
  #if os(macOS)
@@ -442,9 +442,7 @@ public struct AnimatedImage : PlatformViewRepresentable {
  #endif
 
  // Resizable
- if let _ = imageLayout.resizingMode {
- view.resizable = true
- }
+ view.resizingMode = imageLayout.resizingMode
 
  // Animated Image does not support resizing mode and rendering mode
  if let image = view.wrapped.image {
@@ -587,11 +585,26 @@ public struct AnimatedImage : PlatformViewRepresentable {
  } else {
  view.wrapped.playbackMode = .normal
  }
+ 
+ // Animation
+ #if os(macOS)
+ if self.isAnimating != view.wrapped.animates {
+ view.wrapped.animates = self.isAnimating
+ }
+ #else
+ if self.isAnimating != view.wrapped.isAnimating {
+ if self.isAnimating {
+ view.wrapped.startAnimating()
+ } else {
+ view.wrapped.stopAnimating()
+ }
+ }
+ #endif
  }
 }
 
 // Layout
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 extension AnimatedImage {
 
  /// Configurate this view's image with the specified cap insets and options.
@@ -630,70 +643,8 @@ extension AnimatedImage {
  }
 }
 
-// Aspect Ratio
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
-extension AnimatedImage {
- func setImageLayoutAspectRatio(_ aspectRatio: CGFloat?, contentMode: ContentMode) {
- self.imageLayout.aspectRatio = aspectRatio
- self.imageLayout.contentMode = contentMode
- }
-
- /// Constrains this view's dimensions to the specified aspect ratio.
- /// - Parameters:
- /// - aspectRatio: The ratio of width to height to use for the resulting
- /// view. If `aspectRatio` is `nil`, the resulting view maintains this
- /// view's aspect ratio.
- /// - contentMode: A flag indicating whether this view should fit or
- /// fill the parent context.
- /// - Returns: A view that constrains this view's dimensions to
- /// `aspectRatio`, using `contentMode` as its scaling algorithm.
- @ViewBuilder
- public func aspectRatio(_ aspectRatio: CGFloat? = nil, contentMode: ContentMode) -> some View {
- // The `SwifUI.View.aspectRatio(_:contentMode:)` says:
- // If `aspectRatio` is `nil`, the resulting view maintains this view's aspect ratio
- // But 1: there are no public API to declare what `this view's aspect ratio` is
- // So, if we don't override this method, SwiftUI ignore the content mode on actual ImageView
- // To workaround, we want to call the default `SwifUI.View.aspectRatio(_:contentMode:)` method
- // But 2: there are no way to call a Protocol Extention default implementation in Swift 5.1
- // So, we directly call the implementation detail modifier instead
- // Fired Radar: FB7413534
- let _ = self.setImageLayoutAspectRatio(aspectRatio, contentMode: contentMode)
- if let aspectRatio {
- self.modifier(_AspectRatioLayout(aspectRatio: aspectRatio, contentMode: contentMode))
- } else {
- self
- }
- }
-
- /// Constrains this view's dimensions to the aspect ratio of the given size.
- /// - Parameters:
- /// - aspectRatio: A size specifying the ratio of width to height to use
- /// for the resulting view.
- /// - contentMode: A flag indicating whether this view should fit or
- /// fill the parent context.
- /// - Returns: A view that constrains this view's dimensions to
- /// `aspectRatio`, using `contentMode` as its scaling algorithm.
- public func aspectRatio(_ aspectRatio: CGSize, contentMode: ContentMode) -> some View {
- return self.aspectRatio(aspectRatio.width / aspectRatio.height, contentMode: contentMode)
- }
-
- /// Scales this view to fit its parent.
- /// - Returns: A view that scales this view to fit its parent,
- /// maintaining this view's aspect ratio.
- public func scaledToFit() -> some View {
- return self.aspectRatio(nil, contentMode: .fit)
- }
- 
- /// Scales this view to fill its parent.
- /// - Returns: A view that scales this view to fit its parent,
- /// maintaining this view's aspect ratio.
- public func scaledToFill() -> some View {
- return self.aspectRatio(nil, contentMode: .fill)
- }
-}
-
 // AnimatedImage Modifier
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 extension AnimatedImage {
 
  /// Total loop count for animated image rendering. Defaults to nil.
@@ -770,7 +721,7 @@ extension AnimatedImage {
 }
 
 // Completion Handler
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 extension AnimatedImage {
 
  /// Provide the action when image load fails.
@@ -802,7 +753,7 @@ extension AnimatedImage {
 }
 
 // View Coordinator Handler
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 extension AnimatedImage {
 
  /// Provide the action when view representable create the native view.
@@ -839,7 +790,7 @@ extension SDWebImageIndicator where Self == SDWebImageProgressIndicator {
 }
 
 // Web Image convenience, based on UIKit/AppKit API
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 extension AnimatedImage {
 
  /// Associate a indicator when loading image with url
@@ -860,7 +811,7 @@ extension AnimatedImage {
 }
 
 #if DEBUG
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 struct AnimatedImage_Previews : PreviewProvider {
  static var previews: some View {
  Group {

SDWebImageSwiftUI/Classes/Image.swift

@@ -9,7 +9,7 @@
 import Foundation
 import SwiftUI
 
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 extension Image {
  @inlinable init(platformImage: PlatformImage) {
  #if os(macOS)
@@ -20,13 +20,13 @@ extension Image {
  }
 }
 
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 extension PlatformImage {
  static var empty = PlatformImage()
 }
 
 #if !os(macOS)
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 extension PlatformImage.Orientation {
  @inlinable var toSwiftUI: Image.Orientation {
  switch self {
@@ -52,7 +52,7 @@ extension PlatformImage.Orientation {
  }
 }
 
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 extension Image.Orientation {
  @inlinable var toPlatform: PlatformImage.Orientation {
  switch self {

SDWebImageSwiftUI/Classes/ImageManager.swift

@@ -12,7 +12,7 @@ import SDWebImage
 
 /// A Image observable object for handle image load process. This drive the Source of Truth for image loading status.
 /// You can use `@ObservedObject` to associate each instance of manager to your View type, which update your view's body from SwiftUI framework when image was loaded.
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 public final class ImageManager : ObservableObject {
  /// loaded image, note when progressive loading, this will published multiple times with different partial image
  public var image: PlatformImage? {
@@ -136,7 +136,7 @@ public final class ImageManager : ObservableObject {
 }
 
 // Completion Handler
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 extension ImageManager {
  /// Provide the action when image load fails.
  /// - Parameters:

SDWebImageSwiftUI/Classes/ImagePlayer.swift

@@ -11,7 +11,7 @@ import Combine
 import SDWebImage
 
 /// A Image observable object for handle aniamted image playback. This is used to avoid `@State` update may capture the View struct type and cause memory leak.
-@available(iOS 14.0, OSX 11.0, tvOS 14.0, watchOS 7.0, *)
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
 public final class ImagePlayer : ObservableObject {
  var player: SDAnimatedImagePlayer?