@consonant-inc/iso-flags
v1.0.4
Published
A list of countries with url links to a svg image which you can simply use in your web application
Downloads
6
Maintainers
Readme
country-flags-svg
A list of countries with url links to a svg image which you can simply use in your web application
Install
$ npm install country-flags-svg
or
$ yarn add country-flags-svg
Usage
import { findFlagUrlByNationality } from "country-flags-svg";
const flagUrl = findFlagUrlByNationality("Australian");
// => "http://upload.wikimedia.org/wikipedia/commons/8/88/Flag_of_Australia_%28converted%29.svg"
import { countries } from "country-flags-svg";
const australia = countries[0];
console.log(australia);
/* => {
name: "Australia",
demonym: "Australian",
flag: "http://upload.wikimedia.org/wikipedia/commons/8/88/Flag_of_Australia_%28converted%29.svg",
iso2: "AU",
iso3: "AUS",
}
*/
API
countries
Returns all available information.
findFlagUrlByCountryName(countryName)
Returns SVG link of the official flag for a specified country (according to countryName) or empty string if is not exist
findFlagUrlByNationality(nationality)
Returns SVG link of the official flag for a specified country (according to nationality) or empty string if is not exist
findFlagUrlByIso2Code(iso2Code)
Returns SVG link of the official flag for a specified country (according to ISO 3166-1 alpha-2 code) or empty string if is not exist
findFlagUrlByIso3Code(iso3Code)
Returns SVG link of the official flag for a specified country (according to ISO 3166-1 alpha-3 code) or empty string if is not exist
Available Flags
The full list of available flags you can see on the Docs page
if not enough don't be shy and provide merge request ;)
License
Licensed under MIT.