CellConfigType

public protocol CellConfigType : CollectionItemConfigType, TableItemConfigType

A type that provides the information required by FunctionalTableData to generate cells.

The key property should be a unique String for the section that the item is contained in. It should also be representative of the item and not just a random value or UUID. This is because on an update pass the key is used to determine if an item has been added, moved, or removed from the data set. Using a stable value means that this can correctly be determined.

The isEqual function is used to determine if two CellConfigType’s have matching keys and they represent the same data. This allows the system to update the views state directly when something has changed instead of forcing a reload of the entire cell all the time.

When two items have matching key values but the isEqual call between old and new returns false the update function is called. It is the responsibility of this function to update the cell, and any subviews of the cell, to reflect the state.

  • key

    Unique identifier for the cell.

    Declaration

    Swift

    var key: String { get }
    Show on GitHub

  • Indicates a cell style. See CellStyle for more information.

    Declaration

    Swift

    var style: CellStyle? { get set }
    Show on GitHub

  • Indicates all the possible actions a cell can perform. See CellActions for more information.

    Declaration

    Swift

    var actions: CellActions { get }
    Show on GitHub

  • Update the view state of a UITableViewCell. It is up to implementors of the protocol to determine what this means.

    Declaration

    Swift

    func update(cell: UITableViewCell, in tableView: UITableView)

    Parameters

    cell

    A cell view that was dequeued from the UITableView.
    tableView

    The UITableView object holding this cell.
    Show on GitHub

  • Update the view state of a UICollectionViewCell. It is up to implementors of the protocol to determine what this means.

    Declaration

    Swift

    func update(cell: UICollectionViewCell, in collectionView: UICollectionView)

    Parameters

    cell

    A cell view that was dequeued from the UICollectionView.
    collectionView

    The UICollectionView object holding this cell.
    Show on GitHub

  • Compares two cells for equality. Cells will be considered equal if they are of the same type and their states also compare equal.

    Cell equality is used during rendering to determine when an existing cell’s view needs to be updated with new data.

    Declaration

    Swift

    func isEqual(_ other: CellConfigType) -> Bool

    Parameters

    other

    the value to compare against.

    Return Value

    true when both values are the same, false otherwise.

    Show on GitHub