SPDiffable

Apple's diffable API requerid models for each object type. If you want use it in many place, you pass many time to implemenet and get over duplicates codes. This project help you do it elegant with shared models and special cell providers for one-usage models.

If you like the project, don't forget to put star ★ and follow me on GitHub:

Navigate

• Installation
  • Swift Package Manager
  • CocoaPods
  • Manually
• Usage
  • How it work
  • Mediator
  • Diffable Delegate
  • Sidebar
• Ready Use
  • Example
  • List classes
  • Wrapper
• Сooperation
• Other Projects
• Russian Community

Installation

Ready for use on iOS 12+. Works with Swift 5+. Required Xcode 12.0 and higher.

Swift Package Manager

The Swift Package Manager is a tool for managing the distribution of Swift code. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.

To integrate SPDiffable into your Xcode project using Xcode 12, specify it in File > Swift Packages > Add Package Dependency...:

https://github.com/ivanvorobei/SPDiffable

CocoaPods:

CocoaPods is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate SPDiffable into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'SPDiffable'

Manually

If you prefer not to use any of dependency managers, you can integrate SPDiffable into your project manually. Put Sources/SPDiffable folder in your Xcode project. Make sure to enable Copy items if needed and Create groups.

Usage

Before read it, highly recomded check Example target in project. It examle show all features, like use stepper and switch, like process actions, create custom models and many other. Also you can skip full undestand logic and read Ready-use section with minimum of code for start.

For work with diffable need create model (inside project you found some ready-use models) and do cell provider, which convert data-model to UITableViewCell or UICollectionViewCell. Next example for table, but all methods and class names available for collections.

New model shoud extend from basic class SPDiffableItem:

class LocationRowModel: SPDiffableItem {

    // Add properties, which you need
    public var city: String
    public var adress: String?
}

Last step, create table controller class and extend of SPDiffableTableController. Create custom cell provider, it doing convert it data to table cell:

class DiffableTableController: SPDiffableTableController {

    override func viewDidLoad() {
        super.viewDidLoad()
        
        // Register cell for usage it in table view
        tableView.register(LocationTableCell.self, forCellReuseIdentifier: "LocationTableCell")
        
        // Cell provider for `LocationRowModel`
        let locationCellProvider: SPDiffableTableCellProvider = { (tableView, indexPath, model) -> UITableViewCell? in
            switch model {
            case let model as TableRowModel:
                let cell = tableView.dequeueReusableCell(withIdentifier: "LocationTableCell", for: indexPath) as! LocationTableCell
                cell.textLabel?.text = model.city
                cell.detailTextLabel?.text = model.adress
                return cell
            default:
                return nil
            }
        }
        
        // Pass cell provider and content. 
        // About content you can read in next section.
        setCellProviders([locationCellProvider], sections: content)
    }
}

Now ready model and convert it to views. Time to add content. Read next section.

Apply Content

Now table support models and custom cell provider. You can apply diffable content with animation (or not). Create content:

var content: [SPDiffableSection] {
    let section = SPDiffableSection(
        identifier: "example section",
        header: SPDiffableTextHeaderFooter(text: "Header"),
        footer: SPDiffableTextHeaderFooter(text: "Footer"),
        items: [
            LocationRowModel(city: "Minsk", adress: "Frunze Pr., bld. 47, appt. 7"),
            LocationRowModel(city: "Shanghai", adress: "Ting Wei Gong Lu 9299long 168hao"),
            LocationRowModel(city: "London", adress: "94  Whitby Road")
        ]
    )

    let content = [section]
    return content
}

You can add more items or sections. Last step - apply:

diffableDataSource?.apply(sections: content, animating: true)

Call this when you need update content. When you call setCellProviders, it set content by default without animation. That all. You can each time create new order or count cells and it automatically show with diffable animation.

Mediator

Some methods in diffable data source can't ovveride without custom data source. It solved with mediator delegate. It simple. Next example for table. Set delegate SPTableDiffableMediator, all method optional:

class DiffableTableController: SPDiffableTableController, SPTableDiffableMediator {

    override func viewDidLoad() {
        super.viewDidLoad()
        setCellProviders([cellProvider], sections: content)
        diffableDataSource?.mediator = self
    }
}

Now you can implemented requerid methods, for example title of header:

func diffableTableView(_ tableView: UITableView, titleForHeaderInSection section: Int) -> String? {
    return "Overridden in of diffable mediator"
}

In protocol you can find more methods, like canEdit and other.

Diffable Delegate

For handle some useful extensions, you can use delegates SPDiffableTableDelegate, SPDiffableCollectionDelegate. For example, when you need get which model did select, use this:

class DiffableTableController: SPDiffableTableController, SPDiffableTableDelegate {

    override func viewDidLoad() {
        super.viewDidLoad()
        
        // Hidded code for cell providers and content
        
        setCellProviders([cellProvider], sections: content)
        diffableDelegate = self
    }
    
