rf-region-flags
v1.0.0
Published
React library: flags of Russian Federation subjects by region code
Maintainers
Readme
rf-region-flags
React-библиотека: флаги субъектов Российской Федерации по коду региона. Все 89 флагов встроены в библиотеку (data URI), ничего копировать не нужно — установил пакет и используешь. Размер пакета ~10 MB (сжатие при загрузке страницы уменьшит объём).
Установка
npm install rf-region-flags reactИспользование
import { RegionFlag } from 'rf-region-flags';
// Красноярский край
<RegionFlag code="KYA" />
// Москва
<RegionFlag code="MOW" />
// Санкт-Петербург, размер 48px
<RegionFlag code="SPE" size={48} />
// С дополнительными пропсами img
<RegionFlag code="TA" alt="Татарстан" className="rounded" />Коды регионов
Используются коды ISO 3166-2 (без префикса RU-) и распространённые алиасы:
| Код | Субъект | |-----|--------| | KYA | Красноярский край | | MOW, MSK | Москва | | SPE, SPB | Санкт-Петербург | | AD | Адыгея | | BA | Башкортостан | | TA | Татарстан | | KDA | Краснодарский край | | NVS | Новосибирская область | | … | все 89 субъектов РФ |
Полный список кодов: import { getRegionCodes } from 'rf-region-flags' → getRegionCodes().
API
<RegionFlag />
| Проп | Тип | По умолчанию | Описание |
|------|-----|--------------|----------|
| code | string | — | Код региона (обязательный) |
| size | number | 32 | Ширина и высота в пикселях |
| alt | string | Флаг региона {code} | Атрибут alt |
| остальные | — | — | Пробрасываются в <img> |
Вспомогательные функции
import { getFlagUrl, getFlagPath, getRegionCodes, REGION_FLAG_FILES } from 'rf-region-flags';
getFlagUrl('KYA'); // → data URI флага (картинка встроена в библиотеку)
getFlagPath('KYA'); // → 'Flag_of_Krasnoyarsk_Krai.svg'
getRegionCodes(); // → массив всех кодов
REGION_FLAG_FILES; // → объект код → имя файлаЛицензия
MIT. Флаги — официальные символы субъектов РФ; изображения с Wikimedia Commons.
