@sankyu/react-circle-flags
API Reference for @sankyu/react-circle-flags
Interfaces
Section titled “Interfaces”| Interface | Description |
|---|---|
| BuildMeta | Metadata captured when the React package is built. |
| - | |
| FlagComponentProps | Standard SVG properties accepted by generated React flag components. |
Type Aliases
Section titled “Type Aliases”| Type Alias | Description |
|---|---|
| CountryCode | Semantic alias for the complete normalized FlagCode union. |
| DynamicFlagProps | Props for DynamicFlag. |
| FlagCode | Union of every normalized flag code accepted by strict APIs. |
| FlagSizeName | - |
Variables
Section titled “Variables”| Variable | Description |
|---|---|
| buildMeta | Build and source revision metadata for the installed React package. |
| FLAG_REGISTRY | Map normalized flag codes to their generated component names. |
| FlagSizes | Standard flag sizes |
| FlagUtils | Framework-neutral helpers for validating, formatting, and sizing flag codes. |
Functions
Section titled “Functions”| Function | Description |
|---|---|
| - | |
| coerceFlagCode | - |
| DynamicFlag | Renders a generated flag component from a runtime country or subdivision code. |
| getSizeName | Get size name from pixel value |
| isFlagCode | - |