Expandable Cells

Summary

Для того, чтобы сделать разворачивающиеся ячейки в своем проекте, необходимо:

• использовать форк TableKit
• реализовать протокол Expandable для ячейки, которая должна разворачиваться

В репозитории ExpandableCellDemo-ios вы можете посмотреть примеры реализации для ячеек, сверстанных на SnapKit, PinLayout, фреймах. Ячейка в примере содержит представление произвольной высоты (многострочный label).

TableKit

Для того, чтобы ячейки разворачивались/сворачивались плавно, без скачков и артефактов, необходимо, чтобы высота каждой ячейки на экране была подсчитана. Использование estimatedHeight ведет к вышеуказанным недостаткам. Форк содержит калькулятор высоты ExpandableCellHeightCalculator, который необходимо использовать при инициализации TableDirector:

private lazy var tableDirector = TableDirector(tableView: tableView,
                                               cellHeightCalculator: ExpandableCellHeightCalculator(tableView: tableView))

Благодаря этому точная высота подсчитывается автоматически для ячеек, сверстанных как с помощью AutoLayout, так и вручную. Также этот калькулятор позволяет менять высоту для конктретной ячейки.

Используйте этот калькулятор только на экранах, содержащих раскрывающиеся ячейки.

Вы по-прежнему можете использовать defaultHeight в статических ячейках. Но не используйте estimatedHeight для self-sized ячеек, высота для таких ячеек будет подсчитана автоматически калькулятором высоты.

Верстка ячейки

Создайте представление, которое будет содержать все остальные.

let containerView = UIView()

Добавьте его в contentView.

Если вы используете AutoLayout, укажите высоту 0 для containerView. Сохраните constraint высоты heightConstraint в ячейке. В дальнейшем мы будем менять его при сворачивании/разворачивании.

Важно:

• Если в вашей ячейке есть многострочные label'ы и вы верстаете с помощью AutoLayout, указывайте label.preferredMaxLayoutWidth. Это необходимо сделать не только для раскрывающейся ячейки, но и для всех остальных ячеек на экране, содержащем раскрывающиеся ячейки. Если вы не укажете label.preferredMaxLayoutWidth, высота ячейки будет подсчитана неверно.

Поэтому лучше явно указывать preferredMaxLayoutWidth в зависимости от ширины ячейки. Передавайте ширину во viewModel ячейки и устанавливайте preferredMaxLayoutWidth в configure(with _: MyExpandableCellViewModel).

func configure(with viewModel: MyExpandableCellViewModel) {
    ...

    label.preferredMaxLayoutWidth = viewModel.width - 2 * textMargin

    ...
}

• Самое нижнее subview, содержащееся в containerView (которое будет показано в развернутом состоянии в самом низу), не должно иметь bottom constraint к containerView. Это также помешает правильному расчету высоты.

• Установите clipsToBounds = true для ячейки, чтобы представления развернутого состояния не появлялись за границами ячейки.

Expandable

Для создания раскрывающейся ячейки необходимо сделать следующее.

1. ViewModel ячейки должна быть классом и реализовать протокол ExpandableCellViewModel

class MyExpandableCellViewModel: ExpandableCellViewModel {

    var expandableState: ExpandableState = .expanded

}

Свойство expandableState будет меняться автоматически, вы не должны менять его вручную. Значение свойства, прописанное в коде - это начальное состояние ячейки. Вы можете указать любое.

В случае, если вам нужны промежуточные состояния, кроме collapsed и expanded, добавьте доступные состояния. Лучше создать для каждого кастомного состояния отдельную статическую константу. Так будет легче на него впоследствии переключаться.

class MyExpandableCellViewModel: ExpandableCellViewModel {

    var expandableState: ExpandableState = .expanded


    static let oneLineState: ExpandableState = .height(value: collapsedHeight + 40)
    
    static let twoLinesState: ExpandableState = .height(value: collapsedHeight + 60)
    
    static let threeLinesState: ExpandableState = .height(value: collapsedHeight + 80)

}

Если вы хотите, чтобы состояния переключались по очереди без указания, на какое конкретно состояние нужно переключиться (как в примере по тапу на свернутое представление), добавьте массив availableStates. В каком бы состоянии вы сейчас ни находились, вызвав toggleState() вы перейдете в следующее за ним состояние в массиве availableStates.

