SwipeCollectionViewCell

open class SwipeCollectionViewCell: UICollectionViewCell

The SwipeCollectionViewCell class extends UICollectionViewCell and provides more flexible options for cell swiping behavior.

The default behavior closely matches the stock Mail.app. If you want to customize the transition style (ie. how the action buttons are exposed), or the expansion style (the behavior when the row is swiped passes a defined threshold), you can return the appropriately configured SwipeOptions via the SwipeCollectionViewCellDelegate delegate.

  • The point at which the origin of the cell is offset from the non-swiped origin.

    Declaration

    Swift

    public var swipeOffset: CGFloat
  • Hides the swipe actions and returns the cell to center.

    Declaration

    Swift

    public func hideSwipe(animated: Bool, completion: ((Bool) -> Void)? = nil)

    Parameters

    animated

    Specify true to animate the hiding of the swipe actions or false to hide it immediately.

    completion

    The closure to be executed once the animation has finished. A Boolean argument indicates whether or not the animations actually finished before the completion handler was called.

  • Shows the swipe actions for the specified orientation.

    Declaration

    Swift

    public func showSwipe(orientation: SwipeActionsOrientation, animated: Bool = true, completion: ((Bool) -> Void)? = nil)

    Parameters

    orientation

    The side of the cell on which to show the swipe actions.

    animated

    Specify true to animate the showing of the swipe actions or false to show them immediately.

    completion

    The closure to be executed once the animation has finished. A Boolean argument indicates whether or not the animations actually finished before the completion handler was called.

  • The point at which the origin of the cell is offset from the non-swiped origin.

    Declaration

    Swift

    public func setSwipeOffset(_ offset: CGFloat, animated: Bool = true, completion: ((Bool) -> Void)? = nil)

    Parameters

    offset

    A point (expressed in points) that is offset from the non-swiped origin.

    animated

    Specify true to animate the transition to the new offset, false to make the transition immediate.

    completion

    The closure to be executed once the animation has finished. A Boolean argument indicates whether or not the animations actually finished before the completion handler was called.