vgscollect/com.verygoodsecurity.vgscollect.widget.compose.state/VgsCvcTextFieldState

VgsCvcTextFieldState

class VgsCvcTextFieldState : BaseFieldState

Immutable state for a VGS card security code (CVC/CVV) field.

Obtain an instance with rememberVgsCvcTextFieldState inside a composable. Sync the detected brand from your card-number state so length/validation rules adapt automatically:

var cvcState by rememberVgsCvcTextFieldState(
    collect = vgsCollect,
    fieldName = "data.cvc",
)
LaunchedEffect(cardNumberState.cardBrand) {
    cvcState = cvcState.withCardBrand(cardNumberState.cardBrand)
}
VgsCvcOutlinedTextField(
    state = cvcState,
    onStateChange = { cvcState = it },
)

Useful properties:

cardBrand — brand currently driving CVC length/validation rules.
isValid / validationResult — current validation outcome.
fieldName — JSON key used in the submit payload.

Properties

val cardBrand: VgsCardBrand

val contentLength: Int

current length of the entered value.

val fieldName: String

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

isCardBrandValidationEnabled

val isCardBrandValidationEnabled: Boolean

val isEmpty: Boolean

true when the field has no input.

val isValid: Boolean

true when every validator reports a valid result.

tokenizationConfig

open override val tokenizationConfig: VgsCvcTokenizationConfig?

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

fun withCardBrand(cardBrand: VgsCardBrand): VgsCvcTextFieldState

Updates the security code field state when a new card brand is detected in the card number field.