flag-icons README

The project's README from github.com/lipis/flag-icons. As one markdown file: README.md.

flag-icons

A curated collection of all country flags in SVG — plus the CSS for easier integration. See the demo.

Install

You can either download the whole project as is or install it via npm or Yarn:

npm install flag-icons
# or
yarn add flag-icons

Usage

First, you need to import css:

import "/node_modules/flag-icons/css/flag-icons.min.css";

or use CDN:

<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/gh/lipis/[email protected]/css/flag-icons.min.css"
/>

or use SASS:

@use "node_modules/flag-icons/sass/flag-icons";

// or with custom configuration
@use "node_modules/flag-icons/sass/flag-icons" with (
  // Override path to flags directory
  $flag-icons-path: "node_modules/flag-icons/flags",

  // Include only specific country flags
  $flag-icons-included-countries: ("gr", "de", "gb")
);

You can find all available variables in sass/_variables.scss.

For using the flags inline with text add the classes .fi and .fi-xx (where xx is the ISO 3166-1-alpha-2 code of a country) to an empty <span>. If you want to have a squared version flag then add the class fis as well. Example:

<span class="fi fi-gr"></span> <span class="fi fi-gr fis"></span>

You could also apply this to any element, but in that case you'll have to use the fib instead of fi and you're set. This will add the correct background with the following CSS properties:

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 yarn to install the dependencies after cloning the project and you'll be able to:

To build *.scss files

$ yarn build

To serve it on localhost:8000

$ yarn start

To have only specific countries in the css file, remove the ones that you don't need from the _flag-icons-list.scss file and build it again.

Credits

flag-icons (lipis/flag-icons)

Searching Database…

12.5K ·GitHub
Flag-icons
Что это такое?flag-icons — это подобранная коллекция флагов всех стран в виде SVG-файлов, упакованная вместе с CSS/SASS-классами, чтобы можно было поместить флаг на веб-страницу, указав всего одно имя класса.
Это просто набор файлов с изображениями или в комплекте есть готовые CSS-классы?И то, и другое: исходные SVG-файлы флагов и скомпилированная таблица стилей CSS/SASS, которая задаёт класс для каждого кода страны, так что не нужно самому писать правила background-image.
Как добавить это в проект?Установите через npm или Yarn либо скачайте файлы проекта напрямую, затем подключите CSS (или SASS) и добавьте на него ссылку; также доступен вариант через CDN.
Нужен ли мне инструмент сборки, чтобы этим пользоваться?Нет, можно просто подключить готовый CSS или использовать CDN; Yarn и SASS нужны только если вы хотите самостоятельно собрать и настроить таблицу стилей из исходников.
Можно ли оставить только нужные мне страны?Можно, но для этого потребуется пересборка: удалите ненужные страны из flag-icons-list.scss и заново скомпилируйте SCSS; во время работы для этого встроенной опции нет.
Как именно поставить флаг на страницу?Добавьте классы .fi и .fi-xx (ISO 3166-1-alpha-2 код страны) к пустому элементу; добавьте .fis для квадратной версии или используйте .fib с любым типом элемента, чтобы флаг стал фоном.
Откуда взялось исходное изображение флагов?Проект построен на более старой коллекции SVG-флагов, которая сейчас удалена; её создал участник под именем koppi, он указан в README.
Можно ли использовать флаги с переменными Sass вместо обычного CSS?Да, в проекте есть файл sass/variables.scss со всеми доступными переменными для настройки стилей флагов в вашей сборке SASS.
Как правильно задать размер флагов?CSS задаёт фоновое изображение в фиксированной позиции, поэтому элемент нужно вручную задать в пропорции 4:3 (или добавить класс squared для флага 1:1).
What are similar projects?spectre, devicon, pure, tabler, feather, dashboards, Font-Awesome, css.gg
Which topics is it in?assets, static, ui-design, icons, responsive, frontend-framework, offline-first, svg, design, customization, css, html
Creator
lipis
Size
16.5 MB
Stars
12.5K
Updated
CommitOct 16Releasev7.6.0Oct 15
Age
13y
Commits · 90 Days