Nondeterministic Palindrome Machine

    country-flag-icons
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/country-flag-icons package

    1.4.0 • Public • Published

    country-flag-icons

    npm version npm downloads

    Vector country flag icons in 3:2 aspect ratio.

    • Optimized for small size on screen (little detail, minimalism).
    • Small file size.
    • Comes with React components for all flags (exported from /react subpackage).

    See 3:2 flags

    Install

    npm install country-flag-icons --save
    

    API

    hasFlag(country: string): boolean

    Tells whether there's a flag for a country.

    import { hasFlag } from 'country-flag-icons'
    
    hasFlag('US') === true
    hasFlag('ZZ') === false

    countries: string[]

    The list of supported countries.

    import { countries } from 'country-flag-icons'
    
    countries.includes('US') === true
    countries.includes('ZZ') === false

    Web

    Flags can be linked directly from this library's gitlab pages website, or from a github pages mirror, which seems a tiny bit faster.

    <img
      alt="United States"
      src="http://purecatamphetamine.github.io/country-flag-icons/3x2/US.svg"/>

    Flags can also be used in the form of CSS classes imported from country-flag-icons/3x2/flags.css where all flag icons are inlined as background-image data URLs. CSS flag icon height can be set via --CountryFlagIcon-height CSS variable.

    What if my project doesn't use CSS variables?

    In that case, the default flag icon height is 1em, and to change it, just set a font-size:

    /* Set flag icon height to 24px. */
    [class*=' flag:'], [class^='flag:'] {
      font-size: 24px;
    }

    Unicode

    Unicode flag icons are available under the /unicode export.

    import getUnicodeFlagIcon from 'country-flag-icons/unicode'
    
    getUnicodeFlagIcon('US') === '🇺🇸'
    getUnicodeFlagIcon('ZZ') === '🇿🇿'

    Unicode flag icons ("Regional Indicator Symbols") were introduced in 2010 in Unicode version 6.0.

    Older operating systems might not support Unicode flags, either rendering "missing" (rectangle) characters (if their system doesn't support country flags), or displaying two-letter country codes instead of emoji flag images. For example, Windows 10 currently (01.01.2020) doesn't support Unicode country flags, and displays two-letter country codes instead of emoji flag images.

    React

    React components for all flags are available at /react/3x2 export.

    import Flags from 'country-flag-icons/react/3x2'
    
    <Flags.US title="United States" className="..."/>

    String

    All flags can also be imported as strings:

    import { US } from 'country-flag-icons/string/3x2'
    
    console.log(US) // > '<svg xmlns="http://www.w3.org/2000/svg" ...</svg>'

    Or directly, if your bundler doesn't support tree shaking:

    import US from 'country-flag-icons/string/3x2/US'
    
    console.log(US) // > '<svg xmlns="http://www.w3.org/2000/svg" ...'

    GitHub

    On March 9th, 2020, GitHub, Inc. silently banned my account (erasing all my repos, issues and comments) without any notice or explanation. Because of that, all source codes had to be promptly moved to GitLab. The GitHub repo is now only used as a backup (you can star the repo there too), and the primary repo is now the GitLab one. Issues can be reported in any repo.

    Alternatives

    Credits

    I used Google image search for flag references, and various country flag packs (including FlagKit / flagpack) for design ideas. Sometimes there was no need to re-draw a flag — usually in cases when a flag is just a set of colored stripes and there already is an SVG version of it somewhere at Wikipedia or some other free flag pack, so in those cases I simply copied those flags (because they look the same in every flag pack).

    Some countries officially use their "mother" country flag (those used to be colonies). For example, BV (Bouvet Island) and SJ (Svalbard and Jan Mayen) use the flag of Norway; GP (Guadeloupe) and RE (Réunion) use the flag of France.

    CSS flag icons feature has been submitted by @mindplay-dk.

    Install

    npm i country-flag-icons

    DownloadsWeekly Downloads

    142,519

    Version

    1.4.0

    License

    MIT

    Unpacked Size

    4.75 MB

    Total Files

    1558

    Last publish

    Collaborators

    • avatar