pod ‘IQListKit’

pod ‘IQListKit’, ‘1.0.0’

import PackageDescription

let package = Package(
name: “YOUR_PROJECT_NAME”,
products: [],
dependencies: [
.package(url: “https://github.com/hackiftekhar/IQListKit.git”, from: “1.0.0”)
]
)

struct User {

let id: Int //A unique id of each user
let name: String //Name of the user
}

//We have Int and String variables in the struct
//That’s why we do not have to manually confirm the hashable protocol
//It will work out of the box by just adding the hashable protocol to the User struct
struct User: Hashable {

let id: Int
let name: String
}

struct User: Hashable {

func hash(into hasher: inout Hasher) { //Manually Confirming to the Hashable protocol
hasher.combine(id)
}

static func == (lhs: User, rhs: User) -> Bool { //Manually confirming to the Equatable protocol
lhs.id == rhs.id && lhs.name == rhs.name
}

let id: Int
let name: String
}

class UserCell: UITableViewCell {

@IBOutlet var labelName: UILabel!
}

class UserCell: UITableViewCell, IQModelableCell {

@IBOutlet var labelName: UILabel!

var model: User? //Our User model confirms the Hashable protocol
}

class UserCell: UITableViewCell, IQModelableCell {

@IBOutlet var labelName: UILabel!

typealias Model = User //typealiasing the User model to a common name

var model: Model? //Model is a typealias of User
}

class UserCell: UITableViewCell, IQModelableCell {

@IBOutlet var labelName: UILabel!

struct Model: Hashable {
let user: User
let canShowMenu: Bool //custom parameter which can be controlled from ViewControllers
let paramter2: Int //Another customized parameter
… and so on (if needed)
}

var model: Model? //Our new Model struct confirms the Hashable protocol
}

class UserCell: UITableViewCell, IQModelableCell {

@IBOutlet var labelName: UILabel!

var model: User? { //For simplicity, we’ll be using the 1st method
didSet {
guard let model = model else {
return
}

labelName.text = model.name
}
}
}

class UsersTableViewController: UITableViewController {

private var users = [User]() //assuming the users array is loaded from somewhere e.g. API call response

//…

func loadDataFromAPI() {

//Get users list from API
APIClient.getUsersList({ [weak self] result in

switch result {

case .success(let users):
self?.users = users //Updates the users array
self?.refreshUI() //Refresh the data

case .failure(let error):
//Handle error
}
}
}
}

class UsersTableViewController: UITableViewController {

//…

private lazy var list = IQList(listView: tableView, delegateDataSource: self)

override func viewDidLoad() {
super.viewDidLoad()

// Optional configuration when there are no items to display
// list.noItemImage = UIImage(named: “empty”)
// list.noItemTitle = “No Items”
// list.noItemMessage = “Nothing to display here.”
// list.noItemAction(title: “Reload”, target: self, action: #selector(refresh(_:)))
}
}

extension UsersTableViewController: IQListViewDelegateDataSource {
}

class UsersTableViewController: UITableViewController {

//…

func refreshUI(animated: Bool = true) {

//This is the actual method that reloads the data.
//We could think it like a tableView.reloadData()
//It does all the needed thing
list.reloadData({

//If we use multiple sections, then each section should be unique.
//This should also confirm to hashable, so we can also provide a Int
//like this `let section = IQSection(identifier: 1)`
let section = IQSection(identifier: “first”)

//We can also provide the header/footer title, they are optional
//let section = IQSection(identifier: “first”,
// header: “I’m header”,
// footer: “I’m footer”)

/*Or we an also provide custom header footer view and it’s model, just like the cell,
We just have to adopt IQModelableSupplementaryView protocol to SampleCollectionReusableView
And it’s also havie exactly same requirement as cell (have a model property)
However, you also need to register this using
list.registerSupplementaryView(type: SampleCollectionReusableView.self,
kind: UICollectionView.elementKindSectionHeader, registerType: .nib)
and use it like below
*/
//let section = IQSection(identifier: “first”,
// headerType: SampleCollectionReusableView.self,
// headerModel: “This is my header text for Sample Collection model”)

list.append(section)

//Telling to the list that the models should render in UserCell

//If model created using Method 1 or Method 2
list.append(UserCell.self, models: users, section: section)

/*
If model created using Method 3
var models = [UserCell.Model]()

for user in users {
models.append(.init(user: user))
}
list.append(UserCell.self, models: models, section: section)
*/

//controls if the changes should animate or not while reloading
}, animatingDifferences: animated, completion: nil)
}
}

class MountainsViewController: UIViewController {

//…

private lazy var listWrapper = IQListWrapper(listView: userTableView,
type: UserCell.self,
registerType: .nib, delegateDataSource: self)

//…

func refreshUI(models: [User]) {
listWrapper.setModels(models, animated: true)
}
//…
}

extension UsersTableViewController: IQListViewDelegateDataSource {

func listView(_ listView: IQListView, modifyCell cell: IQListCell, at indexPath: IndexPath) {
if let cell = cell as? UserCell { //Casting our cell as UserCell
cell.delegate = self
//Or additional work with the UserCell

//🙂 Get the user object associated with the cell
let user = cell.model

//We discourage to use the indexPath variable to get the model object
//😤 Don’t do like this since we are model-driven list, not the indexPath driven list.
//let user = users[indexPath.row]
}
}
}

extension UsersTableViewController: IQListViewDelegateDataSource {

func listView(_ listView: IQListView, didSelect item: IQItem, at indexPath: IndexPath) {
if let model = item.model as? UserCell.Model { //😍 We get the user model associated with the cell
if let controller = UIStoryboard(name: “Main”, bundle: nil)
.instantiateViewController(identifier: “UserDetailViewController”) as? UserDetailViewController {
controller.user = model //If used Method 1 or Method 2
// controller.user = model.user //If used method 3
self.navigationController?.pushViewController(controller, animated: true)
}
}
}
}

class UserCell: UITableViewCell, IQModelableCell {

//…

static func estimatedSize(for model: AnyHashable, listView: IQListView) -> CGSize? {
return CGSize(width: listView.frame.width, height: 100)
}

static func size(for model: AnyHashable, listView: IQListView) -> CGSize? {

if let model = model as? Model {
var height: CGFloat = 100
//…
// return height based on the model
return CGSize(width: listView.frame.width, height: height)
}

//Or return a constant height
return CGSize(width: listView.frame.width, height: 100)

//Or UITableView.automaticDimension for dynamic behaviour
// return CGSize(width: listView.frame.width, height: UITableView.automaticDimension)
}
}

class UserCell: UITableViewCell, IQModelableCell {

//…

@available(iOS 11.0, *)
func leadingSwipeActions() -> [UIContextualAction]? {
let action = UIContextualAction(style: .normal, title: “Hello Leading”) { (_, _, completionHandler) in
completionHandler(true)
//Do your stuffs here
}
action.backgroundColor = UIColor.orange

return [action]
}

func trailingSwipeActions() -> [UIContextualAction]? {

let action1 = UIContextualAction(style: .normal, title: “Hello Trailing”) { [weak self] (_, _, completionHandler) in
completionHandler(true)
guard let self = self, let user = self.model else {
return
}

//Do your stuffs here
}

action.backgroundColor = UIColor.purple

return [action]
}
}

class UserCell: UITableViewCell, IQModelableCell {

//…

@available(iOS 13.0, *)
func contextMenuConfiguration() -> UIContextMenuConfiguration? {

let contextMenuConfiguration = UIContextMenuConfiguration(identifier: nil,
previewProvider: { () -> UIViewController? in
let controller = UIStoryboard(name: “Main”, bundle: nil)
.instantiateViewController(identifier: “UserViewController”) as? UserViewController
controller?.user = self.model
return controller
}, actionProvider: { (actions) -> UIMenu? in

var actions = [UIMenuElement]()
let action = UIAction(title: “Hello Action”) { _ in
//Do your stuffs here
}
actions.append(action)

return UIMenu(title: “Nested Menu”, children: actions)
})

return contextMenuConfiguration
}

@available(iOS 13.0, *)
func performPreviewAction(configuration: UIContextMenuConfiguration,
animator: UIContextMenuInteractionCommitAnimating) {
if let previewViewController = animator.previewViewController, let parent = viewParentController {
animator.addAnimations {
(parent.navigationController ?? parent).show(previewViewController, sender: self)
}
}
}
}

private extension UIView {
var viewParentController: UIViewController? {
var parentResponder: UIResponder? = self
while let next = parentResponder?.next {
if let viewController = next as? UIViewController {
return viewController
} else { parentResponder = next }
}
return nil
}
}

extension UsersTableViewController: IQListViewDelegateDataSource {

//…

//Cell will about to display
func listView(_ listView: IQListView, willDisplay cell: IQListCell, at indexPath: IndexPath)

//Cell did end displaying
func listView(_ listView: IQListView, didEndDisplaying cell: IQListCell, at indexPath: IndexPath)

func listView(_ listView: IQListView, didDeselect item: IQItem, at indexPath: IndexPath)

func listView(_ listView: IQListView, didHighlight item: IQItem, at indexPath: IndexPath)

func listView(_ listView: IQListView, didUnhighlight item: IQItem, at indexPath: IndexPath)

func listView(_ listView: IQListView, performPrimaryAction item: IQItem, at indexPath: IndexPath)

func listView(_ listView: IQListView, modifySupplementaryElement view: UIView,
section: IQSection, kind: String, at indexPath: IndexPath)

func listView(_ listView: IQListView, willDisplaySupplementaryElement view: UIView,
section: IQSection, kind: String, at indexPath: IndexPath)

func listView(_ listView: IQListView, didEndDisplayingSupplementaryElement view: UIView,
section: IQSection, kind: String, at indexPath: IndexPath)

func listView(_ listView: IQListView, willDisplayContextMenu configuration: UIContextMenuConfiguration,
animator: UIContextMenuInteractionAnimating?, item: IQItem, at indexPath: IndexPath)

func listView(_ listView: IQListView, willEndContextMenuInteraction configuration: UIContextMenuConfiguration,
animator: UIContextMenuInteractionAnimating?, item: IQItem, at indexPath: IndexPath)
}

extension UsersTableViewController: IQListViewDelegateDataSource {

//…

//Return the size of an Item, for tableView the size.height will only be effective
func listView(_ listView: IQListView, size item: IQItem, at indexPath: IndexPath) -> CGSize?

//Return the custom header or footer View of section (or item in collection view)
func listView(_ listView: IQListView, supplementaryElementFor section: IQSection,
kind: String, at indexPath: IndexPath) -> UIView?

func sectionIndexTitles(_ listView: IQListView) -> [String]?

func listView(_ listView: IQListView, prefetch items: [IQItem], at indexPaths: [IndexPath])

func listView(_ listView: IQListView, cancelPrefetch items: [IQItem], at indexPaths: [IndexPath])

func listView(_ listView: IQListView, canMove item: IQItem, at indexPath: IndexPath) -> Bool?

func listView(_ listView: IQListView, move sourceItem: IQItem,
at sourceIndexPath: IndexPath, to destinationIndexPath: IndexPath)

func listView(_ listView: IQListView, canEdit item: IQItem, at indexPath: IndexPath) -> Bool?

func listView(_ listView: IQListView, commit item: IQItem,
style: UITableViewCell.EditingStyle, at indexPath: IndexPath)
}

class UserCell: UITableViewCell, IQModelableCell {

//…

var isHighlightable: Bool { //IQSelectableCell protocol
return true
}

var isSelectable: Bool { //IQSelectableCell protocol
return false
}

var isDeselectable: Bool { //IQSelectableCell protocol
return false
}

var canPerformPrimaryAction: Bool { //IQSelectableCell protocol
return false
}

var canMove: Bool { //IQReorderableCell protocol
return false
}

var canEdit: Bool { //IQReorderableCell protocol
return false
}

var editingStyle: UITableViewCell.EditingStyle { //IQReorderableCell protocol
return .none
}
}

class UserCell: UITableViewCell, IQModelableCell {

//…

// IQViewSizeProvider protocol
static func indentationLevel(for model: AnyHashable?, listView: IQListView) -> Int {
return 1
}

//IQCellActionsProvider protocol
func contextMenuPreviewView(configuration: UIContextMenuConfiguration) -> UIView? {
return viewToBePreview
}
}

class UsersTableViewController: UITableViewController {

//…

func refreshUI(animated: Bool = true) {

//Show loading indicator
loadingIndicator.startAnimating()

//Reload data in background
DispatchQueue.global().async {

self.list.reloadData({

let section = IQSection(identifier: “first”)
self.list.append(section)

self.list.append(UserCell.self, models: users, section: section)

}, animatingDifferences: animated, completion: {
//Hide loading indicator since the completion will be called in main thread
self.loadingIndicator.stopAnimating()
})
}
}
}