MimiCheckbox

@MainActor
open class MimiCheckbox : MimiControl

Simple square checkbox that can be used to toggle boolean values.

Properties
  • tintColor

    Primary tint color of the checkbox.

    This styles the filled background of the checkbox.

    Declaration

    Swift

    @MainActor
open override var tintColor: UIColor! { get set }
  • highlightedTintColor

    Primary tint color to use when highlighted.

    This styles the filled background of the checkbox when it is highlighted.

    Declaration

    Swift

    @MainActor
open var highlightedTintColor: UIColor! { get set }
  • uncheckedTintColor

    Tint color for the checkbox when unchecked.

    This applies to the stroke around the checkbox when it is not checked.

    Declaration

    Swift

    @MainActor
open var uncheckedTintColor: UIColor! { get set }
  • uncheckedHighlightedTintColor

    Tint color for the checkbox when unchecked and highlighted.

    This applies to the stroke around the checkbox when it is not checked when highlighted.

    Declaration

    Swift

    @MainActor
open var uncheckedHighlightedTintColor: UIColor! { get set }
  • isChecked

    Whether the checkbox is currently checked.

    Declaration

    Swift

    @MainActor
open var isChecked: Bool { get }

Lifecycle
  • construct(in:)
    Declaration

    Swift

    @MainActor
open override func construct(in view: UIView)

State
  • setChecked(_:animated:)

    Update the checked state of the checkbox.

    Declaration

    Swift

    @MainActor
open func setChecked(_ isChecked: Bool,
                     animated: Bool)
    Parameters
    isChecked

    Whether the box should be checked.
    animated

    Whether to animate the transition.

MimiThemeable