@wlucha/ng-country-select

🌍 Angular Material Country Autocomplete

A smart, multilingual country search with flags and codes made with Angular
✨ Enhance your Angular forms with this elegant, high-performance autocomplete ✨

📢 Features

• 🅰️ Fully Compatible with Angular 16-19
  This library is designed to work seamlessly with the latest Angular versions (16, 17, 18, and 19).
  It leverages modern Angular features while maintaining backward compatibility.

• 🌍 Multi-language Magic
  Supports English, French, Spanish, Italian, German, Arabic, Chinese, Hindi, Bengali, Portuguese and Russian + easily extendable to any language

• 🎌 Flag Images 🇺🇸 🇩🇪 🇫🇷 🇪🇸 🇮🇹
  OS & Browser independent flag images

• ⚡ Optimized Performance
  RxJS-powered search with debounce & virtual scrolling

• 🔍 Smart Search
  Search countries by: ✓ Localized name ✓ Any translation ✓ Alpha2/3 codes

• 🎨 Material Design Excellence
  Seamless integration with Angular Material components

• 🧩 Standalone Component
  Zero boilerplate integration

🚀 Demo

Live Demo: https://wlucha.github.io/ng-country-select

Stackblitz: https://stackblitz.com/~/github.com/wlucha/ng-country-select

🌍 Compatibility

Angular Version	✅ Supported
	✅ Yes
	✅ Yes
	✅ Yes
	✅ Yes

🛠️ Setup in 60 Seconds

1. Install Dependencies

Quick Installation (ng add)

ng add @wlucha/ng-country-select

This command will install the @wlucha/ng-country-select library + all required dependencies.

(Alternative) Install Dependencies manually & update Angular.json styles

# Install dependencies
npm install --save @angular/material @angular/cdk @angular/animations flag-icons @wlucha/ng-country-select

# Add the flag icon styles to Angular.json "styles" array
"architect": {
   "build": {
      "options": {
        ...,
        "styles": [
          ...,
          "flag-icons/css/flag-icons.min.css"
        ]
      }
    }
  }
}    

2. Import Component

import { CountrySelectComponent } from '@wlucha/ng-country-select';

@NgModule({
  imports: [
    CountrySelectComponent,
    // ... other imports
  ]
})

3. Add Basic Usage

<ng-country-select
  [lang]="'en'"
  (countrySelected)="handleSelection($event)"
></ng-country-select>

🎛️ Parameters Worth Exploring

🎚️ Inputs

Parameter	Type	Default	Description
defaultCountry	Country | null	null	Sets an initial preselected country
formControl	FormControl<Country | null>	null	Sets an initial preselected country (FormControl)
selectedCountry	Country | null	-	Sets a country programmatically (after init)
selectedCountryByAlpha2	string	-	Set a country programmatically by its alpha2 code
selectedCountryByAlpha3	string	-	Set a country programmatically by its alpha3 code
selectedCountryByCurrentTranslation		-	Set a country programmatically by its name in the current language
lang	string	'en'	Language for displaying country names (e.g., en, de, fr, es, it)
searchAllLanguages	boolean	false	If true, searching will match in all available translations
placeholder	string	'Search country'	Placeholder text for the input field
debounceTime	number	100	Debounce time in milliseconds for the search input
disabled	boolean	false	Disables the component if true
appearance	'fill' | 'outline'	'fill'	Appearance style of the form field
required	boolean	false	Marks the field as required if true
showCodes	boolean	false	If true, shows alpha2/alpha3 codes in the autocomplete results
color	ThemePalette	'primary'	Angular Material color palette to use ('primary', 'accent', 'warn')
includeCountries	string[]	[]	List of country codes to include in the dropdown (e.g., ['US', 'DE', 'FR'])
excludeCountries	string[]	[]	List of country codes to exclude from the dropdown (e.g., ['US', 'DE', 'FR'])
alpha2Only	boolean	false	Show only alpha2 codes in the results
alpha3Only	boolean	false	Show only alpha3 codes in the results
showFlag	boolean	true	Whether the flag should be displayed

🚨 Outputs

Event	Output	Description
countrySelected	Country	Full country object on selection
inputChanged	string	Live search term updates
closed	void	When dropdown closes

💻 Power User Setup

<ng-country-select
  [lang]="'en'"
  [formControl]="countryControl"
  [searchAllLanguages]="true"
  [showCodes]="true"
  [debounceTime]="200"
  [required]="true"
  [disabled]="false"
  [appearance]="'outline'"
  [placeholder]="'Search country'"
  [color]="primary"
  [alpha2Only]="false"
  [alpha3Only]="false"
  [showFlag]="true"
  [excludeCountries]="['US', 'DE', 'FR']"
  (countrySelected)="onCountrySelect($event)"
  (inputChanged)="trackSearchTerm($event)"
></ng-country-select>

🌟 Support the Project

Love this component? Here's how you can help:

1. ⭐ Star the repo (you're awesome!)
2. 🐛 Report bugs here
3. 💡 Suggest features
4. 📢 Share with your network

# Your star fuels development! ⭐
# Clone and explore:
git clone https://github.com/wlucha/ng-country-select.git

---

📄 License: MIT
👨💻 Maintainer: Wilfried Lucha

Made with ❤️ & ☕ by Open Source Contributors

TODO

• more languages
• custom option template
• semantic release