N.b. — I fixed a bug in the method described below where the method would crash if changes were made to the table view data during animation. I’ve updated this blog post to reflect these changes. (Aug 3, 2016)†
Whenever I find myself re-using a helper method in many of my classes or projects, I like to add it to a shared class I created called KMHGenerics. This class contains generically useful methods so that my actual code can remain as “dry” as possible.
Today I’m going to talk about a method I wrote to animate complex updates to UITableViews. The KMHGenerics class shared here on GitHub includes many other methods too, but I’ll save those for another blog post.
Those of you familiar with UITableView methods are probably comfortable inserting, reordering, and deleting rows from your table view, but what happens if you want to perform a mix of these actions within a single animation? For example, how would you animate inserting a row at the end of your table view while simultaneously deleting the first row of your table view and reordering the remaing cells?
If you are efficient and looking for the simplest solution, the answer is to call
[self.tableview reloadData] and update the entire table view at once. While this works, the lack of animations can be, in certain situations, extremely confusing to the user—much like the following GIF:
Instead, I’ve written the following method on UITableView to perform updates in a single animation:
This method takes in the follow ten parameters:
- section: Which section of your table view to animate.1
- data: The desired final state of your table view’s data.
- insertionAnimation: What animation style to use when inserting new cells in your table view.
- deletionAnimation: What animation style to use when deleting cells from your table view.
- getter: A block that gets the data for your table view.
- setter: A block that sets the data for your table view.
- insertedCells: An optional block to execute on the cells that will be inserted.
- reorderedCells: An optional block to execute on the cells that will be reodered.
- deletedCells: An optional block to execute on the cells that will be deleted.
- completion: An optional block to execute upon completion of all animations.
To help illustrate, I’ve embedded an interactive demo below showing. Try it out and let me know what you think!
† The original and now deprecated method declaration is still available on GitHub Gist.
1 Currently this method only supports updating one table view section at a time. At some point I should implement a version that supports updating multiple table view sections simultaneously, e.g., for when table view cells are moved between sections.