Author: Toomas Vahter

UITableView swipe actions on iOS

Post author By Toomas Vahter
Post date February 3, 2019
No Comments on UITableView swipe actions on iOS

Since iOS 11 it is easy to add swipe actions in a table view. What we need to do, is to implement UITableView delegate methods for providing actions for leading and trailing edge. Let’s jump right into it.

Default swipe actions

Swipe actions are provided by two delegate methods which return UISwipeActionsConfiguration. It should be mentioned that when returning nil in those delegates, table view will use its default set of actions. Default action is delete action and acton should be implemented in the editingStyle delegate method.

	optional func tableView(_ tableView: UITableView, leadingSwipeActionsConfigurationForRowAt indexPath: IndexPath) -> UISwipeActionsConfiguration?
	optional func tableView(_ tableView: UITableView, trailingSwipeActionsConfigurationForRowAt indexPath: IndexPath) -> UISwipeActionsConfiguration?

	override func tableView(_ tableView: UITableView, commit editingStyle: UITableViewCell.EditingStyle, forRowAt indexPath: IndexPath) {
	switch editingStyle {
	case .delete:
	showAlert("Delete triggered")
	case .insert, .none:
	break
	}
	}

view raw UITableViewDelegate.swift hosted with ❤ by GitHub

Custom swipe actions

Let’s leave default actions aside and see what is this configuration object swipe action delegates need to return. It just provides the set of different actions and a property of controlling if the full swipe triggers the first action or not. By default, this is turned on and full swipe triggers the first action. Action itself is represented by UIContextualAction class. This class defines handler block, title, image and background color of the action. Action can’t have both image and title, whenever image is set, title is ignored. In addition, action’s initialiser defines style: normal style means light grey background and destructive style uses red background. One needs to be aware that when adding too many actions results in having overlapping action buttons in the table view. Therefore it always makes to test and see if the amount of actions really works on the smallest display size.

	override func tableView(_ tableView: UITableView, trailingSwipeActionsConfigurationForRowAt indexPath: IndexPath) -> UISwipeActionsConfiguration? {
	let item = content[indexPath.item]
	switch item {
	case .iconAction:
	let action = UIContextualAction(style: .normal, title: item.rawValue, handler: { [weak self] (action, view, block) in
	self?.showAlert(item.rawValue)
	})
	action.backgroundColor = UIColor(hue: 0.11, saturation: 0.56, brightness: 0.48, alpha: 1.0)
	action.image = UIImage(named: "Icon")
	return UISwipeActionsConfiguration(actions: [action])
	case .multipleTrailingActions:
	let action1 = UIContextualAction(style: .normal, title: "Action1", handler: { [weak self] (action, view, block) in
	self?.showAlert("Action1")
	})
	action1.backgroundColor = UIColor(hue: 0.56, saturation: 0.56, brightness: 0.55, alpha: 1.0)
	let action2 = UIContextualAction(style: .normal, title: "Action2", handler: { [weak self] (action, view, block) in
	self?.showAlert("Action2")
	})
	action2.backgroundColor = UIColor(hue: 0.35, saturation: 0.33, brightness: 0.55, alpha: 1.0)
	return UISwipeActionsConfiguration(actions: [action1, action2])
	case .trailingAction:
	let action = UIContextualAction(style: .normal, title: item.rawValue, handler: { [weak self] (action, view, block) in
	self?.showAlert(item.rawValue)
	})
	return UISwipeActionsConfiguration(actions: [action])
	case .trailingDestructiveAction:
	let action = UIContextualAction(style: .destructive, title: item.rawValue, handler: { [weak self] (action, view, block) in
	self?.showAlert(item.rawValue)
	})
	return UISwipeActionsConfiguration(actions: [action])
	case .trailingTableViewDefaultAction:
	return nil
	case .leadingAction, .leadingDestructiveAction, .tooManyLeadingActions:
	return UISwipeActionsConfiguration(actions: []) // when returning nil, default actions are shown
	}
	}

view raw UITableViewSwipeActions.swift hosted with ❤ by GitHub

Summary

In summary, swipe actions are extremely simple to add using table view delegates. It is an easy way of providing important actions in an accessible manner.

If this was helpful, please let me know on Mastodon@toomasvahter or Twitter @toomasvahter. Feel free to subscribe to RSS feed. Thank you for reading.

Example project

UITableViewSwipeActions Xcode 10.2, Swift 4.2

Resources

Tags action, swipe, UIContextualAction, UISwipeActionsConfiguration, UITableView

iOS Swift

Circle shaped collection view layout on iOS

Post author By Toomas Vahter
Post date January 20, 2019
5 Comments on Circle shaped collection view layout on iOS

UICollectionViewLayout’s responsibility is to define layout: all the cell locations and sizes. It acts like a data source object which provides layout related information to the collection view. Collection view then uses that information for creating cells and placing them on screen. This time we’ll take a look on how to create a custom circle shaped layout.

Creating UICollectionViewLayout subclass

First step for creating a custom layout is to create UICollectionViewLayout subclass. Then we need to define the size of the layout. In this simple case, all the cells will fit into the available area – therefore we can just return the collection view’s own size.

	override var collectionViewContentSize: CGSize {
	return collectionView?.bounds.size ?? .zero
	}

view raw CircleCollectionViewLayout.swift hosted with ❤ by GitHub

