ngx-countries-dropdown

NGX Countries dropdown

Angular library with customizable countries dropdown component with the following features. It is not dependent on any css framework.

Features

• To create a country dropdown with flags
• Searchable country dropdown
• Use as dial code dropdown
• Use as currency dropdown
• Use as language dropdown
• To create a country dropdown with capitals
• Capability to display preferred countries on top and separate section
• Capability to display only specific countries
• Capability to block specific countries

Demo

Access all features demo here.

Getting started

Hope you already have an angular project, if not please create one using the below commands

npm install -g @angular/cli
ng new my-app
cd my-app
ng serve --open

• once the angular application setup is ready, install the Ngx Countries dropdown using the following command

Version mapping

Angular vrsion	Supported library version
19	~3
18	~2
17	1.0.6
16	1.0.51

npm i ngx-countries-dropdown

• Add the CSS Either import the CSS directly to styles.scss file

  @import  "node_modules/ngx-countries-dropdown/assets/styles.css";
  

  Or, add CSS file in angular.json in the styles array in the build section

   "styles": [
             "node_modules/ngx-countries-dropdown/assets/styles.css",
             "src/styles.scss"
           ],
  

• Import NgxCountriesDropdownModule import NgxCountriesDropdownModule in module where you want to add the countries dropdown, it may be app-module, some lazy loaded module or a standalone component

    imports: [
   NgxCountriesDropdownModule
   ],
  

• Add the country component to the component where is being used

<lib-country-list></lib-country-list>

Properties and their usage

####The below table explains what all Input properties country dropdown accepts and their usage

Property	Type and default values	Description
selectedCountryCode	Type: string ,Default value: empty string	country code which needs to be selected by default. Ex, for India pass 'in'
preferredCountryCodes	Type: string array(string[]),Default value: []	the list of country codes which needs to be displayed on top section. ex. if user provided ['in', 'us'], India and United States will be displayed on top
blockedCountryCodes	Type: string array(string[]),Default value: []	an array of country codes which are not required in the list. Ex. if some client is not servicing some specific countries can be removed from the country dropdown using this.
allowedCountryCodes	Type: string array(string[]),Default value: []	Only countries which will be displayed in the country list
selectedCountryConfig	Type: IConfig (see table below for IConfig properties), Default value: {}	Provides config for the selected country, and controls what all will be displayed. Ex. if the user do not want to display flag for the selected item, can be controlled with this property(refer to config table for details)
countryListConfig	Type: IConfig (see table below for IConfig properties), Default value: {}	Provides config for the country list, and controls what all will be displayed in the country list. Ex. if the user do not want to see flag or dial code or name in the country list, can be controlled with this property(refer to config table for details)
placeholderText	Type: string Default value: 'Select country'	To change the default placeholder label.

Events

onCountryChange

Country type ICountry

returns the selected country

IConfig properties and usage

Config properties can be used to control what will be displayed in the country list and for the selected country.

Exported interface

export interface IConfig {
  hideFlag?: boolean;
  hideCode?: boolean;
  hideName?: boolean;
  hideSearch?: boolean;
  hideDialCode?: boolean;
  displayCapital?: boolean;
  displayLanguageCode?: boolean;
  displayLanguageName?: boolean;
  displayCurrencyCode?: boolean
  displayCurrencyName?: boolean
  displayCurrencySymbol?: boolean

}

hideFlag	Boolean, Default value: false	to hide flag from country list or selected country
hideCode	Boolean, Default value: false	to hide country code
hideName	Boolean, Default value: false	to hide country name
hideSearch	Boolean, Default value: false	to hide search field from country list
hideDialCode	Boolean, Default value: false	to hide dial code
displayCapital	Boolean, Default value: false	to display country capital
displayLanguageCode	Boolean, Default value: false	to display country language code
displayLanguageName	Boolean, Default value: false	to display country language name
displayCurrencyCode	Boolean, Default value: false	to display country currency code
displayCurrencyName	Boolean, Default value: false	to display country currency name
displayCurrencySymbol	Boolean, Default value: false	to display country currency symbol

Output on country selection

On country selection output of ICountry type will be emitted. Handle country change event

<lib-country-list (onCountryChange)="onCountryChange($event)"></lib-country-list>

  onCountryChange(country: ICountry){
    console.log(country);
  }

output in console

{
    "name": "Afghanistan (‫افغانستان‬‎)",
    "code": "AF",
    "capital": "Kabul",
    "region": "AS",
    "currency": {
        "code": "AFN",
        "name": "Afghan afghani",
        "symbol": "؋"
    },
    "language": {
        "code": "ps",
        "name": "Pashto"
    },
    "dialling_code": "+93",
    "isoCode": "004"
}

exported ICountry interface

export interface ICountry {
  name?: string;
  code?: string;
  capital?: string;
  region?: string;
  currency?: ICurrency
  language?: ILanguage
  dialling_code?: string;
  isoCode?: string;
  demonym?: string;
}

export interface ICurrency {
  code?: string | null;
  name?: string;
  symbol?: string | null;
}

export interface ILanguage {
    code?: string;
    name?: string;
    iso639_2?: string,
    nativeName?: string
}

Please provide a star on Github if this package helped you in any way.