stripe-ui-core/com.stripe.android.uicore.elements/SimpleTextFieldConfig

SimpleTextFieldConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

open class SimpleTextFieldConfig(@StringRes val label: Int? = null, val capitalization: KeyboardCapitalization = KeyboardCapitalization.Words, val keyboard: KeyboardType = KeyboardType.Text, val trailingIcon: MutableStateFlow<TextFieldIcon?> = MutableStateFlow(null)) : TextFieldConfig

Constructors

constructor(@StringRes label: Int? = null, capitalization: KeyboardCapitalization = KeyboardCapitalization.Words, keyboard: KeyboardType = KeyboardType.Text, trailingIcon: MutableStateFlow<TextFieldIcon?> = MutableStateFlow(null))

Properties

capitalization

open override val capitalization: KeyboardCapitalization

This specifies how the field should be capitalized

debugLabel

open override val debugLabel: String

This is a label for debug logs

keyboard

open override val keyboard: KeyboardType

This is the type of keyboard to use for this field

label

open override val label: Int? = null

This is the label to describe the field

open override val loading: MutableStateFlow<Boolean>

placeHolder

open val placeHolder: String?

trailingIcon

open override val trailingIcon: MutableStateFlow<TextFieldIcon?>

visualTransformation

open override val visualTransformation: VisualTransformation? = null

Transformation for changing visual output of the input field.

Functions

convertFromRaw

open override fun convertFromRaw(rawValue: String): String

This will convert from a raw value used in the parameter map to a disiplayValue

convertToRaw

open override fun convertToRaw(displayName: String): String

This will convert the field to a raw value to use in the parameter map

determineState

open override fun determineState(input: String): TextFieldState

This will determine the state of the field based on the text

filter

open override fun filter(userTyped: String): String

This works a little like the input filter, removing pasted characters that are invalid in the case where the keyboard allows more than the allowed characters, or characters are pasted in