komposecountrycodepicker/com.joelkanyi.jcomposecountrycodepicker.component

Package-level declarations

Types

CountryCodePicker

@Stable

interface CountryCodePicker

CountryCodePicker is an interface that provides the different utilities for the country code picker.

KomposeCountryCodePickerDefaults

class KomposeCountryCodePickerDefaults(context: Context)

KomposeCountryCodePickerDefaults is a class that holds the default values for the country code picker.

Functions

CountrySelectionDialog

@Composable

fun CountrySelectionDialog(countryList: List<Country>, containerColor: Color, contentColor: Color, onDismissRequest: () -> Unit, onSelect: (item: Country) -> Unit, modifier: Modifier = Modifier, properties: DialogProperties = DialogProperties().let { DialogProperties( dismissOnBackPress = it.dismissOnBackPress, dismissOnClickOutside = it.dismissOnClickOutside, securePolicy = it.securePolicy, usePlatformDefaultWidth = false, ) })

CountrySelectionDialog is a composable that displays a dialog for selecting a country.

KomposeCountryCodePicker

@Composable

fun KomposeCountryCodePicker(state: CountryCodePicker, text: String, modifier: Modifier = Modifier, onValueChange: (String) -> Unit = {}, error: Boolean = false, showOnlyCountryCodePicker: Boolean = false, shape: Shape = MaterialTheme.shapes.medium, placeholder: @Composable (defaultLang: String) -> Unit = { defaultLang -> DefaultPlaceholder(defaultLang) }, colors: TextFieldColors = TextFieldDefaults.colors(), trailingIcon: @Composable () -> Unit? = null, countrySelectionDialogContainerColor: Color = MaterialTheme.colorScheme.background, countrySelectionDialogContentColor: Color = MaterialTheme.colorScheme.onBackground, interactionSource: MutableInteractionSource = MutableInteractionSource(), selectedCountryFlagSize: FlagSize = FlagSize(28.dp, 18.dp), textStyle: TextStyle = LocalTextStyle.current, enabled: Boolean = true)

KomposeCountryCodePicker is a composable that displays a text field with a country code picker dialog.

qaAutomationTestTag

fun Modifier.qaAutomationTestTag(tag: String): Modifier

qaAutomationTestTag is a composable that adds a test tag to important components in the country code picker, to be used for QA automation.

rememberKomposeCountryCodePickerState

@Composable

fun rememberKomposeCountryCodePickerState(defaultCountryCode: String? = null, limitedCountries: List<String> = emptyList(), showCountryCode: Boolean = true, showCountryFlag: Boolean = true): CountryCodePicker

Creates a CountryCodePicker that is remembered across compositions.