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

Package-level declarations

Types

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

class AddressController(val fieldsFlowable: Flow<List<SectionFieldElement>>) : SectionFieldErrorController, SectionFieldComposable

This is the controller for a section with a changing number and set of fields. This is in contrast to the SectionController which is a section in which the fields in it do not change.

AddressElement

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

open class AddressElement(_identifier: IdentifierSpec, addressRepository: AddressRepository, rawValuesMap: Map<IdentifierSpec, String?> = emptyMap(), addressType: AddressType = AddressType.Normal(), countryCodes: Set<String> = emptySet(), countryDropdownFieldController: DropdownFieldController = DropdownFieldController( CountryConfig(countryCodes), rawValuesMap[IdentifierSpec.Country] ), sameAsShippingElement: SameAsShippingElement?, shippingValuesMap: Map<IdentifierSpec, String?>?, isPlacesAvailable: IsPlacesAvailable = DefaultIsPlacesAvailable(), hideCountry: Boolean = false) : SectionMultiFieldElement

AddressTextFieldController

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

class AddressTextFieldController(config: TextFieldConfig, onNavigation: () -> Unit? = null, val initialValue: String? = null) : TextFieldController, InputController, SectionFieldErrorController, SectionFieldComposable

AddressTextFieldElement

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

class AddressTextFieldElement(val identifier: IdentifierSpec, config: TextFieldConfig, onNavigation: () -> Unit? = null) : SectionSingleFieldElement

AddressType

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

sealed class AddressType : Parcelable

AdministrativeAreaConfig

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

class AdministrativeAreaConfig(country: AdministrativeAreaConfig.Country) : DropdownConfig

AdministrativeAreaElement

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

data class AdministrativeAreaElement(val identifier: IdentifierSpec, val controller: DropdownFieldController) : SectionSingleFieldElement

CheckboxFieldController

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

class CheckboxFieldController(val labelResource: CheckboxFieldController.LabelResource? = null, val debugTag: String = "", initialValue: Boolean = false) : SectionFieldErrorController, SectionFieldComposable

CheckboxFieldElement

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

class CheckboxFieldElement(val identifier: IdentifierSpec, val controller: CheckboxFieldController = CheckboxFieldController()) : FormElement

Controller

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

interface Controller

This is a generic controller

CountryConfig

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

class CountryConfig(val onlyShowCountryCodes: Set<String> = emptySet(), val locale: Locale = Locale.getDefault(), val tinyMode: Boolean = false, val disableDropdownWithSingleElement: Boolean = false, collapsedLabelMapper: (Country) -> String = { country -> country.name }, expandedLabelMapper: (Country) -> String = { country -> "${countryCodeToEmoji(country.code.value)} ${country.name}" }) : DropdownConfig

This is the configuration for a country dropdown.

CountryElement

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

data class CountryElement(val identifier: IdentifierSpec, val controller: DropdownFieldController) : SectionSingleFieldElement

DateConfig

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

class DateConfig : TextFieldConfig

DefaultIsPlacesAvailable

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

class DefaultIsPlacesAvailable : IsPlacesAvailable

DropdownConfig

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

interface DropdownConfig

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.

EmailConfig

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

class EmailConfig(@StringRes val label: Int = R.string.stripe_email) : TextFieldConfig

ExpiryDateVisualTransformation

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

class ExpiryDateVisualTransformation : VisualTransformation

FieldError

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

class FieldError(@StringRes val errorMessage: Int, val formatArgs: Array<out Any>? = null)

Encapsulates an error message including the string resource and the variable arguments

FormElement

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

interface FormElement

This is used to define each section in the visual form layout. Each item in the layout has an identifier and a controller associated with it.

IdentifierSpec

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

@Serializable

data class IdentifierSpec(val v1: String, val ignoreField: Boolean = false, val destination: ParameterDestination = ParameterDestination.Api.Params) : Parcelable

This uniquely identifies a element in the form. The vals here are for identifier specs that need to be found when pre-populating fields, or when extracting data.

InputController

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

interface InputController : SectionFieldErrorController

This class provides the logic behind the fields.

IsPlacesAvailable

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

fun interface IsPlacesAvailable

NameConfig

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

class NameConfig : TextFieldConfig

OTPController

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

class OTPController(val otpLength: Int = 6) : Controller

OTPElement

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

data class OTPElement(val identifier: IdentifierSpec, val controller: OTPController) : FormElement

OTPElementColors

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

data class OTPElementColors(val selectedBorder: Color, val placeholder: Color)

ParameterDestination

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

interface ParameterDestination : Parcelable

PhoneNumberController

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

class PhoneNumberController : InputController, SectionFieldComposable

PhoneNumberElement

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

data class PhoneNumberElement(val identifier: IdentifierSpec, val controller: PhoneNumberController) : SectionSingleFieldElement

PhoneNumberState

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

@Serializable

enum PhoneNumberState : Enum<PhoneNumberState>

PostalCodeConfig

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

class PostalCodeConfig(@StringRes val label: Int, val trailingIcon: MutableStateFlow<TextFieldIcon?> = MutableStateFlow(null), country: String) : TextFieldConfig

