VGSTextField

@MainActor
public class VGSTextField : UIView

extension VGSTextField: UITextFieldDelegate

extension VGSTextField: @preconcurrency MaskedTextFieldDelegate

An object that displays an editable text area in user interface.

Show on GitHub

UI Attributes

placeholder
Textfield placeholder string.
Declaration
Swift

@MainActor public var placeholder: String? { get set }
Show on GitHub
autocapitalizationType
Textfield autocapitalization type. Default is .sentences.
Declaration
Swift

@MainActor public var autocapitalizationType: UITextAutocapitalizationType { get set }
Show on GitHub
spellCheckingType
Textfield spell checking type. Default is UITextSpellCheckingType.default.
Declaration
Swift

@MainActor public var spellCheckingType: UITextSpellCheckingType { get set }
Show on GitHub
attributedPlaceholder
Textfield attributedPlaceholder string.
Declaration
Swift

@MainActor public var attributedPlaceholder: NSAttributedString? { get set }
Show on GitHub
intrinsicContentSize
The natural size for the Textfield, considering only properties of the view itself.
Declaration
Swift

@MainActor public override var intrinsicContentSize: CGSize { get }
Show on GitHub
padding
UIEdgeInsets for text and placeholder inside VGSTextField.
Declaration
Swift

@MainActor public var padding: UIEdgeInsets { get set }
Show on GitHub
textAlignment
The technique to use for aligning the text.
Declaration
Swift

@MainActor public var textAlignment: NSTextAlignment { get set }
Show on GitHub
clearButtonMode
Sets when the clear button shows up. Default is UITextField.ViewMode.never
Declaration
Swift

@MainActor public var clearButtonMode: UITextField.ViewMode { get set }
Show on GitHub
isSecureTextEntry
Identifies whether the text object should disable text copying and in some cases hide the text being entered. Default is false.
Declaration
Swift

@MainActor public var isSecureTextEntry: Bool { get set }
Show on GitHub
adjustsFontForContentSizeCategory
Indicates whether VGSTextField should automatically update its font when the device’s UIContentSizeCategory is changed.
Declaration
Swift

@MainActor public var adjustsFontForContentSizeCategory: Bool { get set }
Show on GitHub


                    
                    
                    keyboardAccessoryView

Input Accessory View

Declaration

Swift

@MainActor
public var keyboardAccessoryView: UIView? { get set }

Show on GitHub

autocorrectionType
Determines whether autocorrection is enabled or disabled during typing.
Declaration
Swift

@MainActor public var autocorrectionType: UITextAutocorrectionType { get set }
Show on GitHub

Accessibility Attributes

textFieldAccessibilityLabel
A succinct label in a localized string that identifies the accessibility text field.
Declaration
Swift

@MainActor public var textFieldAccessibilityLabel: String? { get set }
Show on GitHub
textFieldAccessibilityHint
A localized string that contains a brief description of the result of performing an action on the accessibility text field.
Declaration
Swift

@MainActor public var textFieldAccessibilityHint: String? { get set }
Show on GitHub
textFieldIsAccessibilityElement
Boolean value that determinates if the text field should be exposed as an accesibility element.
Declaration
Swift

@MainActor public var textFieldIsAccessibilityElement: Bool { get set }
Show on GitHub

Functional Attributes

configuration
Specifies VGSTextField configuration parameters to work with VGSCollect.
Declaration
Swift

@MainActor public var configuration: VGSConfiguration? { get set }
Show on GitHub
delegate
Delegates VGSTextField editing events. Default is nil.
Declaration
Swift

@MainActor public weak var delegate: VGSTextFieldDelegate?
Show on GitHub

Manage input

setDefaultText(_:)
Set textfield default text.

Note
This will not change State.isDirty attribute.
- Discussion: probably you should want to set field configuration before setting default value, so the input format will be update as required.
Declaration
Swift

@MainActor public func setDefaultText(_ text: String?)
Show on GitHub
cleanText()
Removes input from field.
Declaration
Swift

@MainActor public func cleanText()
Show on GitHub

Compare Input

isContentEqual(_:)
Check if input text in two textfields is same. Returns Bool.

Note
Result will be based on raw text, mask and dividers will be ignored.
Declaration
Swift

@MainActor public func isContentEqual(_ textField: VGSTextField) -> Bool
Show on GitHub

Text Attribute

font
VGSTextField text font
Declaration
Swift

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


                    
                    
                    textColor

VGSTextField text color

Declaration

Swift

@IBInspectable
@MainActor
var textColor: UIColor? { get set }

Show on GitHub

UI Layer Attribute

cornerRadius
VGSTextField layer corner radius
Declaration
Swift

@IBInspectable @MainActor var cornerRadius: CGFloat { get set }
Show on GitHub


                    
                    
                    borderWidth

VGSTextField layer borderWidth

Declaration

Swift

@IBInspectable
@MainActor
var borderWidth: CGFloat { get set }

Show on GitHub


                    
                    
                    borderColor

VGSTextField layer borderColor

Declaration

Swift

@IBInspectable
@MainActor
var borderColor: UIColor? { get set }

Show on GitHub

statePublisher
VGSTextFieldStatePublisher publisher that emits the State of a given VGSTextField.
Declaration
Swift

@MainActor var statePublisher: VGSTextFieldStatePublisher { get }
Show on GitHub

UIResponder methods


                    
                    
                    becomeFirstResponder()

Make VGSTextField focused.

Declaration

Swift

@discardableResult
@MainActor
override public func becomeFirstResponder() -> Bool

Show on GitHub


                    
                    
                    resignFirstResponder()

Remove focus from VGSTextField.

Declaration

Swift

@discardableResult
@MainActor
override public func resignFirstResponder() -> Bool

Show on GitHub

isFirstResponder
Check if VGSTextField is focused.
Declaration
Swift

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