ccp/com.ezzy.ccp.countrypicker.state

Package-level declarations

State holders and configuration: CountryPickerConfig (how a picker behaves), CountryPickerState (the sheet's transient state) with rememberCountryPickerState, and PhoneNumberFieldState with rememberPhoneNumberFieldState.

Types

CountryLoadState

sealed interface CountryLoadState

How the country list is doing.

CountryPickerConfig

@Immutable

data class CountryPickerConfig(val selectionMode: CountrySelectionMode = CountrySelectionMode.Single, val allowedCountryCodes: Set<String>? = null, val excludedCountryCodes: Set<String> = emptySet(), val disabledCountryCodes: Set<String> = emptySet(), val enabledRegions: Set<CountryRegion> = CountryRegion.entries.toSet(), val initialRegion: CountryRegion? = null, val showRecentlySelected: Boolean = true, val showSuggestedCountries: Boolean = true, val showSearch: Boolean = true, val closeOnSingleSelection: Boolean = true, val minimumSelectionCount: Int = 0, val maximumSelectionCount: Int? = null, val autoConfirmOnMaximum: Boolean = false, val searchFields: Set<CountrySearchField> = CountrySearchField.All, val minimumSearchQueryLength: Int = 1, val suggestedCountryCodes: List<String> = emptyList(), val recentCountryLimit: Int = 5, val countryComparator: Comparator<Country>? = null)

Everything about what a picker offers and how selection behaves, in one value.

CountryPickerState

@Stable

class CountryPickerState

Owns the picker's transient UI state: sheet visibility, search query, region filter, and the pending selection.

CountryQuickPick

@Immutable

data class CountryQuickPick(val country: Country, val source: QuickPickSource)

A country offered as a one-tap shortcut, and why.

CountrySection

@Immutable

data class CountrySection(val kind: CountrySectionKind, val items: List<CountryMatch>)

One titled group of countries in the sheet.

CountrySectionKind

enum CountrySectionKind : Enum<CountrySectionKind>

The kinds of section the sheet can show, in the order they appear.

PhoneNumberFieldState

@Stable

class PhoneNumberFieldState

State for a phone number field: the selected country, the digits typed, and everything derived from them.

QuickPickSource

enum QuickPickSource : Enum<QuickPickSource>

Where a CountryQuickPick came from.

Functions

RecordRecentSelections

@Composable

fun RecordRecentSelections(selectedCountries: Set<Country>, store: RecentCountryStore)

Records a confirmed selection into store whenever it changes.

rememberCountryPickerState

@Composable

fun rememberCountryPickerState(config: CountryPickerConfig = CountryPickerConfig(), selectedCountries: Set<Country> = emptySet(), repository: CountryRepository = CountryRepository.Default, recentCountryStore: RecentCountryStore = NoOpRecentCountryStore, detector: CountryDetector? = null, detectionBehavior: CountryDetectionBehavior = CountryDetectionBehavior.ShowBadge, onDetectedCountry: (Country) -> Unit = {}): CountryPickerState

Creates and remembers a CountryPickerState, wiring data loading, restoration, country detection and the recents store.

rememberPhoneNumberFieldState

@Composable

fun rememberPhoneNumberFieldState(initialCountry: Country, initialNumber: String = "", enforceMaxLength: Boolean = true, allowedNumberTypes: Set<PhoneNumberType> = emptySet()): PhoneNumberFieldState

Remembers a PhoneNumberFieldState, restoring the country and digits across configuration change and process death.