FUIFilterFormCell

@MainActor
open class FUIFilterFormCell : FUIInlineValidationDrawingTableViewCell<FUIFilterFormView>, FUIFormCell

A UITableViewCell subclass, which allows a user to read or enter a set of values, using a grid of buttons. Commonly used for composing filters.

The developer should set the following properties on the cell, in their implementation of UITableViewDataSource cellForRow(at:) function:

• keyName: The key name of the property.
• value: An array of the selected indexes in the control. Uses the same index as the valueOptions array.
• `valueOptions: A String array, of titles for the buttons in the control

And an onChangeHandler:

• onChangeHandler: a handler closure, which is invoked on changes to the value

Optionally, the developer may provide

• allowsMultipleSelection: Indicates if multiple buttons may be selected simultaneously (true). If false, the control behaves in “radio” mode. Defaults to true.
• allowsEmptySelection: Indicates if the control allows zero items to be selected (true). If false, then once a value has been selected by the developer or user, taps by the user on the last selected item will be ignored, instead of de-selecting the item. Defaults to true.
• isEditable: Indicates if the cell’s value may be modified. Defaults to true.

Color setting:

Setting text color of filter buttons for a state using setTintColor(_:for:) api. Currently disabled, normal and selected are supported.

 cell.setTintColor(UIColor.red, for: .normal)

Accessibility Identifier setting:

• keyLabel.accessibilityIdentifier: Set the accessibility identifier for the keyLabel element within the cell.
• filterValueView.accessibilityIdentifier: Setting this value will make the accessibilityIdentifier of each filterValueView item to have this value as a prefix, to avoid duplication issues.
• validationView.titleLabel.accessibilityIdentifier: Setting the accessibility identifier for the titleLabel within the validationView.

The following is an example of usage in an application UITableViewController:

 // optionally, create an array of value option to localized string mappings
  let buttonTitles: [[String: String]] = [["radius": "Distance"], ["price": "Price"], ["rating": "Ratings"], ["avail": "Availability"]]

 // Register FUIFilterFormCell in viewDidLoad() method in the controller.
 override func viewDidLoad() {
     super.viewDidLoad()
     self.tableView.register(FUIFilterFormCell.self, forCellReuseIdentifier: FUIFilterFormCell.reuseIdentifier)
 }

 override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
     let cell = tableView.dequeueReusableCell(withIdentifier: FUIFilterFormCell.reuseIdentifier, for: indexPath) as! FUIFilterFormCell

     cell.valueOptions = buttonTitles.flatMap { $0.map { $0.value }}
     cell.keyName = "Sort By"
     cell.value = [1]
     cell.allowsMultipleSelection = true
     cell.allowsEmptySelection = false

     // MARK:  implement onChangeHandler
     cell.onChangeHandler = { [weak self] newValue in
        self.applyFilter(forDimensions: newValue)      // here, the cell input is set to a filter function
     }

    return cell
 }

## Theming Supported style classes

 fdlFUIFilterFormCell
 fdlFUIFilterFormCell_keyLabel
 fdlFUIFilterFormCell_item_contentView
 fdlFUIFilterFormCell_item_titleLabel
 fdlFUIFilterFormCell_item_contentView_selected
 fdlFUIFilterFormCell_item_titleLabel_selected