rf-region-flags 1.0.0

package/README.md

@@ -0,0 +1,71 @@
+# rf-region-flags
+
+React-библиотека: флаги субъектов Российской Федерации по коду региона. **Все 89 флагов встроены в библиотеку** (data URI), ничего копировать не нужно — установил пакет и используешь. Размер пакета ~10 MB (сжатие при загрузке страницы уменьшит объём).
+
+## Установка
+
+```bash
+npm install rf-region-flags react
+```
+
+## Использование
+
+```tsx
+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>` |
+
+### Вспомогательные функции
+
+```ts
+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.

package/dist/RegionFlag.d.ts

@@ -0,0 +1,19 @@
+import React from 'react';
+export interface RegionFlagProps extends Omit<React.ImgHTMLAttributes<HTMLImageElement>, 'src' | 'alt'> {
+    /** Код региона (ISO 3166-2 без RU- или алиас), например: KYA — Красноярский край, MOW — Москва */
+    code: string;
+    /** Размер по ширине (по умолчанию 32) */
+    size?: number;
+    /** Alt-текст (по умолчанию — код региона) */
+    alt?: string;
+}
+/**
+ * Компонент флага субъекта РФ по коду региона.
+ * Источник флагов: Wikimedia Commons (страница «Флаги субъектов Российской Федерации»).
+ *
+ * @example
+ * <RegionFlag code="KYA" />  // Красноярский край
+ * <RegionFlag code="MOW" size={48} />  // Москва, 48px
+ */
+export declare function RegionFlag({ code, size, alt, ...imgProps }: RegionFlagProps): React.ReactElement | null;
+export default RegionFlag;

package/dist/flagUrls.generated.d.ts

@@ -0,0 +1 @@
+export declare const FLAG_DATA_URI: Record<string, string>;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { RegionFlag } from './RegionFlag';
+export type { RegionFlagProps } from './RegionFlag';
+export { REGION_FLAG_FILES, getFlagUrl, getFlagPath, getRegionCodes, } from './regionFlags';