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

DropdownFieldController

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

class DropdownFieldController(config: DropdownConfig, initialValue: String? = null) : InputController, SectionFieldErrorController, SectionFieldComposable

This class controls the dropdown view and implements the InputController interface. Because it can never be in error the errorMessage is always null. It is also designed to always have a value selected, so isComplete is always true.

Constructors

constructor(config: DropdownConfig, initialValue: String? = null)

Properties

disableDropdownWithSingleElement

val disableDropdownWithSingleElement: Boolean

displayItems

val displayItems: List<String>

error

open override val error: StateFlow<FieldError?>

fieldValue

open override val fieldValue: StateFlow<String>

formFieldValue

open override val formFieldValue: StateFlow<FormFieldEntry>

isComplete

open override val isComplete: StateFlow<Boolean>

label

open override val label: StateFlow<Int>

rawFieldValue

open override val rawFieldValue: StateFlow<String?>

selectedIndex

val selectedIndex: StateFlow<Int>

showOptionalLabel

open override val showOptionalLabel: Boolean = false

tinyMode

val tinyMode: Boolean

Functions

ComposeUI

@Composable

open override fun ComposeUI(enabled: Boolean, field: SectionFieldElement, modifier: Modifier, hiddenIdentifiers: Set<IdentifierSpec>, lastTextFieldIdentifier: IdentifierSpec?, nextFocusDirection: FocusDirection, previousFocusDirection: FocusDirection)

getSelectedItemLabel

fun getSelectedItemLabel(index: Int): String

Get the label for the selected item, shown when the dropdown list is collapsed.

onRawValueChange

open override fun onRawValueChange(rawValue: String)

This is called when the value changed to is a raw backing value, not a display value.

onValueChange

fun onValueChange(index: Int)

This is called when the value changed to is a display value.