AreaField

public class AreaField : Field, UIGestureRecognizerDelegate

Material version of the UITextView (multiline capable)

Vars

  • Declaration

    Swift

    public override var placeholder: String? { get set }

  • Declaration

    Swift

    override public var text: String? { get set }

  • Declaration

    Swift

    public override var isOptional: Bool { get set }

Colors

  • Declaration

    Swift

    public override var borderColor: UIColor { get set }

  • Declaration

    Swift

    public override var borderHighlightColor: UIColor { get set }

  • Declaration

    Swift

    public override var borderErrorColor: UIColor { get set }

  • Declaration

    Swift

    public override var textColor: UIColor { get set }

  • Declaration

    Swift

    public override var errorTextColor: UIColor { get set }

  • Declaration

    Swift

    public override var placeholderDownColor: UIColor { get set }

  • Declaration

    Swift

    public override var placeholderUpColor: UIColor { get set }

  • Declaration

    Swift

    public override var cursorColor: UIColor { get set }

Keyboard Vars

  • Declaration

    Swift

    public override var keyboardType: UIKeyboardType { get set }

  • Declaration

    Swift

    public override var autocapitalizationType: UITextAutocapitalizationType { get set }

  • Declaration

    Swift

    public override var autocorrectionType: UITextAutocorrectionType { get set }

  • Declaration

    Swift

    public override var isSecureTextEntry: Bool { get set }

Delegate

View Components

  • The placeholder label for the title

    Declaration

    Swift

    public let placeholderLabel: UILabel

  • The UITextView behind this field class

    Declaration

    Swift

    public lazy var textView: UITextView { get set }

  • The error label under the UITextField that appears on error being set

    Declaration

    Swift

    public let errorLabel: UILabel

Init

  • Required initializer if doing programtically. You can manually set the frame after initialization. Otherwise it relies on auto layout and it’s intrinsic content size.

    Warning

    If you want to define a frame for it, make sure the height constant is a minimum of 41.

    Declaration

    Swift

    public required init()

Error Functions

  • Declaration

    Swift

    public override func removeErrorUI()

  • Declaration

    Swift

    override public func setError(withText text: String?)

  • Notifies the field that it has been asked to relinquish its status as first responder in its window. This triggers the end callback from the field and closes the keyboard, removes the editing state.

    Note

    If it’s in an error state it will keep its error UI.

    Declaration

    Swift

    override public func resignFirstResponder() -> Bool

    Return Value

    true

  • Asks UIKit to make the field the first responder in its window.

    Declaration

    Swift

    override public func becomeFirstResponder() -> Bool

    Return Value

    true if became first responder, false otherwise

  • Asks UIKit to make the EntryField is the first responder. Returns true if it becomes the first responder, false otherwise.

    Declaration

    Swift

    override public var isFirstResponder: Bool { get }

  • Returns a boolean indicating wether the EntryField can become the first responder

    Declaration

    Swift

    public override var canBecomeFirstResponder: Bool { get }

UITextView Delegate

  • Forwards to areaFieldShouldBeginEditing

    Declaration

    Swift

    public func textViewShouldBeginEditing(_ textView: UITextView) -> Bool

  • Forwards to areaFieldDidBeginEditing, handles state UI

    Declaration

    Swift

    public func textViewDidBeginEditing(_ textView: UITextView)

  • Forwards to areaFieldShouldEndEditing

    Declaration

    Swift

    public func textViewShouldEndEditing(_ textView: UITextView) -> Bool

  • Forwards to areaFieldDidEndEditing

    Declaration

    Swift

    public func textViewDidEndEditing(_ textView: UITextView)

  • Forwards to shouldChangeTextIn

    Declaration

    Swift

    public func textView(_ textView: UITextView, shouldChangeTextIn range: NSRange, replacementText text: String) -> Bool