vgscollect/com.verygoodsecurity.vgscollect.widget.compose.state.core/BaseFieldState

BaseFieldState

abstract class BaseFieldState

Common state contract shared by every VGS Compose field state (card number, CVC, expiry, SSN, cardholder, generic text).

Instances are immutable — every keystroke produces a new state object. The raw text value is never exposed publicly; submit the state via VGSCollect.asyncSubmit(...) and the SDK reads it internally.

Obtain concrete states with the matching rememberVgs…TextFieldState factory (e.g. rememberVgsCardNumberTextFieldState), then pass them to the corresponding Vgs…TextField composable.

Inheritors

VgsCardNumberTextFieldState

VgsCardholderTextFieldState

VgsCvcTextFieldState

VgsExpiryTextFieldState

VgsSsnTextFieldState

VgsTextFieldState

Types

object Companion

Properties

val contentLength: Int

current length of the entered value.

val fieldName: String

JSON key the value is sent under in the submit payload.

val isEmpty: Boolean

true when the field has no input.

val isValid: Boolean

true when every validator reports a valid result.

tokenizationConfig

abstract val tokenizationConfig: VgsTokenizationConfig?

optional tokenization settings; when present, the value is tokenized on submit and the token is sent in its place.

validationResult

val validationResult: List<VgsTextFieldValidationResult>

per-validator outcomes for the current value.

val validators: List<VgsTextFieldValidator>?

custom validators applied to the value, or null to use the field's default validators.

Functions

open override fun toString(): String