PostalCodeVisualTransformation

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

class PostalCodeVisualTransformation(val format: PostalCodeConfig.CountryPostalFormat) : VisualTransformation

RowController

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

class RowController(val fields: List<SectionSingleFieldElement>) : SectionFieldErrorController, SectionFieldComposable

RowElement

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

class RowElement(_identifier: IdentifierSpec, val fields: List<SectionSingleFieldElement>, val controller: RowController) : SectionMultiFieldElement

SameAsShippingController

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

class SameAsShippingController(initialValue: Boolean) : InputController, SectionFieldComposable

SameAsShippingElement

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

data class SameAsShippingElement(val identifier: IdentifierSpec, val controller: SameAsShippingController) : SectionSingleFieldElement

SectionController

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

class SectionController(@StringRes val label: Int?, sectionFieldErrorControllers: List<SectionFieldErrorController>) : Controller

This is the controller for a section with a static number of fields.

SectionElement

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

data class SectionElement(val identifier: IdentifierSpec, val fields: List<SectionFieldElement>, val controller: SectionController) : FormElement

SectionFieldComposable

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

fun interface SectionFieldComposable

Indicates a class could be drawn as a Composable within SectionFieldElementUI.

SectionFieldElement

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

interface SectionFieldElement

SectionFieldErrorController

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

interface SectionFieldErrorController : Controller

Any element in a section must have a controller that provides an error and have a type. This is used for a single field in a section or a section field that has other fields in it.

SectionMultiFieldElement

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

abstract class SectionMultiFieldElement(val identifier: IdentifierSpec) : SectionFieldElement

SectionSingleFieldElement

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

abstract class SectionSingleFieldElement(val identifier: IdentifierSpec) : SectionFieldElement

This is an element that is in a section and accepts user input.

SimpleTextElement

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

data class SimpleTextElement(val identifier: IdentifierSpec, val controller: TextFieldController) : SectionSingleFieldElement

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

SimpleTextFieldController

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

class SimpleTextFieldController(val textFieldConfig: TextFieldConfig, val showOptionalLabel: Boolean = false, val initialValue: String? = null) : TextFieldController, SectionFieldErrorController

This class will provide the onValueChanged and onFocusChanged functionality to the field's composable. These functions will update the observables as needed. It is responsible for exposing immutable observers for its data

SingleChoiceDropdownItem

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

interface SingleChoiceDropdownItem

TextFieldConfig

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

interface TextFieldConfig

TextFieldController

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

interface TextFieldController : InputController, SectionFieldComposable

TextFieldIcon

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

sealed class TextFieldIcon

TextFieldState

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

interface TextFieldState

This represents the different states a field can be in, in each of these cases there might be a reason to show the error in a different way. This interface separates how the state is implemented from what information is required by clients of the interface. This will allow the implementation to change without impacting the clients.

TextFieldStateConstants

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

class TextFieldStateConstants

Properties

DROPDOWN_MENU_CLICKABLE_TEST_TAG

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

const val DROPDOWN_MENU_CLICKABLE_TEST_TAG: String

LocalAutofillEventReporter

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

val LocalAutofillEventReporter: ProvidableCompositionLocal<(String) -> Unit>

PHONE_NUMBER_TEXT_FIELD_TAG

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

const val PHONE_NUMBER_TEXT_FIELD_TAG: String

SAME_AS_SHIPPING_CHECKBOX_TEST_TAG

const val SAME_AS_SHIPPING_CHECKBOX_TEST_TAG: String

Functions

AddressElementUI

@Composable

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

fun AddressElementUI(enabled: Boolean, controller: AddressController, hiddenIdentifiers: Set<IdentifierSpec>, lastTextFieldIdentifier: IdentifierSpec?)

AddressTextFieldUI

@Composable

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

fun AddressTextFieldUI(controller: AddressTextFieldController, onClick: () -> Unit = { controller.launchAutocompleteScreen() })

AnimatedIcons

@Composable

fun AnimatedIcons(icons: List<TextFieldIcon.Trailing>, loading: Boolean)

canAcceptInput

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

fun TextFieldState.canAcceptInput(currentValue: String, proposedValue: String): Boolean

CheckboxElementUI

@Composable

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

fun CheckboxElementUI(modifier: Modifier = Modifier, automationTestTag: String = "", isChecked: Boolean = false, label: String? = null, isEnabled: Boolean = false, onValueChange: (Boolean) -> Unit)

CheckboxFieldUI

@Composable

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

fun CheckboxFieldUI(modifier: Modifier = Modifier, controller: CheckboxFieldController, enabled: Boolean = true)

convertTo4DigitDate

fun convertTo4DigitDate(input: String): String

DropDown

@Composable

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

fun DropDown(controller: DropdownFieldController, enabled: Boolean, modifier: Modifier = Modifier, showChevron: Boolean = true)

This composable will handle the display of dropdown items in a lazy column.

H6Text

@Composable

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

fun H6Text(text: String, modifier: Modifier = Modifier)

OTPElementUI

@Composable

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