class MyExpandableCellViewModel: ExpandableCellViewModel {

    var expandableState: ExpandableState = .expanded


    static let oneLineState: ExpandableState = .height(value: collapsedHeight + 40)
    
    static let twoLinesState: ExpandableState = .height(value: collapsedHeight + 60)
    
    static let threeLinesState: ExpandableState = .height(value: collapsedHeight + 80)

    var availableStates: [ExpandableState] = [
        .collapsed,
        oneLineState,
        twoLinesState,
        threeLinesState,
        .expanded
    ]

}

Если вам нужны только состояния collapsed и expanded или вы будете вручную переключать состояния, availableStates указывать НЕ нужно.

2. Реализуйте протокол ConfigurableCell для ячейки

Обратите внимание на статическое свойство layoutType, добавленное в протокол ConfigurableCell форка. Свойство указывает на тип layout'а, используемого для верстки ячейки. Возможные значения - .auto (AutoLayout, SnapKit), .manual (Frames, PinLayout). Тип влияет на механизм расчета высоты ячейки. Значение по умолчанию .auto, так что если вы верстаете с помощью AutoLayout'а, можете тип не указывать.

Необходимо сохранить ссылку на viewModel в ячейке.

final class ExpandableAutolayoutCell: UITableViewCell, ConfigurableCell {

    // MARK: - Properties

    private(set) weak var viewModel: MyExpandableCellViewModel?

    // MARK: - ConfigurableCell

    func configure(with viewModel: MyExpandableCellViewModel) {
        self.viewModel = viewModel

        ...
    }

    static var layoutType: LayoutType {
        return .auto
    }

}

3. Реализуйте протокол Expandable.

Вызовите метод initState() в конце configure(with _: MyExpandableCellViewModel). initState переводит ячейку в состояние, соответствующее свойству expandableState viewModel'и.

Реализуйте функцию configure(state: ExpandableState). Функция должна содержать изменения представления ячейки, которые происходят при разворачивании/сворачивании.

Измените constraint высоты container'а в зависимости от свойства state. В данном примере в развернутом состоянии у нас показывается UILabel произвольной длины (numberOfLines = 0). Чтобы получить высоту для развернутого состояния, берем label.frame.maxY. Также можете добавить произвольный margin снизу. Калькулятор высоты его учтет.

Меняйте цвет/прозрачноть и все, что должно меняться при разворачивании/сворачивании. Все изменения, описанные в configure(state: ExpandableState), будут автоматически анимироваться.

final class ExpandableAutolayoutCell: UITableViewCell, ConfigurableCell, Expandable {

    // MARK: - ConfigurableCell

    func configure(with viewModel: MyExpandableCellViewModel) {

        ...


        initState()
    }

    // MARK: - Expandable

    func configure(state: ExpandableState) {
        guard let viewModel = viewModel else {
            return
        }

        heightConstraint?.layoutConstraints.first?.constant = state.isCollapsed
            ? BaseTableViewCell.collapsedHeight
            : state.height ?? (label.frame.maxY + BaseTableViewCell.bottomMargin)

        containerView.backgroundColor = state.isCollapsed ? viewModel.collapsedColor : .random()

        label.alpha = state.isCollapsed ? 0 : 1
    }

}

Если у вас всего два состояния ячейки, используйте упрощенный (слегка) код для изменения heightConstraint:

heightConstraint?.layoutConstraints.first?.constant = state.isCollapsed
    ? BaseTableViewCell.collapsedHeight
    : (label.frame.maxY + BaseTableViewCell.bottomMargin)

Как вы можете видеть, здесь нет state.height по сравнению с кодом выше. state.height необходимо указывать, чтобы учитывать промежуточные состояния.

4. Меняйте состояние ячейки

Если у вас всего два состояния ячейки, создайте обработчик тапа для свернутого представления ячейки. Вызовите в нем метод toggleState().

Если ячейка свернута, она развернется и свойство state viewModel'и изменится на expanded. Если ячейка развернута, она свернется и state изменится на collapsed.

В случае наличия промежуточных состояний, toggleState() будет переключать их по очереди. Для принудительного перехода в любое состояния вызовите transition(to: ExpandableState), например:

transition(to: MyExpandableCellViewModel.oneLineState)
transition(to: .expanded)
transition(to: .collapsed)

Данные методы используют configure(state: ExpandableState) и обновляют таблицу.