About

A Swift package that enables customisation of UIKit's table or collection view swipe actions. This package swizzles the layoutSubviews method of UIKit's internal UISwipeActionPullView to apply a custom layout and, where necessary, insert custom subviews into the view hierarchy.

Demo.mp4

Because this package relies on UIKit's existing swipe actions implementation, you get all the benefits of Apple's natural gestures and accessibility.

While this package has shipped in production apps, you should use it at your own risk as this could be considere private API usage.

Usage

1. Import UICustomSwipeActions in your application delegate file. Call UICustomSwipeActionsConfiguration.configure() in application(_:didFinishLaunchingWithOptions:).

import UIKit
import UICustomSwipeActions

@main
class AppDelegate: UIResponder, UIApplicationDelegate {

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        UICustomSwipeActionsConfiguration.configure()
        return true
    }
}

2. Replace your existing UISwipeActionsConfiguration with a UICustomSwipeActionsConfiguration.

   You can customise such properties as the preferredButtonWidth, preferredButtonSpacing and preferredButtonStyle, along with the standard UISwipeActionsConfiguration properties.

class ViewController: UIViewController, UITableViewDelegate {

  func tableView(_ tableView: UITableView, trailingSwipeActionsConfigurationForRowAt indexPath: IndexPath) -> UISwipeActionsConfiguration? {
        let deleteAction = UIContextualAction(style: .destructive, title: "Delete") { ... }
        deleteAction.image = UIImage(systemName: "trash.fill")
        deleteAction.backgroundColor = .systemRed

        let configuration = UICustomSwipeActionsConfiguration(actions: actions)
        configuration.preferredButtonWidth = 58
        configuration.preferredButtonSpacing = 16
        configuration.preferredButtonStyle = .circular
        configuration.performsFirstActionWithFullSwipe = false
        
        return configuration
  }
}

3. That's it! You're good to go. All you have to do is build and run!