VGSLabel

@MainActor
public final class VGSLabel : UIView, VGSLabelProtocol

A view that displays revealed text data.

Show on GitHub

Enums

Delegates

Public interface

  • Add transformation regex to format raw revealed text.

    Declaration

    Swift

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

    Parameters

    regex

    NSRegularExpression object, transformation regex.
    template

    String object, template for replacement.
    Show on GitHub

  • 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

    @MainActor
public var contentPath: String! { get set }
    Show on GitHub

  • A Boolean value indicating whether VGSLabel string is empty.

    Declaration

    Swift

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

  • Revealed text length.

    Declaration

    Swift

    @MainActor
public var revealedRawTextLength: Int { get }
    Show on GitHub

  • Placeholder text.

    Declaration

    Swift

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

  • Placeholder text styles.

    Declaration

    Swift

    @MainActor
public var placeholderStyle: VGSPlaceholderLabelStyle { get set }
    Show on GitHub

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

    Declaration

    Swift

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

  • Text Symbol that will replace visible label text character when securing String. Should be one charcter only.

    Declaration

    Swift

    @MainActor
public var secureTextSymbol: String { get set }
    Show on GitHub

  • Clear last revealed text and set it to nil. IMPORTANT! New request is required to populate label with revealed data.

    Declaration

    Swift

    @MainActor
public func clearText()
    Show on GitHub

  • Copy text to pasteboard with format.

    Declaration

    Swift

    @MainActor
public func copyTextToClipboard(format: CopyTextFormat = .raw)

    Parameters

    format

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

  • Set text range to be replaced with VGSLabel.secureTextSymbol.

    Declaration

    Swift

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

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

    Declaration

    Swift

    @MainActor
public func setSecureText(ranges: [VGSTextRange])

    Parameters

    ranges

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

UI Attribute

  • UIEdgeInsets for text. IMPORTANT! Paddings should be non-negative.

    Declaration

    Swift

    @MainActor
public var paddings: UIEdgeInsets { get set }
    Show on GitHub

  • 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

    @MainActor
public var placeholderPaddings: UIEdgeInsets? { get set }
    Show on GitHub

  • The natural size for the Lbel, considering only properties of the view itself.

    Declaration

    Swift

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

Accessibility Attributes

  • A succinct label in a localized string that identifies the accessibility element.

    Declaration

    Swift

    @MainActor
public var vgsAccessibilityLabel: String? { get set }
    Show on GitHub

  • A localized string that contains a brief description of the result of performing an action on the accessibility element.

    Declaration

    Swift

    @MainActor
public var vgsAccessibilityHint: String? { get set }
    Show on GitHub

  • Boolean value that determinates if the text field should be exposed as an accesibility element.

    Declaration

    Swift

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

Font Attributes

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

    Declaration

    Swift

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

  • VGSLabel text font. By default use default dynamic font style .body to update its size automatically when the device’s UIContentSizeCategory changed.

    Declaration

    Swift

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

  • Number of lines.

    Declaration

    Swift

    @MainActor
public var numberOfLines: Int { get set }
    Show on GitHub

  • VGSLabel text color.

    Declaration

    Swift

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

  • VGSLabel text alignment.

    Declaration

    Swift

    @MainActor
public var textAlignment: NSTextAlignment { get set }
    Show on GitHub

  • VGSLabel line break mode.

    Declaration

    Swift

    @MainActor
public var lineBreakMode: NSLineBreakMode { get set }
    Show on GitHub

  • VGSLabel layer corner radius.

    Declaration

    Swift

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

  • VGSLabel layer borderWidth.

    Declaration

    Swift

    @MainActor
public var borderWidth: CGFloat { get set }
    Show on GitHub

  • VGSLabel layer borderColor.

    Declaration

    Swift

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

Custom text styles