mirror of
https://github.com/lipis/flag-icons.git
synced 2024-11-24 19:36:55 +01:00
74 lines
1.9 KiB
Markdown
74 lines
1.9 KiB
Markdown
# flag-icons
|
|
|
|
> A collection of all country flags in SVG — plus the CSS for easier integration.
|
|
> See the [demo](https://flagicons.lipis.dev).
|
|
|
|
## Install
|
|
|
|
You can either [download](https://github.com/lipis/flag-icons/archive/master.zip)
|
|
the whole project as is or install it via Bower or NPM:
|
|
|
|
```bash
|
|
$ npm install flag-icons
|
|
```
|
|
|
|
## Usage
|
|
|
|
For using the flags inline with text add the classes `.flag-icon` and
|
|
`.flag-icon-xx` (where `xx` is the
|
|
[ISO 3166-1-alpha-2 code](https://www.iso.org/obp/ui/#search/code/)
|
|
of a country) to an empty `<span>`. If you want to have a squared version flag
|
|
then add the class `flag-icon-squared` as well. Example:
|
|
|
|
```html
|
|
<span class="flag-icon flag-icon-gr"></span>
|
|
<span class="flag-icon flag-icon-gr flag-icon-squared"></span>
|
|
```
|
|
|
|
You could also apply this to any element, but in that case you'll have to use the
|
|
`flag-icon-background` instead of `flag-icon` and you're set. This will add the
|
|
correct background with the following CSS properties:
|
|
|
|
```css
|
|
background-size: contain;
|
|
background-position: 50%;
|
|
background-repeat: no-repeat;
|
|
```
|
|
|
|
Which means that the flag is just going to appear in the middle of an element, so
|
|
you will have to set manually the correct size of 4 by 3 ratio or if it's squared
|
|
add also the `flag-icon-squared` class.
|
|
|
|
## Development
|
|
|
|
Run the `npm install` to install the dependencies after cloning the project and
|
|
you'll be able to:
|
|
|
|
To watch for changes and live reload if served
|
|
|
|
```bash
|
|
$ grunt
|
|
```
|
|
|
|
To build `*.less` files
|
|
|
|
```bash
|
|
$ grunt build
|
|
```
|
|
|
|
To serve it on `localhost:8000`
|
|
|
|
```bash
|
|
$ grunt connect
|
|
```
|
|
|
|
To have only specific countries in the css file, remove the ones that you don't
|
|
need from the
|
|
[`flag-icon-list.less`](https://github.com/lipis/flag-icons/blob/master/less/flag-icon-list.less)
|
|
file and build it again.
|
|
|
|
## Credits
|
|
|
|
This project wouldn't exist without the awesome and now deleted collection of
|
|
SVG flags by [koppi](https://github.com/koppi).
|