ccp/com.ezzy.ccp.model/CCPConfig

CCPConfig

data class CCPConfig(val phoneInputCornerRadius: Dp, val phoneHintStyle: TextStyle, val borderWidth: Dp, val autoDetectCountry: Boolean, val showHeader: Boolean, val showCountryFlag: Boolean, val countriesSheetShape: Shape, val searchBorderWidth: Dp, val searchCornerRadius: Dp, val searchHintStyle: TextStyle, val headerStyle: TextStyle, val showDialCodeCountryItem: Boolean, val showFlagCountryItem: Boolean, val countryItemDialCodeTextStyle: TextStyle, val countryItemNameTextStyle: TextStyle, val countryItemShape: Shape, val phoneInputShape: Shape, val showCountriesHeaderDivider: Boolean, val readOnly: Boolean, val showClearButton: Boolean, val enforceMaxLength: Boolean, val defaultCountryListStyle: CountryListStyle, val countryPickerStyle: CountryPickerStyle, val showLabel: Boolean, val showPhonePrefixDivider: Boolean, val phoneFieldSize: PhoneFieldSize)(source)

Configuration options for customizing the appearance and behavior of the CCP component.

Constructors

CCPConfig

constructor(phoneInputCornerRadius: Dp, phoneHintStyle: TextStyle, borderWidth: Dp, autoDetectCountry: Boolean, showHeader: Boolean, showCountryFlag: Boolean, countriesSheetShape: Shape, searchBorderWidth: Dp, searchCornerRadius: Dp, searchHintStyle: TextStyle, headerStyle: TextStyle, showDialCodeCountryItem: Boolean, showFlagCountryItem: Boolean, countryItemDialCodeTextStyle: TextStyle, countryItemNameTextStyle: TextStyle, countryItemShape: Shape, phoneInputShape: Shape, showCountriesHeaderDivider: Boolean, readOnly: Boolean, showClearButton: Boolean, enforceMaxLength: Boolean, defaultCountryListStyle: CountryListStyle, countryPickerStyle: CountryPickerStyle, showLabel: Boolean, showPhonePrefixDivider: Boolean, phoneFieldSize: PhoneFieldSize)

Properties

autoDetectCountry

val autoDetectCountry: Boolean

Automatically detect the user's country via SIM, network, or locale.

borderWidth

val borderWidth: Dp

Thickness of the border around the phone number input field.

countriesSheetShape

val countriesSheetShape: Shape

Shape of the country selection bottom sheet.

countryItemDialCodeTextStyle

val countryItemDialCodeTextStyle: TextStyle

TextStyle for the dial code in each country item.

countryItemNameTextStyle

val countryItemNameTextStyle: TextStyle

TextStyle for the country name in each country item.

countryItemShape

val countryItemShape: Shape

Shape of individual country list items.

countryPickerStyle

val countryPickerStyle: CountryPickerStyle

How to present the country picker — CountryPickerStyle.BottomSheet (default, full-screen modal) or CountryPickerStyle.Dropdown (compact inline dropdown).

defaultCountryListStyle

val defaultCountryListStyle: CountryListStyle

Initial layout of the country list — CountryListStyle.List or CountryListStyle.Grid. The user can toggle this at runtime via the sort button.

enforceMaxLength

val enforceMaxLength: Boolean

Cap input at the maximum digit count for the selected country.

headerStyle

val headerStyle: TextStyle

TextStyle for the letter headers in the country list.

phoneFieldSize

val phoneFieldSize: PhoneFieldSize

Overall size of the phone field — see PhoneFieldSize. PhoneFieldSize.Regular (the default) is unchanged from before this became configurable; PhoneFieldSize.Compact/PhoneFieldSize.ExtraCompact shrink the field's height by scaling its padding, flag, chevron, icon-button, and font sizes down together, so a shorter field never clips or crowds its own content. Only affects the CountryPickerStyle.BottomSheet rendering.

phoneHintStyle

val phoneHintStyle: TextStyle

TextStyle for the placeholder text inside the phone input.

phoneInputCornerRadius

val phoneInputCornerRadius: Dp

Corner radius of the phone input field container.

phoneInputShape

val phoneInputShape: Shape

Shape of the phone input field container.

readOnly

val readOnly: Boolean

Make the phone input non-editable and the country selector non-tappable.

searchBorderWidth

val searchBorderWidth: Dp

Border thickness of the search field inside the sheet.

searchCornerRadius

val searchCornerRadius: Dp

Corner radius of the search field.

searchHintStyle

val searchHintStyle: TextStyle

TextStyle for the search field placeholder.

showClearButton

val showClearButton: Boolean

Show an × button inside the field to clear the entered number.

showCountriesHeaderDivider

val showCountriesHeaderDivider: Boolean

Show a divider line next to the letter header.

showCountryFlag

val showCountryFlag: Boolean

Display the country flag inside the phone input field.

showDialCodeCountryItem

val showDialCodeCountryItem: Boolean

Show the dial code (e.g. +1) inside each country list item.

showFlagCountryItem

val showFlagCountryItem: Boolean

Show the flag emoji inside each country list item.

showHeader

val showHeader: Boolean

Display a letter header inside the country selection sheet.

showLabel

val showLabel: Boolean

Show a floating label above the phone field, notched into its outline — see com.ezzy.ccp.components.PhoneNumberInput's label parameter for the label text. Only affects the CountryPickerStyle.BottomSheet rendering.

showPhonePrefixDivider

val showPhonePrefixDivider: Boolean

Show the thin vertical divider between the country prefix (flag, dial code, chevron) and the number editor inside the phone field. Only affects the CountryPickerStyle.BottomSheet rendering.