https://github.com/puigcerber/angular-country-picker

:earth_africa: AngularJS directive to generate a list of countries as options of the select element.
https://github.com/puigcerber/angular-country-picker

Last synced: 4 days ago
JSON representation

:earth_africa: AngularJS directive to generate a list of countries as options of the select element.

• Host: GitHub
• URL: https://github.com/puigcerber/angular-country-picker
• Owner: Puigcerber
• License: mit
• Created: 2015-01-25T20:09:01.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-03-21T21:00:02.000Z (8 months ago)
• Last Synced: 2024-04-22T19:06:44.436Z (7 months ago)
• Language: JavaScript
• Homepage: https://twitter.com/Puigcerber
• Size: 78.1 KB
• Stars: 15
• Watchers: 4
• Forks: 11
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# angular-country-picker

AngularJS directive to generate a list of countries as options of the select element.

## Installation

You can install the directive using [npm](https://www.npmjs.com/):

```bash

$ npm install angular-country-picker

```

Then you have to include it in your HTML:

```html

```

And inject the module `puigcerber.countryPicker` as a dependency of your application:

```js

angular.module('webApp', ['puigcerber.countryPicker']);

```

## Usage

The directive is intended to be used as an attribute of the native [select](https://docs.angularjs.org/api/ng/directive/select) 

directive setting its [ngOptions](https://docs.angularjs.org/api/ng/directive/ngOptions). 

Therefore `ngModel` is required for this to work.

```html

```

Excluding `ngOptions`, any other optional attribute of the select directive could still be used.

```html

```

The default value to which `ngModel` is bound it's the two-letter country code, but this can be changed setting the

attribute to one of the following values:

* alpha2: two-letter country code defined in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).

* alpha3: three-letter country code defined in [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).

* numeric: three-digit country code defined in [ISO 3166-1 numeric](https://en.wikipedia.org/wiki/ISO_3166-1_numeric).

* name: the English name of the country.

```html

```

### Config

The country provider can be configured to set a custom list of countries.

```js

angular.module('webApp', ['puigcerber.countryPicker'])

  .config(function(pvpCountriesProvider) {

    pvpCountriesProvider.setCountries([

      { name: 'Abkhazia', alpha2: 'AB'},

      { name: 'Kosovo', alpha2: 'XK'},

      { name: 'Nagorno-Karabakh', alpha2: 'NK'},

      { name: 'Northern Cyprus', alpha2: 'KK'},

      { name: 'Somaliland', alpha2: 'JS'},

      { name: 'South Ossetia', alpha2: 'XI'},

      { name: 'Transnistria', alpha2: 'PF'}

    ]);

  });

```

## See also

[ISO 3166](http://www.iso.org/iso/country_codes.htm) is the International Standard for country codes and codes for their subdivisions.

Currently 249 countries, territories, or areas of geographical interest are assigned official codes in ISO 3166-1.

## License

MIT © [Pablo Villoslada Puigcerber](http://pablovilloslada.com)