VGSShowSDK Reference VGSLabel Class Reference

VGSLabel

public final class VGSLabel : UIView, VGSLabelProtocol

A view that displays revealed text data.

Show on GitHub

Enums

CopyTextFormat
Text format to copy.
See more
Declaration
Swift

@objc public enum CopyTextFormat : Int
Show on GitHub

Delegates

delegate
The object that acts as the delegate of the VGSLabel.
Declaration
Swift

public weak var delegate: VGSLabelDelegate?
Show on GitHub

Public interface


                    
                    
                    addTransformationRegex(_:template:)

Add transformation regex to format raw revealed text.

Declaration

Swift

public func addTransformationRegex(_ regex: NSRegularExpression, template: String)

Parameters

`regex`	`NSRegularExpression` object, transformation regex.
`template`	`String` object, template for replacement.

Show on GitHub

contentPath
Name that will be associated with VGSLabel and used as a decoding contentPath on request response with revealed data from your organization vault.
Declaration
Swift

public var contentPath: String! { get set }
Show on GitHub
isEmpty
A Boolean value indicating whether VGSLabel string is empty.
Declaration
Swift

public var isEmpty: Bool { get }
Show on GitHub
revealedRawTextLength
Revealed text length.
Declaration
Swift

public var revealedRawTextLength: Int { get }
Show on GitHub
placeholder
Placeholder text.
Declaration
Swift

public var placeholder: String? { get set }
Show on GitHub


                    
                    
                    placeholderStyle

Placeholder text styles.

Declaration

Swift

public var placeholderStyle: VGSPlaceholderLabelStyle { get set }

Show on GitHub

isSecureText
Bool flag. Apply secure mask if true. If secure range is not defined mask all text. Default is false.
Declaration
Swift

public var isSecureText: Bool { get set }
Show on GitHub
secureTextSymbol
Text Symbol that will replace visible label text character when securing String. Should be one charcter only.
Declaration
Swift

public var secureTextSymbol: String { get set }
Show on GitHub
clearText()
Clear last revealed text and set it to nil. IMPORTANT! New request is required to populate label with revealed data.
Declaration
Swift

public func clearText()
Show on GitHub


                    
                    
                    copyTextToClipboard(format:)

Copy text to pasteboard with format.

Declaration

Swift

public func copyTextToClipboard(format: CopyTextFormat = .raw)

Parameters


                                format

VGSLabel.CopyTextFormat object, text format to copy. Default is .raw.

Show on GitHub


                    
                    
                    setSecureText(start:end:)

Set text range to be replaced with VGSLabel.secureTextSymbol.

Declaration

Swift

public func setSecureText(start: Int? = nil, end: Int? = nil)

Parameters

`start`	`Int` object. Defines range start, should be less or equal to `end` and string length. Default is `nil`.
`end`	`Int` object. Defines range end, should be greater or equal to `end` and string length. Default is `nil`.

Show on GitHub


                    
                    
                    setSecureText(ranges:)

Set array of text ranges to be replaced with VGSLabel.secureTextSymbol.

Declaration

Swift

public func setSecureText(ranges: [VGSTextRange])

Parameters


                                ranges

[VGSTextRange] object, an array of VGSTextRange objects to be applied subsequently.

Show on GitHub

UI Attribute

paddings
UIEdgeInsets for text. IMPORTANT! Paddings should be non-negative.
Declaration
Swift

public var paddings: UIEdgeInsets { get set }
Show on GitHub
placeholderPaddings
UIEdgeInsets for placeholder. Default is nil. If placeholder paddings not set, paddings property will be used to control placeholder insets. IMPORTANT! Paddings should be non-negative.
Declaration
Swift

public var placeholderPaddings: UIEdgeInsets? { get set }
Show on GitHub
intrinsicContentSize
The natural size for the Lbel, considering only properties of the view itself.
Declaration
Swift

public override var intrinsicContentSize: CGSize { get }
Show on GitHub

Accessibility Attributes

vgsAccessibilityLabel
A succinct label in a localized string that identifies the accessibility element.
Declaration
Swift

public var vgsAccessibilityLabel: String? { get set }
Show on GitHub
vgsAccessibilityHint
A localized string that contains a brief description of the result of performing an action on the accessibility element.
Declaration
Swift

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

public var vgsIsAccessibilityElement: Bool { get set }
Show on GitHub

Font Attributes

vgsAdjustsFontForContentSizeCategory
Indicates whether VGSLabel should automatically update its font when the device’s UIContentSizeCategory is changed. It only works automatically with dynamic fonts
Declaration
Swift

public var vgsAdjustsFontForContentSizeCategory: Bool { get set }
Show on GitHub
font
VGSLabel text font. By default use default dynamic font style .body to update its size automatically when the device’s UIContentSizeCategory changed.
Declaration
Swift

public var font: UIFont? { get set }
Show on GitHub
numberOfLines
Number of lines.
Declaration
Swift

public var numberOfLines: Int { get set }
Show on GitHub
textColor
VGSLabel text color.
Declaration
Swift

public var textColor: UIColor? { get set }
Show on GitHub
textAlignment
VGSLabel text alignment.
Declaration
Swift

public var textAlignment: NSTextAlignment { get set }
Show on GitHub
lineBreakMode
VGSLabel line break mode.
Declaration
Swift

public var lineBreakMode: NSLineBreakMode { get set }
Show on GitHub
cornerRadius
VGSLabel layer corner radius.
Declaration
Swift

public var cornerRadius: CGFloat { get set }
Show on GitHub
borderWidth
VGSLabel layer borderWidth.
Declaration
Swift

public var borderWidth: CGFloat { get set }
Show on GitHub
borderColor
VGSLabel layer borderColor.
Declaration
Swift

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

Custom text styles

textMinLineHeight
VGSLabel minimum text line height.
Declaration
Swift

public var textMinLineHeight: CGFloat { get set }
Show on GitHub
characterSpacing
VGSLabel text character spacing.
Declaration
Swift

public var characterSpacing: CGFloat { get set }
Show on GitHub