Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bannzai/conv
Conv smart represent UICollectionView data structure more than UIKit.
https://github.com/bannzai/conv
ios swift uicollectionview
Last synced: about 1 month ago
JSON representation
Conv smart represent UICollectionView data structure more than UIKit.
- Host: GitHub
- URL: https://github.com/bannzai/conv
- Owner: bannzai
- License: mit
- Created: 2018-04-25T12:30:47.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-07T23:51:58.000Z (over 3 years ago)
- Last Synced: 2024-08-07T14:35:33.176Z (about 1 month ago)
- Topics: ios, swift, uicollectionview
- Language: Swift
- Homepage:
- Size: 1.87 MB
- Stars: 158
- Watchers: 6
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-ios - Conv - Conv smart represent UICollectionView data structure more than UIKit. (UI / Table View / Collection View)
- awesome-ios-star - Conv - Conv smart represent UICollectionView data structure more than UIKit. (UI / Table View / Collection View)
README
# Conv
Conv smart represent UICollectionView data structure more than UIKit.
Easy definition for UICollectionView DataSource and Delegate methods.
And Conv reload fast to use diffing algorithm based on the Paul Heckel's algorithm.
| Insert and Delete | Move item and section |
| ---- | ---- |
| 
| 
|
Conv(called KONBU) means Seaweed in Japan.
This library is inspired by [Shoyu](https://github.com/yukiasai/shoyu). Thanks [@yukiasai](https://github.com/yukiasai).
# Usage
**First**, Conv need to prepare array of definition datastructure for section and item.
And then it should conform `Differenciable` protocol for difference algorithm.
### Section
```swift
enum SectionType: Int {
case one
case two
case three
static var allCases: [SectionType] {
return [.one, .two, .three]
}
}
extension SectionType: Differenciable {
var differenceIdentifier: DifferenceIdentifier {
return "\(self)"
}
}
```
```swift
let sectionTypes = SectionType.allCases
```
### Item
```swift
struct ItemModel {
let index: Int
let imageName: String
var image: UIImage {
return UIImage(named: imageName)!
}
}
extension ItemModel: Differenciable {
var differenceIdentifier: DifferenceIdentifier {
return "\(index)" + imageName
}
}
```
```swift
let itemModels = [
ItemModel(index: 1, imageName: "forest"),
ItemModel(index: 2, imageName: "moon"),
ItemModel(index: 3, imageName: "pond"),
ItemModel(index: 4, imageName: "river"),
]
```
**Second**, start to define data structure for section and item.
It use prepared Differenciable array.
```swift
collectionView
.conv // #1
.diffing()
.start()
.append(for: sectionTypes) { (sectionType, section) in // #2
section.append(.header, headerOrFooter: { (header: SectionHeaderFooter) in // #3
header.reusableIdentifier = "ListCollectionReusableView"
header.size = CGSize(width: UIScreen.main.bounds.width, height: 50)
header.configureView { view, _ in
view.nameLabel.text = "\(sectionType)".uppercased()
view.nameLabel.textColor = .white
view.backgroundColor = sectionType.backgroundColor
}
})
section.append(for: itemModels, items: { (itemModel, item: Item) in // #4
item.reusableIdentifier = "ListCollectionViewCell"
item.sizeFor({ _ -> CGSize in
let gridCount: CGFloat = 3
let edge = floor((UIScreen.main.bounds.width - (gridCount - 1)) / gridCount)
let size = CGSize(width: edge, height: edge)
return size
})
item.configureCell { (cell, info) in
cell.setup(with: itemModel)
}
item.didSelect { [weak self] (item) in
let viewController = DetailViewController(imageName: itemModel.imageName)
self?.navigationController?.pushViewController(viewController, animated: true)
}
})
}
```
This swift code has the following meaning. It explain for `#` mark in code.
1. Start to define UICollectionView data structure it using `Conv`.
2. Append sections that number of sectionTypes. And start define about section.
3. Append section header for each section. And start define about section header.
4. Append items that number of itemModels for each section. And start define about item.
**Last**, If you want to render of `collectionView`, you call `collectionView.update()` your best timing.
`update()` calculate diff for minimum reloading data between before section and between before items.
```swift
collectionView.conv.update()
```
Or if you want to all realod cells, you can call `reload()`.
It will be same behavior of `collectionView.reloadData()`.
```swift
collectionView.conv.reload()
```
You can see more example to [ConvExmaple](https://github.com/bannzai/Conv/tree/master/ConvExample/)
# Algorithm
Conv to use diffing algorithm based on the Paul Heckel's algorithm.
And I also referred to other libraries below.
- https://github.com/mcudich/HeckelDiff
- https://github.com/ra1028/DifferenceKit
- https://github.com/Instagram/IGListKit/
# Install
## CocoaPods
Conv is available through Cocoapods.
You can write it into target and exec `pod install`.
```
pod 'Conv'
```
## Carthage
Conv is available through Carhtage.
You can write it into target and exec `carthage update --platform iOS`.
And find conv framework and embed your project.
```
github 'bannzai/Conv'
```
# Why Conv?
UIKit.UICollectionView has some problems.
1. UICollectionView.dequeueXXX method not type safe. So, should convert to want class each cells.
2. UICollectionViewDataSource and UICollectionViewDelegate(or DelegateFlowLayout) far away each configured functions. So, reading configuration flow for each indexPath very difficalt.
3. Many case to use UICollectionView with Array. But extract element from array using indexPath many time.
Conv resolve these problem.
1. Conv does not need to call UICollectionView.dequeueXXX. Because you can define configureCell method and get converted custom class cell.
```swift
section.append(for: itemModels, items: { (itemModel, item: Item) in // #4
...
item.configureCell { (cell, info) in
// cell is converted ListCollectionViewCell
cell.setup(with: itemModel)
}
})
```
2. You can write to neary for each UICollectionView component. section,item,header and footer.
So, this definition to be natural expression for UICollectionView data strcture, hierarchy, releation.
3. When append section or item, you can passed allCases for configure UICollectionView.
Next each element pass closure argument that define Conv.Section or Conv.Item.
So, You can represent CollectionView data structure with extracted each element.
# LICENSE
[Conv](https://github.com/bannzai/Conv/) is released under the MIT license. See [LICENSE](https://github.com/bannzai/Conv/blob/master/LICENSE.txt) for details.
Header logo is released [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/deed) license. Original design by [noainoue](https://github.com/noainoue).