Back to Swipecellkit

SwipeOptions

docs/docsets/SwipeCellKit.docset/Contents/Resources/Documents/Structs/SwipeOptions.html

2.7.13.0 KB
Original Source

SwipeOptions

public struct SwipeOptions

The SwipeOptions class provides options for transistion and expansion behavior for swiped cell.

`

                transitionStyle
                `

The transition style. Transition is the style of how the action buttons are exposed during the swipe.

Declaration

Swift

public var transitionStyle: SwipeTransitionStyle = .border

`

                expansionStyle
                `

The expansion style. Expansion is the behavior when the cell is swiped past a defined threshold.

Declaration

Swift

public var expansionStyle: SwipeExpansionStyle?

`

                expansionDelegate
                `

The object that is notified when expansion changes.

Note

If an expansionDelegate is not provided, and the expanding action is configured with a clear background, the system automatically uses the default ScaleAndAlphaExpansion to show/hide underlying actions.

Declaration

Swift

public var expansionDelegate: SwipeExpanding?

`

                backgroundColor
                `

The background color behind the action buttons.

Declaration

Swift

public var backgroundColor: UIColor?

`

                maximumButtonWidth
                `

The largest allowable button width.

Note

By default, the value is set to the table/collection view divided by the number of action buttons minus some additional padding. If the value is set to 0, then word wrapping will not occur and the buttons will grow as large as needed to fit the entire title/image.

Declaration

Swift

public var maximumButtonWidth: CGFloat?

`

                minimumButtonWidth
                `

The smallest allowable button width.

Note

By default, the system chooses an appropriate size.

Declaration

Swift

public var minimumButtonWidth: CGFloat?

`

                buttonVerticalAlignment
                `

The vertical alignment mode used for when a button image and title are present.

Declaration

Swift

public var buttonVerticalAlignment: SwipeVerticalAlignment = .centerFirstBaseline

`

                buttonPadding
                `

The amount of space, in points, between the border and the button image or title.

Declaration

Swift

public var buttonPadding: CGFloat?

`

                buttonSpacing
                `

The amount of space, in points, between the button image and the button title.

Declaration

Swift

public var buttonSpacing: CGFloat?

`

                init()
                `

Constructs a new SwipeOptions instance with default options.

Declaration

Swift

public init()

© 2018 Mohammad Kurabi. All rights reserved. (Last updated: 2018-05-26)

Generated by jazzy ♪♫ v0.8.4, a Realm project.