https://github.com/stevdza-san/countrypicker-kmp
A lightweight KMP library that simplifies country selection by providing Country enum with Dial codes, Currencies, Flags and ISO codes—Adopted for Android, iOS, Desktop, and Web.
https://github.com/stevdza-san/countrypicker-kmp
android compose-multiplatform country-picker desktop ios kotlin kotlin-js kotlin-multiplatform kotlin-wasm web
Last synced: about 1 month ago
JSON representation
A lightweight KMP library that simplifies country selection by providing Country enum with Dial codes, Currencies, Flags and ISO codes—Adopted for Android, iOS, Desktop, and Web.
- Host: GitHub
- URL: https://github.com/stevdza-san/countrypicker-kmp
- Owner: stevdza-san
- Created: 2025-07-05T11:38:53.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-07-27T15:35:05.000Z (3 months ago)
- Last Synced: 2025-07-27T17:40:51.921Z (3 months ago)
- Topics: android, compose-multiplatform, country-picker, desktop, ios, kotlin, kotlin-js, kotlin-multiplatform, kotlin-wasm, web
- Language: Kotlin
- Homepage:
- Size: 420 KB
- Stars: 22
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#
🚩 Country Picker KMP
You've just started a new project and need to implement a feature that allows users to select a `country`, `phone number`, `dial code`, or `currency` and you're realizing it involves a lot of boilerplate: managing country data, handling `flags`, and building a clean UI. This library is built to solve exactly that. It provides a powerful yet simple `Country` enum class that includes all these information for you. But it doesn’t stop there. To make integration even better, the library includes two prebuilt UI components:
`CountryPickerDialog`: A searchable dialog that allows users to browse and select from a list of countries.
`CountryPickerField`: A UI component similar to a TextField that displays the currently selected country and opens the picker dialog on click.
This is a lightweight and fully customizable Kotlin Multiplatform (KMP) solution designed to work seamlessly across Android, iOS, Desktop, Kotlin/JS and Kotlin/WASM targets.
## ✨ Features
- ✅ Predefined list of countries with:
- Name
- Dial code
- Currency
- ISO code
- Flag resource
- ✅ Built-in `CountryPickerDialog` and `CountryPickerField` Composables
- ✅ Real-time search support
- ✅ Multiple display options: Dial Code, Currency, Name
- ✅ Kotlin Multiplatform ready (Android, iOS, Desktop, WASM)
### Gradle
Make sure to include the library in your `commonMain` source set:
```kotlin
implementation("com.stevdza-san:countrypicker:1.0.4")
```
Or a version catalog (libs.versions.toml)
```kotlin
[versions]
country-picker = "1.0.4"
[libraries]
country-picker-kmp = { module = "com.stevdza-san:countrypicker", version.ref = "country-picker" }
```
## Usage
### Show Country Picker Dialog
```kotlin
var selectedCountry by remember { mutableStateOf(Country.Serbia) }
var showDialog by remember { mutableStateOf(false) }
AnimatedVisibility(visible = showDialog) {
CountryPickerDialog(
selectedCountry = selectedCountry,
onConfirmClick = { country ->
selectedCountry = country
showDialog = false
},
onDismiss = { showDialog = false }
)
}
CountryPickerField(
selectedCountry = selectedCountry,
onClick = { showDialog = true }
)
```
## Display Options
### Choose how to display the country label:
```kotlin
enum class CountryDisplayOption {
NAME,
CURRENCY,
DIAL_CODE,
ISO_CODE,
DIAL_CODE_AND_NAME,
NAME_AND_CURRENCY,
NAME_AND_ISO_CODE
}
```
### Data Model
```kotlin
enum class Country(
val dialCode: Int,
val currency: String,
val flag: DrawableResource,
val isoCode: String
)
```
### To get all available countries:
```kotlin
val allCountries = Country.entries
```
## Like what you see? :yellow_heart:
⭐ Give a star to this repository.
☕ Let's get a coffee. You're paying!😜 https://ko-fi.com/stevdza_san
# License
```xml
Designed and developed by stevdza-san (Stefan Jovanović)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```