CreationKit Documentation

Class Label​Input​Form​Layout

public class LabelInputFormLayout: NSObject, ComponentLayout, LabelInputForm  

A layout used in forms for gathering input from a user.

This form should not be used directly as it only provides base methods for it's subclasses. This layout doesn't directly support any way for the user to input any value into the form.

LabelInputFormLayout LabelInputFormLayout ComponentLayout ComponentLayout LabelInputFormLayout->ComponentLayout LabelInputForm LabelInputForm LabelInputFormLayout->LabelInputForm NSObject NSObject LabelInputFormLayout->NSObject RangedDateInputFormLayout RangedDateInputFormLayout RangedDateInputFormLayout->LabelInputFormLayout DateInputFormLayout DateInputFormLayout DateInputFormLayout->LabelInputFormLayout SheetInputFormLayout SheetInputFormLayout SheetInputFormLayout->LabelInputFormLayout

Subclasses

DateInputFormLayout

A LabelInputFormLayout subclass that uses a DateInputFormLayout for user input.

RangedDateInputFormLayout

A LabelInputFormLayout subclass that uses a DateInputFormLayout for user input. This is similar to the DateInputFormLayout, but is used in cases where the use needs Ranged Selected on the DatePicker.

SheetInputFormLayout

A LabelInputFormLayout subclass that uses a BottomSheet for user input.

Conforms To

ComponentLayout

A protocol to share components (view layouts) across different types.

NSObject

Initializers

init()

required public override init()  

Properties

title

public var title: String?  

The title to display for the input field. Defaults to nil.

attributed​Title

public var attributedTitle: NSAttributedString?  

The attributed title to display for the input field. Defaults to nil.

subtitle

public var subtitle: String?  

The subtitle to display for the input field. Defaults to nil.

text

public var text: String?  

The text in the input field.

placeholder

public var placeholder: String  

The placeholder to display in the input field when text hasn't been entered.

is​Highlighted

public var isHighlighted: Bool = false  

error​Message

public var errorMessage: String?  

An error message for the input. If this string is nil, a message won't be displayed, otherwise it will be displayed when an error occurs in the input field. Defaults to nil.

helper​Message

public var helperMessage: String?  

An explanatory message that sits below the input. It is hidden in the case of a validation error.

right​Accessory​View​Size

public var rightAccessoryViewSize: CGSize  

right​Accessory​View

public var rightAccessoryView: UIView?  

state

public var state: InputFieldState  

tint​Color

public var tintColor: UIColor  

Methods

layout(on:​)

public func layout(on view: UIView)