When-ever user rotates the device, the size of the collection view changes, therefore we would like to reset the layout.

	override func shouldInvalidateLayout(forBoundsChange newBounds: CGRect) -> Bool {
	return true
	}

view raw CircleCollectionViewLayout.swift hosted with ❤ by GitHub

Prepare is called whenever layout gets invalidated and it is a best place where to pre-calculate cell locations. Then it is possible to return attributes in all of the other methods querying for attributes later on. This gives us the best possible performance.

Items are placed along a circle which is centred in the collection view. As collection view can be under navigation bar, then the frame of the circle needs to take account contentOffset. Moreover, as centre points of items are on the circle, we also need to take account the item size. Calculating positions for items is just a matter of applying simple trigonometry with right-angled triangles.

	private var layoutCircleFrame = CGRect.zero
	private let layoutInsets = UIEdgeInsets(top: 8, left: 8, bottom: 8, right: 8)
	private let itemSize = CGSize(width: 100, height: 100)
	private var itemLayoutAttributes = [UICollectionViewLayoutAttributes]()

	override func prepare() {
	super.prepare()
	guard let collectionView = collectionView else { return }
	itemLayoutAttributes.removeAll()
	layoutCircleFrame = CGRect(origin: .zero, size: collectionViewContentSize)
	.inset(by: layoutInsets)
	.insetBy(dx: itemSize.width / 2.0, dy: itemSize.height / 2.0)
	.offsetBy(dx: collectionView.contentOffset.x, dy: collectionView.contentOffset.y)
	.insetBy(dx: -collectionView.contentOffset.x, dy: -collectionView.contentOffset.y)

	for section in 0..<collectionView.numberOfSections {
	switch section {
	case 0:
	let itemCount = collectionView.numberOfItems(inSection: section)
	itemLayoutAttributes = (0..<itemCount).map({ (index) -> UICollectionViewLayoutAttributes in
	let angleStep: CGFloat = 2.0 * CGFloat.pi / CGFloat(itemCount)
	// CGRect extension for center and innerRadius: https://gist.github.com/laevandus/07955ff394984bda6de4922734429c84
	var position = layoutCircleFrame.center
	position.x += layoutCircleFrame.size.innerRadius * cos(angleStep * CGFloat(index))
	position.y += layoutCircleFrame.size.innerRadius * sin(angleStep * CGFloat(index))
	let indexPath = IndexPath(item: index, section: section)
	let attributes = UICollectionViewLayoutAttributes(forCellWith: indexPath)
	attributes.frame = CGRect(center: position, size: itemSize)
	return attributes
	})
	default:
	fatalError("Unhandled section \(section).")
	}
	}
	}

view raw CircleCollectionViewLayout.swift hosted with ❤ by GitHub

If we have pre-calculated attributes, then it is straight-forward to return them in the layout attributes methods. When adding or removing items, cells will move to new location with a nice animation by default.

	override func layoutAttributesForElements(in rect: CGRect) -> [UICollectionViewLayoutAttributes]? {
	return itemLayoutAttributes
	}

	override func layoutAttributesForItem(at indexPath: IndexPath) -> UICollectionViewLayoutAttributes? {
	let numberOfItems = collectionView?.numberOfItems(inSection: indexPath.section) ?? 0
	guard numberOfItems > 0 else { return nil }
	switch indexPath.section {
	case 0:
	return itemLayoutAttributes[indexPath.item]
	default:
	fatalError("Unknown section \(indexPath.section).")
	}
	}

view raw CircleCollectionViewLayout.swift hosted with ❤ by GitHub

I would like to highlight the fact that content presented here is just a bare minimum for setting up custom collection view layout. UICollectionView is highly configurable.

Setting up collection view

When custom collection view layout is ready, it is time to hook it up to the collection view. Custom collection view layout can be set in storyboard or when initialising collection view or collection view controller.

Implementing a basic collection view controller for just showing one type of cells requires only a little bit of code. Data source methods provide the count of the items and sections and return configured collection view cells.

	final class CollectionViewController: UICollectionViewController {

	// MARK: Managing the View

	enum ReuseIdentifier: String {
	case item = "ItemCell"
	}

	override func viewDidLoad() {
	super.viewDidLoad()
	collectionView!.register(CircleCollectionViewCell.self, forCellWithReuseIdentifier: ReuseIdentifier.item.rawValue)
	navigationItem.rightBarButtonItem = UIBarButtonItem(barButtonSystemItem: .add, target: self, action: #selector(addItem))
	}

	// MARK: Managing the Content

	private var items: [UIColor] = [.random(), .random(), .random()]

	@objc private func addItem() {
	items.append(.random())
	collectionView.insertItems(at: [IndexPath(item: items.count – 1, section: 0)])
	}

	// MARK: Collection View Data Source

	override func numberOfSections(in collectionView: UICollectionView) -> Int {
	return items.count > 0 ? 1 : 0
	}

	override func collectionView(_ collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int {
	return items.count
	}

	override func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {
	let cell = collectionView.dequeueReusableCell(withReuseIdentifier: ReuseIdentifier.item.rawValue, for: indexPath) as! CircleCollectionViewCell
	cell.backgroundView?.backgroundColor = items[indexPath.item]
	cell.titleLabel.text = "\(indexPath.item)"
	return cell
	}
	}

view raw CollectionViewController.swift hosted with ❤ by GitHub