    func diffableTableView(_ tableView: UITableView, didSelectItem item: SPDiffableItem) {
        // Here you get model, which did select.
    }
} 

Sidebar

Create new controller and extend from SPDiffableSideBarController. Remember, it available only from iOS 14.

class SidebarController: SPDiffableSideBarController {}

In class available ready-use cell providers for menu item and header section. For get it shoud call:

override func viewDidLoad() {
    super.viewDidLoad()
    setCellProviders([SPDiffableCollectionCellProviders.sideBar], sections: content)
}

Content it array of SPDiffableSection. For menu model need use model SPDiffableSideBarItem or SPDiffableSideBarButton. For header and footer will create SPDiffableSideBarHeader model.

SPDiffableSection(
    identifier: Section.library.rawValue,
    header: SPDiffableSideBarHeader(text: "Library", accessories: [.outlineDisclosure()]),
    items: [
        SPDiffableSideBarItem(title: "Recently Added", image: UIImage(systemName: "clock"), action: { _ in }),
        SPDiffableSideBarItem(title: "Artists", image: UIImage(systemName: "music.mic"), action: { _ in }),
        SPDiffableSideBarItem(title: "Albums", image: UIImage(systemName: "rectangle.stack"), action: { _ in }),
        SPDiffableSideBarItem(title: "Songs", image: UIImage(systemName: "music.note"), action: { _ in }),
        SPDiffableSideBarButton(title: "Add New", image: UIImage(systemName: "plus.square.fill"), action: { _ in })
    ]
)

Ready Use

You can save time and count lines of code using ready-use classes. In project available models and views. For example you need simple table with native cells. You need create content with SPDiffableTableRow:

let section = SPDiffableSection(
    identifier: "example section",
    header: SPDiffableTextHeaderFooter(text: "Header"),
    footer: SPDiffableTextHeaderFooter(text: "Footer"),
    items: [
        SPDiffableTableRow(text: "First Cell", accessoryType: .disclosureIndicator, selectionStyle: .default, action: { [weak self] indexPath in
            guard let self = self else { return }
            self.tableView.deselectRow(at: indexPath, animated: true)
        }),
        SPDiffableTableRow(text: "Second Cell", accessoryType: .disclosureIndicator, selectionStyle: .default, action: { [weak self] indexPath in
            guard let self = self else { return }
            self.tableView.deselectRow(at: indexPath, animated: true)
        }),
    ]
)

You init cell model and pass action, choose selection style and other. As you see, model describe native table cell. Next, you need set cell provider, but it also already available, for get it call SPDiffableTableController.defaultCellProvider.

setCellProviders(SPDiffableTableCellProviders.default, sections: [section])

Now project's models automatically converting to cell. No need any additional work. That all code. If you use custom table view or table controller, don't forget register cells classes. For SPDiffableTableController all cells already registered.

Ready-use classes

It list models which you can use now, it shoud close your task without code. Of couse you can create your models. Now in project you can find this ready-use models:

• SPDiffableItem it basic class. All item models shoud be extend from it model. Header and footer also.
• SPDiffableSection section class. Included footer and header properties, also items (cells).
• SPDiffableTextHeaderFooter header or footer class with text.

For Table:

• SPDiffableTableRow it native item for table cell. Support all basic styles and action for tap event.

• SPDiffableTableRowSubtitle it native item for table cell with subtitle. Support all as before.

• SPDiffableTableRowStepper item for table cell with stepper. Has maximum value and minimum, also incuded action with passed value.

• SPDiffableTableRowSwitch item for table with switch, included default state and action for change event.

• SPDiffableTableRowButton item for table in style as button. Support table styles and action for tap.

• SPDiffableTableViewCell basic table cell with detail text right side.

• SPDiffableSubtitleTableViewCell basic table cell with two lines of texts.

For Collection:

• SPDiffableCollectionActionableItem actionable item for collection view.
• SPDiffableSideBarItem menu item in side bar. Support accessories and actions.
• SPDiffableSideBarButton button item in side bar. Color of title similar to tint.
• SPDiffableSideBarHeader header model for side bar item.

Wrapper

In project you can find class SPDiffableWrapperItem. Using it, when you don't want create custom item model for you diffable struct. You can pass any your model and uwrap it later in cell provider.

let item = SPDiffableWrapperItem(identifier: "unqi-identifier", model: LocationRowModel(city: "Minsk"))

Other Projects

I love being helpful. Here I have provided a list of libraries that I keep up to date. For see video previews of libraries without install open opensource.ivanvorobei.by website.
I have libraries with native interface and managing permissions. Also available pack of useful extensions for boost your development process.

Russian Community

Веду каналы об iOS разработке. Один с туториалами и новостями, другой с обзором библиотек.
Со сложной задачей помогут в чате.

Видео-туториалы выклыдываю на YouTube: