ccp/com.ezzy.ccp.countrypicker.theme/PhoneNumberInputStyle

PhoneNumberInputStyle

data class PhoneNumberInputStyle(val labelMode: InputLabelMode = InputLabelMode.Floating, val prefixContentMode: PhonePrefixContentMode = PhonePrefixContentMode.FlagAndDialCode, val showDropdownIcon: Boolean = true, val showPrefixDivider: Boolean = true, val size: PhoneFieldSize = PhoneFieldSize.Regular, val showGhostDigits: Boolean = true, val showProgress: Boolean = true, val showNumberType: Boolean = true, val showValidIndicator: Boolean = true)(source)

Options specific to com.ezzy.ccp.countrypicker.ui.PhoneNumberField — one typed value instead of a row of unrelated booleans on the composable.

Colors, shapes, flags and motion come from the CountryPickerStyle like every other component; these are the choices only a phone field has.

Constructors

constructor(labelMode: InputLabelMode = InputLabelMode.Floating, prefixContentMode: PhonePrefixContentMode = PhonePrefixContentMode.FlagAndDialCode, showDropdownIcon: Boolean = true, showPrefixDivider: Boolean = true, size: PhoneFieldSize = PhoneFieldSize.Regular, showGhostDigits: Boolean = true, showProgress: Boolean = true, showNumberType: Boolean = true, showValidIndicator: Boolean = true)

Properties

hasVisibleLabel

val hasVisibleLabel: Boolean

labelMode as a plain boolean.

labelMode

val labelMode: InputLabelMode

A floating label, or none. Hiding it never removes the label from accessibility.

prefixContentMode

val prefixContentMode: PhonePrefixContentMode

What the country prefix shows — see PhonePrefixContentMode.

showDropdownIcon

val showDropdownIcon: Boolean

The small chevron in the prefix.

showGhostDigits

val showGhostDigits: Boolean

Show the country's example number as faint digits that the user's typing fills in, so the expected length and grouping are visible before a digit is typed.

showNumberType

val showNumberType: Boolean

A badge naming the kind of number — Mobile, Landline — once it is valid. While the field is being edited it collapses to a check, leaving the number its room.

showPrefixDivider

val showPrefixDivider: Boolean

The hairline between the prefix and the number.

showProgress

val showProgress: Boolean

A thin bar along the bottom of the field that fills as digits are entered and turns to the success color once the number is valid.

showValidIndicator

val showValidIndicator: Boolean

A check mark once the number is valid.

size

val size: PhoneFieldSize

Overall size — see PhoneFieldSize.