Talixo Country Flag
Light-weight UI component which represents country flags icons.
How to install
Package is available as @talixo/country-flag in NPM registry, so you can use it in your project
using npm install @talixo/country-flag --save or yarn add @talixo/country-flag.
Requirements
Your package should additionally have some extra dependencies:
prop-types: ^15.6.1react: ^16.2.0react-dom: ^16.2.0@talixo/shared: ^0.1.0
These packages are required by @talixo/country-flag, but you have to install them manually,
to avoid having different versions of these in your application.
Supported props
It allows any property which could be passed to svg. Additionally, it handles some differently:
| Property name | Type | Required | Default | Description |
|---|---|---|---|---|
| className | string | no | n/a | additional class name passed to wrapper |
| code | string | yes | n/a | ISO 3166-1 alpha-2 country code |
Available flags
We are using FlagKit flags loaded through flagkit-web package.
You can either use one of ISO 3166-1 alpha-2 country codes
or use some of additional: gb-eng, gb-nir, gb-sct, gb-wls, gb-zet, lgbt
Updating icons
To reinitialize sprites simply run npm run update in package - it will automatically generate sprite and component which will include it.
When you will want to use another package with SVG icons, change paths.source in config.js.
Changelog
- 0.1.0 - initial version