fun OTPElementUI(enabled: Boolean, element: OTPElement, modifier: Modifier = Modifier, boxShape: Shape = MaterialTheme.shapes.medium, boxTextStyle: TextStyle = OTPElementUI.defaultTextStyle(), boxSpacing: Dp = 8.dp, middleSpacing: Dp = 20.dp, otpInputPlaceholder: String = "●", colors: OTPElementColors = OTPElementColors( selectedBorder = MaterialTheme.colors.primary, placeholder = MaterialTheme.stripeColors.placeholderText ), focusRequester: FocusRequester = remember { FocusRequester() })

PhoneNumberCollectionSection

@Composable

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

fun PhoneNumberCollectionSection(enabled: Boolean, phoneNumberController: PhoneNumberController, modifier: Modifier = Modifier, countryDropdown: @Composable () -> Unit = { CountryDropdown(phoneNumberController, enabled) }, isSelected: Boolean = false, @StringRes sectionTitle: Int? = null, requestFocusWhenShown: Boolean = false, moveToNextFieldOnceComplete: Boolean = false, focusRequester: FocusRequester = remember { FocusRequester() }, imeAction: ImeAction = ImeAction.Done)

PhoneNumberElementUI

@Composable

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

fun PhoneNumberElementUI(enabled: Boolean, controller: PhoneNumberController, modifier: Modifier = Modifier, countryDropdown: @Composable () -> Unit = { CountryDropdown(controller, enabled) }, requestFocusWhenShown: Boolean = false, moveToNextFieldOnceComplete: Boolean = false, focusRequester: FocusRequester = remember { FocusRequester() }, trailingIcon: @Composable () -> Unit? = null, imeAction: ImeAction = ImeAction.Done)

RowElementUI

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

@Composable

fun RowElementUI(enabled: Boolean, controller: RowController, hiddenIdentifiers: Set<IdentifierSpec>, lastTextFieldIdentifier: IdentifierSpec?)

SameAsShippingElementUI

@Composable

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

fun SameAsShippingElementUI(controller: SameAsShippingController)

Section

@Composable

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

fun Section(@StringRes title: Int?, error: String?, modifier: Modifier = Modifier, isSelected: Boolean = false, addVerticalPadding: Boolean = true, contentOutsideCard: @Composable () -> Unit = {}, contentInCard: @Composable () -> Unit)

This is a simple section that holds content in a card view. It has a label, content specified by the caller, and an error string.

SectionCard

@Composable

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

fun SectionCard(modifier: Modifier = Modifier, shape: Shape = MaterialTheme.shapes.medium, isSelected: Boolean = false, backgroundColor: Color = MaterialTheme.stripeColors.component, border: BorderStroke = MaterialTheme.getBorderStroke(isSelected), content: @Composable () -> Unit)

This is the layout for the section card.

SectionElementUI

@Composable

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

fun SectionElementUI(enabled: Boolean, element: SectionElement, hiddenIdentifiers: Set<IdentifierSpec>, lastTextFieldIdentifier: IdentifierSpec?, nextFocusDirection: FocusDirection = FocusDirection.Down, previousFocusDirection: FocusDirection = FocusDirection.Up)

SectionError

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

@Composable

fun SectionError(error: String)

This is how error string for the section are displayed.

SectionFieldElementUI

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

@Composable

fun SectionFieldElementUI(enabled: Boolean, field: SectionFieldElement, modifier: Modifier = Modifier, hiddenIdentifiers: Set<IdentifierSpec> = emptySet(), lastTextFieldIdentifier: IdentifierSpec?, nextFocusDirection: FocusDirection = FocusDirection.Down, previousFocusDirection: FocusDirection = FocusDirection.Up)

SingleChoiceDropdown

@Composable

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

fun <TDropdownChoice : SingleChoiceDropdownItem> SingleChoiceDropdown(expanded: Boolean, title: ResolvableString, currentChoice: TDropdownChoice?, choices: List<TDropdownChoice>, onChoiceSelected: (TDropdownChoice) -> Unit, headerTextColor: Color, optionTextColor: Color, onDismiss: () -> Unit)

TextField

@Composable

fun TextField(textFieldController: TextFieldController, enabled: Boolean, imeAction: ImeAction, modifier: Modifier = Modifier, onTextStateChanged: (TextFieldState?) -> Unit = {}, nextFocusDirection: FocusDirection = FocusDirection.Next, previousFocusDirection: FocusDirection = FocusDirection.Previous, focusRequester: FocusRequester = remember { FocusRequester() })

This is focused on converting an TextFieldController into what is displayed in a textField.

TextFieldColors

@Composable

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

fun TextFieldColors(shouldShowError: Boolean = false): TextFieldColors

TextFieldSection

@Composable

fun TextFieldSection(modifier: Modifier = Modifier, textFieldController: TextFieldController, imeAction: ImeAction, enabled: Boolean, isSelected: Boolean = false, @StringRes sectionTitle: Int? = null, onTextStateChanged: (TextFieldState?) -> Unit = {})

This is focused on converting an TextFieldController into what is displayed in a section with a single textField.