Skip to content

Distinguish the triggering objects of lifecycle callbacks #276

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rakuyoMo wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Distinguish the triggering objects of lifecycle callbacks #276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d951e2e
Distinguish the triggering objects of lifecycle callbacks
rakuyoMo Jan 8, 2025
06ce3ac
Update document
rakuyoMo Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions Document/列表的生命周期方法处理.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

```Swift
/// 可选实现，列表将要显示的时候调用
@objc optional func listWillAppear()
@objc optional func listWillAppear(isSystemTrigger: Bool)
/// 可选实现，列表显示的时候调用
@objc optional func listDidAppear()
@objc optional func listDidAppear(isSystemTrigger: Bool)
/// 可选实现，列表将要消失的时候调用
@objc optional func listWillDisappear()
@objc optional func listWillDisappear(isSystemTrigger: Bool)
/// 可选实现，列表消失的时候调用
@objc optional func listDidDisappear()
@objc optional func listDidDisappear(isSystemTrigger: Bool)
```


Expand All @@ -32,5 +32,8 @@ override func viewDidDisappear(_ animated: Bool)
```
都会按照【列表的生命周期触发时机】说明中的顺序触发。但是自定义的`listWillAppear`等生命周期方法也会调用，所以，如果列表是UIViewController类，只依赖于系统的生命周期方法即可。如果列表是UIView类，就依赖于自定义的生命周期方法即可。

## `isSystemTrigger`

针对需要 “滑动回调” 的场景，可使用 `isSystemTrigger` 参数判断是系统生命周期触发，还是非系统生命周期（比如滑动）触发。

> 比如您仅希望在手动滑动切换到子控制器时，让列表返回顶部，不希望 push & pop 后触发该逻辑。则可以借助 `isSystemTrigger` 参数进行判断。
80 changes: 44 additions & 36 deletions Example/JXSegmentedViewExample/Special/Personal/JXPagingView/JXPagingListContainerView.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,21 @@ public protocol JXPagingViewListViewDelegate {
/// 将要重置listScrollView的contentOffset
@objc optional func listScrollViewWillResetContentOffset()
/// 可选实现，列表将要显示的时候调用
@objc optional func listWillAppear()
///
/// - Parameter isSystemTrigger: 是否是由生命周期方法触发
@objc optional func listWillAppear(isSystemTrigger: Bool)
/// 可选实现，列表显示的时候调用
@objc optional func listDidAppear()
///
/// - Parameter isSystemTrigger: 是否是由生命周期方法触发
@objc optional func listDidAppear(isSystemTrigger: Bool)
/// 可选实现，列表将要消失的时候调用
@objc optional func listWillDisappear()
///
/// - Parameter isSystemTrigger: 是否是由生命周期方法触发
@objc optional func listWillDisappear(isSystemTrigger: Bool)
/// 可选实现，列表消失的时候调用
@objc optional func listDidDisappear()
///
/// - Parameter isSystemTrigger: 是否是由生命周期方法触发
@objc optional func listDidDisappear(isSystemTrigger: Bool)
}

@objc
Expand Down Expand Up @@ -137,16 +145,16 @@ open class JXPagingListContainerView: UIView {
containerVC.view.backgroundColor = .clear
addSubview(containerVC.view)
containerVC.viewWillAppearClosure = {[weak self] in
self?.listWillAppear(at: self?.currentIndex ?? 0)
self?.listWillAppear(at: self?.currentIndex ?? 0, isSystemTrigger: true)
}
containerVC.viewDidAppearClosure = {[weak self] in
self?.listDidAppear(at: self?.currentIndex ?? 0)
self?.listDidAppear(at: self?.currentIndex ?? 0, isSystemTrigger: true)
}
containerVC.viewWillDisappearClosure = {[weak self] in
self?.listWillDisappear(at: self?.currentIndex ?? 0)
self?.listWillDisappear(at: self?.currentIndex ?? 0, isSystemTrigger: true)
}
containerVC.viewDidDisappearClosure = {[weak self] in
self?.listDidDisappear(at: self?.currentIndex ?? 0)
self?.listDidDisappear(at: self?.currentIndex ?? 0, isSystemTrigger: true)
}
if type == .scrollView {
if let scrollViewClass = dataSource.scrollViewClass?(in: self) as? UIScrollView.Type {
Expand Down Expand Up @@ -253,10 +261,10 @@ open class JXPagingListContainerView: UIView {
willAppearIndex = -1
willDisappearIndex = -1
if currentIndex != index {
listWillDisappear(at: currentIndex)
listWillAppear(at: index)
listDidDisappear(at: currentIndex)
listDidAppear(at: index)
listWillDisappear(at: currentIndex, isSystemTrigger: false)
listWillAppear(at: index, isSystemTrigger: false)
listDidDisappear(at: currentIndex, isSystemTrigger: false)
listDidAppear(at: index, isSystemTrigger: false)
}
}

Expand All @@ -278,8 +286,8 @@ open class JXPagingListContainerView: UIView {
}else {
collectionView.reloadData()
}
listWillAppear(at: currentIndex)
listDidAppear(at: currentIndex)
listWillAppear(at: currentIndex, isSystemTrigger: false)
listDidAppear(at: currentIndex, isSystemTrigger: false)
}

//MARK: - Private
Expand Down Expand Up @@ -314,14 +322,14 @@ open class JXPagingListContainerView: UIView {
}
}

private func listWillAppear(at index: Int) {
private func listWillAppear(at index: Int, isSystemTrigger: Bool) {
guard let dataSource = dataSource else { return }
guard checkIndexValid(index) else {
return
}
var existedList = validListDict[index]
if existedList != nil {
existedList?.listWillAppear?()
existedList?.listWillAppear?(isSystemTrigger: isSystemTrigger)
if let vc = existedList as? UIViewController {
vc.beginAppearanceTransition(true, animated: false)
}
Expand All @@ -343,7 +351,7 @@ open class JXPagingListContainerView: UIView {
list.listView().frame = CGRect(x: CGFloat(index)*scrollView.bounds.size.width, y: 0, width: scrollView.bounds.size.width, height: scrollView.bounds.size.height)
scrollView.addSubview(list.listView())
}
list.listWillAppear?()
list.listWillAppear?(isSystemTrigger: isSystemTrigger)
if let vc = list as? UIViewController {
vc.beginAppearanceTransition(true, animated: false)
}
Expand All @@ -352,44 +360,44 @@ open class JXPagingListContainerView: UIView {
cell?.contentView.subviews.forEach { $0.removeFromSuperview() }
list.listView().frame = cell?.contentView.bounds ?? CGRect.zero
cell?.contentView.addSubview(list.listView())
list.listWillAppear?()
list.listWillAppear?(isSystemTrigger: isSystemTrigger)
if let vc = list as? UIViewController {
vc.beginAppearanceTransition(true, animated: false)
}
}
}
}

private func listDidAppear(at index: Int) {
private func listDidAppear(at index: Int, isSystemTrigger: Bool) {
guard checkIndexValid(index) else {
return
}
currentIndex = index
let list = validListDict[index]
list?.listDidAppear?()
list?.listDidAppear?(isSystemTrigger: isSystemTrigger)
if let vc = list as? UIViewController {
vc.endAppearanceTransition()
}
delegate?.listContainerView?(self, listDidAppearAt: index)
}

private func listWillDisappear(at index: Int) {
private func listWillDisappear(at index: Int, isSystemTrigger: Bool) {
guard checkIndexValid(index) else {
return
}
let list = validListDict[index]
list?.listWillDisappear?()
list?.listWillDisappear?(isSystemTrigger: isSystemTrigger)
if let vc = list as? UIViewController {
vc.beginAppearanceTransition(false, animated: false)
}
}

private func listDidDisappear(at index: Int) {
private func listDidDisappear(at index: Int, isSystemTrigger: Bool) {
guard checkIndexValid(index) else {
return
}
let list = validListDict[index]
list?.listDidDisappear?()
list?.listDidDisappear?(isSystemTrigger: isSystemTrigger)
if let vc = list as? UIViewController {
vc.endAppearanceTransition()
}
Expand All @@ -414,16 +422,16 @@ open class JXPagingListContainerView: UIView {
if currentIndexPercent >= CGFloat(willAppearIndex) {
willDisappearIndex = -1
willAppearIndex = -1
listDidDisappear(at: disappearIndex)
listDidAppear(at: appearIndex)
listDidDisappear(at: disappearIndex, isSystemTrigger: false)
listDidAppear(at: appearIndex, isSystemTrigger: false)
}
}else {
//将要出现的列表在左边
if currentIndexPercent <= CGFloat(willAppearIndex) {
willDisappearIndex = -1
willAppearIndex = -1
listDidDisappear(at: disappearIndex)
listDidAppear(at: appearIndex)
listDidDisappear(at: disappearIndex, isSystemTrigger: false)
listDidAppear(at: appearIndex, isSystemTrigger: false)
}
}
}
Expand Down Expand Up @@ -478,12 +486,12 @@ extension JXPagingListContainerView: UICollectionViewDataSource, UICollectionVie
}else if validListDict[leftIndex] != nil {
if willAppearIndex == -1 {
willAppearIndex = leftIndex;
listWillAppear(at: willAppearIndex)
listWillAppear(at: willAppearIndex, isSystemTrigger: false)
}
}
if willDisappearIndex == -1 {
willDisappearIndex = rightIndex
listWillDisappear(at: willDisappearIndex)
listWillDisappear(at: willDisappearIndex, isSystemTrigger: false)
}
}else {
//当前选中的在左边，用户正在从左边往右边滑动
Expand All @@ -492,12 +500,12 @@ extension JXPagingListContainerView: UICollectionViewDataSource, UICollectionVie
}else if validListDict[rightIndex] != nil {
if willAppearIndex == -1 {
willAppearIndex = rightIndex
listWillAppear(at: willAppearIndex)
listWillAppear(at: willAppearIndex, isSystemTrigger: false)
}
}
if willDisappearIndex == -1 {
willDisappearIndex = leftIndex
listWillDisappear(at: willDisappearIndex)
listWillDisappear(at: willDisappearIndex, isSystemTrigger: false)
}
}
listDidAppearOrDisappear(scrollView: scrollView)
Expand All @@ -506,10 +514,10 @@ extension JXPagingListContainerView: UICollectionViewDataSource, UICollectionVie
public func scrollViewDidEndDecelerating(_ scrollView: UIScrollView) {
//滑动到一半又取消滑动处理
if willAppearIndex != -1 || willDisappearIndex != -1 {
listWillDisappear(at: willAppearIndex)
listWillAppear(at: willDisappearIndex)
listDidDisappear(at: willAppearIndex)
listDidAppear(at: willDisappearIndex)
listWillDisappear(at: willAppearIndex, isSystemTrigger: false)
listWillAppear(at: willDisappearIndex, isSystemTrigger: false)
listDidDisappear(at: willAppearIndex, isSystemTrigger: false)
listDidAppear(at: willDisappearIndex, isSystemTrigger: false)
willDisappearIndex = -1
willAppearIndex = -1
}
Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,10 +215,10 @@ func listContainerView(_ listContainerView: JXSegmentedListContainerView, initLi
func listView() -> UIView {
return view
}
func listWillAppear() {}
func listDidAppear() {}
func listDidDisappear() {}
func listDidDisappear() {}
func listWillAppear(isSystemTrigger: Bool) {}
func listDidAppear(isSystemTrigger: Bool) {}
func listDidDisappear(isSystemTrigger: Bool) {}
func listDidDisappear(isSystemTrigger: Bool) {}
```

具体点击[LoadDataViewController](https://github.com/pujiaxin33/JXSegmentedView/blob/master/Example/JXSegmentedViewExample/Special/LoadData/WithListContainerView/LoadDataViewController.swift)查看源代码了解
Expand Down
Loading