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:
If you want help project, check Сooperation section.
Swift +5.0. Ready for use on iOS 13+
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'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 11, specify it in File > Swift Packages > Add:
https://github.com/ivanvorobei/SPDiffable
Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate SPDiffable into your Xcode project using Carthage, specify it in your Cartfile:
github "ivanvorobei/SPDiffable"
If you prefer not to use any of dependency managers, you can integrate SPDiffable into your project manually. Put Source/SPDiffable folder in your Xcode project. Make sure to enable Copy items if needed and Create groups.
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 {}After it add properties, which you want use. For example:
class LocationRowModel: SPDiffableItem {
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:
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 next.
setCellProviders([locationCellProvider], sections: content)
}In project available models for like SPDiffableTableRow and other with ready-use properties. Also you can use default cell provider if using project's models. For get it call SPDiffableTableCellProviders.default.
Now table support models and custom cell provider. We can apply diffable content with animation (or not). Create section class:
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]You can add more cells or sections. Last step - apply:
diffableDataSource?.apply(sections: content, animating: true)That all. You can each time create new order or count cells and it automatically show with diffable animation.
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.
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 })
]
)You can save time and count 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.
For update table shoud using apply() method:
diffableDataSource?.apply(sections: [section], animating: true)If you use custom table view or table controller, don't forget register cells classes. For SPDiffableTableController all cells already registered.
It 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:
SPDiffableItemit basic class. All item models shoud be extend from it model. Header and footer also.SPDiffableSectionsection class. Included footer and header properties, also items (cells).SPDiffableTextHeaderFooterheader or footer class with text.
-
SPDiffableTableRowit native item for table cell. Support all basic styles and action for tap event. -
SPDiffableTableRowSubtitleit native item for table cell with subtitle. Support all as before. -
SPDiffableTableRowStepperitem for table cell with stepper. Has maximum value and minimum, also incuded action with passed value. -
SPDiffableTableRowSwitchitem for table with switch, included default state and action for change event. -
SPDiffableTableRowButtonitem for table in style as button. Support table styles and action for tap. -
SPDiffableTableViewCellbasic table cell with detail text right side. -
SPDiffableSubtitleTableViewCellbasic table cell with two lines of texts.
SPDiffableSideBarItemmenu item in side bar. Support accessories and actions.SPDiffableSideBarButtonbutton item in side bar. Color of title similar to tint.SPDiffableSideBarHeaderheader model for side bar item.
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"))And after unwrap it in custom cell provider.
This project is free, but developing it takes time. Contributing to this project is a huge help. Here is list of tasks that need to be done, you can help with any:
- Update readme text, my English not great :(
- Update docs to swift source files
Allow request permissions with native dialog UI and interactive animations. Also you can request permissions without dialog. Check state any permission. You can start using this project with just two lines of code and easy customisation.
It is popup from Apple Music & Feedback in AppStore. Contains Done & Heart presets. Done present with draw path animation. I clone Apple's alerts as much as possible. You can find this alerts in AppStore after feedback, after added song to library in Apple Music. I am also add alert without icon, as simple message.
Присоединяйтесь в телеграм канал Код Воробья, там найдете заметки о iOS разработке и дизайне. Большие туториалы выклыдываю на YouTube.
