ForageSDK Reference ForagePINTextField Class Reference

ForagePINTextField

public class ForagePINTextField : UIView, Identifiable, ForageElement

Show on GitHub

Properties

pinType
Declaration
Swift

public var pinType: PinType
Show on GitHub
delegate
Delegate that updates client’s side about state of the entered pin
Declaration
Swift

public weak var delegate: ForageElementDelegate?
Show on GitHub

Exposed properties


                    
                    
                    isEmpty

Declaration

Swift

@IBInspectable
public var isEmpty: Bool { get }

Show on GitHub


                    
                    
                    isValid

Declaration

Swift

@IBInspectable
public var isValid: Bool { get }

Show on GitHub


                    
                    
                    isComplete

Declaration

Swift

@IBInspectable
public var isComplete: Bool { get }

Show on GitHub

cornerRadius
CornerRadius for the text field
Declaration
Swift

@IBInspectable public var cornerRadius: CGFloat { get set }
Show on GitHub
masksToBounds
MasksToBounds for the text field
Declaration
Swift

@IBInspectable public var masksToBounds: Bool { get set }
Show on GitHub
borderWidth
BorderWidth for the text field
Declaration
Swift

@IBInspectable public var borderWidth: CGFloat { get set }
Show on GitHub
borderColor
BorderColor for the text field
Declaration
Swift

@IBInspectable public var borderColor: UIColor? { get set }
Show on GitHub


                    
                    
                    padding

Padding for the text field

Declaration

Swift

@IBInspectable
public var padding: UIEdgeInsets { get set }

Show on GitHub

placeholder
Placeholder for the text field
Declaration
Swift

@IBInspectable public var placeholder: String? { get set }
Show on GitHub
textColor
Text color for the text field textColor default value is black
Declaration
Swift

@IBInspectable public var textColor: UIColor? { get set }
Show on GitHub


                    
                    
                    backgroundColor

BackgroundColor for the text field

Declaration

Swift

@IBInspectable
public override var backgroundColor: UIColor? { get set }

Show on GitHub

size
Size of the text for the text field size default value is 24
Declaration
Swift

@IBInspectable public var size: Double { get set }
Show on GitHub
tfTintColor
Tint color for the text field tfTintColor default value is black
Declaration
Swift

@IBInspectable public var tfTintColor: UIColor? { get set }
Show on GitHub
textAlignment
Text alignment textAlignment default value is natural
Declaration
Swift

@IBInspectable public var textAlignment: NSTextAlignment { get set }
Show on GitHub
font
Change UIFont VGSTextField text font
Declaration
Swift

@IBInspectable public var font: UIFont? { get set }
Show on GitHub
inputWidth
Width of the input field within the ForagePINTextField.

See also
inputHeight to customize the height of the input field within the ForagePINTextField.
Declaration
Swift

@IBInspectable public var inputWidth: CGFloat { get set }
Show on GitHub
inputHeight
Height of the input field within the ForagePINTextField.

See also
elementHeight to customize the height of the entire ForagePINTextField.
Declaration
Swift

@IBInspectable public var inputHeight: CGFloat { get set }
Show on GitHub


                    
                    
                    elementHeight

Declaration

Swift

@IBInspectable
public var elementHeight: CGFloat { get set }

Show on GitHub

Lifecycle methods

awakeFromNib()
Declaration
Swift

override public func awakeFromNib()
Show on GitHub

Public API

clearText()
Declaration
Swift

public func clearText()
Show on GitHub
setPlaceholderText(_:)
Declaration
Swift

public func setPlaceholderText(_ text: String)
Show on GitHub

UIResponder methods

becomeFirstResponder()
Make ForagePINTextField focused.
Declaration
Swift

@discardableResult override public func becomeFirstResponder() -> Bool
Show on GitHub
resignFirstResponder()
Remove focus from ForagePINTextField.
Declaration
Swift

@discardableResult override public func resignFirstResponder() -> Bool
Show on GitHub
isFirstResponder
Check if ForagePINTextField is focused.
Declaration
Swift

override public var isFirstResponder: Bool { get }
Show on GitHub