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

VgsSsnTextFieldState

class VgsSsnTextFieldState : BaseFieldState

Immutable state for a VGS U.S. Social Security Number field.

Obtain an instance with rememberVgsSsnTextFieldState inside a composable. The state is replaced (not mutated) on every keystroke; pass the latest instance to your VgsSsn…TextField and update it from onStateChange:

var state by rememberVgsSsnTextFieldState(
    collect = vgsCollect,
    fieldName = "data.ssn",
)
VgsSsnOutlinedTextField(
    state = state,
    onStateChange = { state = it },
)

Useful properties:

mask — input mask the field renders ("###-##-####").
isValid / validationResult — current validation outcome.
fieldName — JSON key used in the submit payload.

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.

val mask: String

tokenizationConfig

open override val tokenizationConfig: VgsSsnTokenizationConfig?

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