Skip to content

Commit b512e31

Browse files
dreampiggydreampiggy
committed
Fix the issue sometime the WebImage appear/disappear logic wrong. Using UIKit/AppKit to detect the visibility
1 parent 5832951 commit b512e31

File tree

3 files changed

+114
-13
lines changed

3 files changed

+114
-13
lines changed

‎SDWebImageSwiftUI.xcodeproj/project.pbxproj‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,14 @@
7575
32C43E3322FD5DF400BE87F5 /* SDWebImageSwiftUI.swift in Sources */ = {isa = PBXBuildFile; fileRef = 32C43E3122FD5DE100BE87F5 /* SDWebImageSwiftUI.swift */; };
7676
32C43E3422FD5DF400BE87F5 /* SDWebImageSwiftUI.swift in Sources */ = {isa = PBXBuildFile; fileRef = 32C43E3122FD5DE100BE87F5 /* SDWebImageSwiftUI.swift */; };
7777
32C43E3522FD5DF400BE87F5 /* SDWebImageSwiftUI.swift in Sources */ = {isa = PBXBuildFile; fileRef = 32C43E3122FD5DE100BE87F5 /* SDWebImageSwiftUI.swift */; };
78+
32CBA78025E4D7D800C6A8DC /* ImagePlayer.swift in Sources */ = {isa = PBXBuildFile; fileRef = 32CBA77E25E4D7D800C6A8DC /* ImagePlayer.swift */; };
79+
32CBA78125E4D7D800C6A8DC /* ImagePlayer.swift in Sources */ = {isa = PBXBuildFile; fileRef = 32CBA77E25E4D7D800C6A8DC /* ImagePlayer.swift */; };
80+
32CBA78225E4D7D800C6A8DC /* ImagePlayer.swift in Sources */ = {isa = PBXBuildFile; fileRef = 32CBA77E25E4D7D800C6A8DC /* ImagePlayer.swift */; };
81+
32CBA78325E4D7D800C6A8DC /* ImagePlayer.swift in Sources */ = {isa = PBXBuildFile; fileRef = 32CBA77E25E4D7D800C6A8DC /* ImagePlayer.swift */; };
82+
32CBA78425E4D7D800C6A8DC /* SwiftUICompatibility.swift in Sources */ = {isa = PBXBuildFile; fileRef = 32CBA77F25E4D7D800C6A8DC /* SwiftUICompatibility.swift */; };
83+
32CBA78525E4D7D800C6A8DC /* SwiftUICompatibility.swift in Sources */ = {isa = PBXBuildFile; fileRef = 32CBA77F25E4D7D800C6A8DC /* SwiftUICompatibility.swift */; };
84+
32CBA78625E4D7D800C6A8DC /* SwiftUICompatibility.swift in Sources */ = {isa = PBXBuildFile; fileRef = 32CBA77F25E4D7D800C6A8DC /* SwiftUICompatibility.swift */; };
85+
32CBA78725E4D7D800C6A8DC /* SwiftUICompatibility.swift in Sources */ = {isa = PBXBuildFile; fileRef = 32CBA77F25E4D7D800C6A8DC /* SwiftUICompatibility.swift */; };
7886
32D26A022446B546005905DA /* Image.swift in Sources */ = {isa = PBXBuildFile; fileRef = 32D26A012446B546005905DA /* Image.swift */; };
7987
32D26A032446B546005905DA /* Image.swift in Sources */ = {isa = PBXBuildFile; fileRef = 32D26A012446B546005905DA /* Image.swift */; };
8088
32D26A042446B546005905DA /* Image.swift in Sources */ = {isa = PBXBuildFile; fileRef = 32D26A012446B546005905DA /* Image.swift */; };
@@ -137,6 +145,8 @@
137145
32C43E2922FD586200BE87F5 /* SDWebImage.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = SDWebImage.framework; path = Carthage/Build/tvOS/SDWebImage.framework; sourceTree = "<group>"; };
138146
32C43E2D22FD586E00BE87F5 /* SDWebImage.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = SDWebImage.framework; path = Carthage/Build/watchOS/SDWebImage.framework; sourceTree = "<group>"; };
139147
32C43E3122FD5DE100BE87F5 /* SDWebImageSwiftUI.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SDWebImageSwiftUI.swift; sourceTree = "<group>"; };
148+
32CBA77E25E4D7D800C6A8DC /* ImagePlayer.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ImagePlayer.swift; sourceTree = "<group>"; };
149+
32CBA77F25E4D7D800C6A8DC /* SwiftUICompatibility.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SwiftUICompatibility.swift; sourceTree = "<group>"; };
140150
32D26A012446B546005905DA /* Image.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Image.swift; sourceTree = "<group>"; };
141151
32ED4825242A13030053338E /* ImageManagerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ImageManagerTests.swift; sourceTree = "<group>"; };
142152
/* End PBXFileReference section */
@@ -279,6 +289,8 @@
279289
32B933E323659A0700BB7CAD /* Transition */,
280290
326099472362E09E006EBB22 /* Indicator */,
281291
32C43DDC22FD54C600BE87F5 /* ImageManager.swift */,
292+
32CBA77E25E4D7D800C6A8DC /* ImagePlayer.swift */,
293+
32CBA77F25E4D7D800C6A8DC /* SwiftUICompatibility.swift */,
282294
32C43DDE22FD54C600BE87F5 /* WebImage.swift */,
283295
32C43DDF22FD54C600BE87F5 /* AnimatedImage.swift */,
284296
32C43E3122FD5DE100BE87F5 /* SDWebImageSwiftUI.swift */,
@@ -696,6 +708,8 @@
696708
buildActionMask = 2147483647;
697709
files = (
698710
32B933E523659A1900BB7CAD /* Transition.swift in Sources */,
711+
32CBA78025E4D7D800C6A8DC /* ImagePlayer.swift in Sources */,
712+
32CBA78425E4D7D800C6A8DC /* SwiftUICompatibility.swift in Sources */,
699713
32C43E1722FD583700BE87F5 /* WebImage.swift in Sources */,
700714
326B848C236335400011BDFB /* ProgressIndicator.swift in Sources */,
701715
326B84822363350C0011BDFB /* Indicator.swift in Sources */,
@@ -713,6 +727,8 @@
713727
buildActionMask = 2147483647;
714728
files = (
715729
32B933E623659A1900BB7CAD /* Transition.swift in Sources */,
730+
32CBA78125E4D7D800C6A8DC /* ImagePlayer.swift in Sources */,
731+
32CBA78525E4D7D800C6A8DC /* SwiftUICompatibility.swift in Sources */,
716732
32C43E1A22FD583700BE87F5 /* WebImage.swift in Sources */,
717733
326B848D236335400011BDFB /* ProgressIndicator.swift in Sources */,
718734
326B84832363350C0011BDFB /* Indicator.swift in Sources */,
@@ -730,6 +746,8 @@
730746
buildActionMask = 2147483647;
731747
files = (
732748
32B933E723659A1900BB7CAD /* Transition.swift in Sources */,
749+
32CBA78225E4D7D800C6A8DC /* ImagePlayer.swift in Sources */,
750+
32CBA78625E4D7D800C6A8DC /* SwiftUICompatibility.swift in Sources */,
733751
32C43E1D22FD583800BE87F5 /* WebImage.swift in Sources */,
734752
326B848E236335400011BDFB /* ProgressIndicator.swift in Sources */,
735753
326B84842363350C0011BDFB /* Indicator.swift in Sources */,
@@ -747,6 +765,8 @@
747765
buildActionMask = 2147483647;
748766
files = (
749767
32B933E823659A1900BB7CAD /* Transition.swift in Sources */,
768+
32CBA78325E4D7D800C6A8DC /* ImagePlayer.swift in Sources */,
769+
32CBA78725E4D7D800C6A8DC /* SwiftUICompatibility.swift in Sources */,
750770
32C43E2022FD583800BE87F5 /* WebImage.swift in Sources */,
751771
326B848F236335400011BDFB /* ProgressIndicator.swift in Sources */,
752772
326B84852363350C0011BDFB /* Indicator.swift in Sources */,

‎SDWebImageSwiftUI/Classes/SwiftUICompatibility.swift‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
/*
2+
* This file is part of the SDWebImage package.
3+
* (c) DreamPiggy <lizhuoli1126@126.com>
4+
*
5+
* For the full copyright and license information, please view the LICENSE
6+
* file that was distributed with this source code.
7+
*/
8+
9+
import Foundation
10+
import SwiftUI
11+
12+
#if os(iOS) || os(tvOS) || os(macOS)
13+
14+
@available(iOS 13.0, OSX 10.15, tvOS 13.0, watchOS 6.0, *)
15+
struct PlatformAppear: PlatformViewRepresentable {
16+
let appearAction: () -> Void
17+
let disappearAction: () -> Void
18+
19+
#if os(iOS) || os(tvOS)
20+
func makeUIView(context: Context) -> some UIView {
21+
let view = PlatformAppearView()
22+
view.appearAction = appearAction
23+
view.disappearAction = disappearAction
24+
return view
25+
}
26+
27+
func updateUIView(_ uiView: UIViewType, context: Context) {}
28+
#endif
29+
#if os(macOS)
30+
func makeNSView(context: Context) -> some NSView {
31+
let view = PlatformAppearView()
32+
view.appearAction = appearAction
33+
view.disappearAction = disappearAction
34+
return view
35+
}
36+
37+
func updateNSView(_ nsView: NSViewType, context: Context) {}
38+
#endif
39+
}
40+
41+
@available(iOS 13.0, OSX 10.15, tvOS 13.0, watchOS 6.0, *)
42+
class PlatformAppearView: PlatformView {
43+
var appearAction: () -> Void = {}
44+
var disappearAction: () -> Void = {}
45+
46+
#if os(iOS) || os(tvOS)
47+
override func willMove(toWindow newWindow: UIWindow?) {
48+
if newWindow != nil {
49+
appearAction()
50+
} else {
51+
disappearAction()
52+
}
53+
}
54+
#endif
55+
56+
#if os(macOS)
57+
override func viewWillMove(toWindow newWindow: NSWindow?) {
58+
if newWindow != nil {
59+
appearAction()
60+
} else {
61+
disappearAction()
62+
}
63+
}
64+
#endif
65+
}
66+
67+
#endif
68+
69+
extension View {
70+
/// Used UIKit/AppKit behavior to detect the SwiftUI view's visibility.
71+
/// This hack is because of SwiftUI 1.0/2.0 buggy behavior. The built-in `onAppear` and `onDisappear` is so massive on some cases. Where UIKit/AppKit is solid.
72+
/// - Parameters:
73+
/// - appear: The action when view appears
74+
/// - disappear: The action when view disappears
75+
/// - Returns: Some view
76+
func onPlatformAppear(appear: @escaping () -> Void = {}, disappear: @escaping () -> Void = {}) -> some View {
77+
#if os(iOS) || os(tvOS) || os(macOS)
78+
return self.background(PlatformAppear(appearAction: appear, disappearAction: disappear))
79+
#else
80+
return self.onAppear(perform: appear).onDisappear(perform: disappear)
81+
#endif
82+
}
83+
}

‎SDWebImageSwiftUI/Classes/WebImage.swift‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -65,23 +65,22 @@ public struct WebImage : View {
6565
if isAnimating && !imageManager.isIncremental {
6666
if imagePlayer.currentFrame != nil {
6767
configure(image: imagePlayer.currentFrame!)
68-
.onAppear {
69-
imagePlayer.startPlaying()
70-
}
71-
.onDisappear {
68+
.onPlatformAppear(appear: {
69+
self.imagePlayer.startPlaying()
70+
}, disappear: {
7271
if self.pausable {
73-
imagePlayer.pausePlaying()
72+
self.imagePlayer.pausePlaying()
7473
} else {
75-
imagePlayer.stopPlaying()
74+
self.imagePlayer.stopPlaying()
7675
}
7776
if self.purgeable {
78-
imagePlayer.clearFrameBuffer()
77+
self.imagePlayer.clearFrameBuffer()
7978
}
80-
}
79+
})
8180
} else {
8281
configure(image: imageManager.image!)
8382
.onReceive(imageManager.$image) { image in
84-
imagePlayer.setupPlayer(image: image)
83+
self.imagePlayer.setupPlayer(image: image)
8584
}
8685
}
8786
} else {
@@ -94,7 +93,7 @@ public struct WebImage : View {
9493
} else {
9594
setupPlaceholder()
9695
.frame(minWidth: 0, maxWidth: .infinity, minHeight: 0, maxHeight: .infinity)
97-
.onAppear {
96+
.onPlatformAppear(appear: {
9897
// Load remote image when first appear
9998
if self.imageManager.isFirstLoad {
10099
self.imageManager.load()
@@ -105,14 +104,13 @@ public struct WebImage : View {
105104
if self.imageManager.image == nil && !self.imageManager.isIncremental {
106105
self.imageManager.load()
107106
}
108-
}
109-
.onDisappear {
107+
}, disappear: {
110108
guard self.cancelOnDisappear else { return }
111109
// When using prorgessive loading, the previous partial image will cause onDisappear. Filter this case
112110
if self.imageManager.image == nil && !self.imageManager.isIncremental {
113111
self.imageManager.cancel()
114112
}
115-
}
113+
})
116114
}
117115
}
118116
}

0 commit comments

Comments
 (0)