ForagePANTextField

public class ForagePANTextField : UIView, Identifiable, ForageElement, ForageElementDelegate

extension ForagePANTextField : UITextFieldDelegate

Show on GitHub

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

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
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


                    
                    
                    padding

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
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
clearButtonMode
Allow user to clear text field clearButtonMode default value is never
Declaration
Swift

@IBInspectable public var clearButtonMode: UITextField.ViewMode { get set }
Show on GitHub
font
Change UIFont UITextField text font
Declaration
Swift

@IBInspectable public var font: UIFont? { get set }
Show on GitHub


                    
                    
                    elementHeight

Declaration

Swift

@IBInspectable
public var elementHeight: CGFloat { get set }

Show on GitHub

Public Delegate

delegate
A delegate that informs the client about the state of the entered card number (validation, focus).
Declaration
Swift

public weak var delegate: ForageElementDelegate?
Show on GitHub

Lifecycle methods

awakeFromNib()
Declaration
Swift

override public func awakeFromNib()
Show on GitHub

Public API


                    
                    
                    intrinsicContentSize

Declaration

Swift

override public var intrinsicContentSize: CGSize { get }

Show on GitHub

setPlaceholderText(_:)
Declaration
Swift

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

public func clearText()
Show on GitHub

UITextFieldDelegate


                    
                    
                    focusDidChange(_:)

Declaration

Swift

public func focusDidChange(_ state: ObservableState)

Show on GitHub


                    
                    
                    textFieldDidChange(_:)

Declaration

Swift

public func textFieldDidChange(_ state: ObservableState)

Show on GitHub


                    
                    
                    textFieldDidBeginEditing(_:)

Declaration

Swift

public func textFieldDidBeginEditing(_ textField: UITextField)

Show on GitHub


                    
                    
                    textFieldDidEndEditing(_:)

Declaration

Swift

public func textFieldDidEndEditing(_ textField: UITextField)

Show on GitHub


                    
                    
                    textField(_:shouldChangeCharactersIn:replacementString:)

Determines whether the text field should allow a change of characters within the specified range. This method is called when the user attempts to change the content of the text field.

Declaration

Swift

public func textField(_ textField: UITextField, shouldChangeCharactersIn range: NSRange, replacementString: String) -> Bool

Parameters

`textField`	The text field containing the text.
`range`	The range of characters to be replaced.
`replacementString`	The replacement string.

Return Value

true if the changes should be allowed; otherwise, false.

Show on GitHub

UIResponder methods

becomeFirstResponder()
Make ForagePANTextField focused.
Declaration
Swift

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

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

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