Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wiredmax/react-flags
Flags of the world react component
https://github.com/wiredmax/react-flags
Last synced: 4 months ago
JSON representation
Flags of the world react component
- Host: GitHub
- URL: https://github.com/wiredmax/react-flags
- Owner: wiredmax
- License: mit
- Created: 2015-06-09T17:36:57.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-09-22T15:51:35.000Z (about 5 years ago)
- Last Synced: 2024-08-03T22:08:26.041Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 7.17 MB
- Stars: 86
- Watchers: 8
- Forks: 28
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# react-flags
Flags of the world react component
[![Dependency Status][deps-badge]][deps]
[![devDependency Status][dev-deps-badge]][dev-deps]
[![peerDependency Status][peer-deps-badge]][peer-deps]
## Options
#### `country`: PropTypes.string (default: `_unknown`)
The ISO 3166-1 alpha-2 or alpha-3 of the country's flag or one of the following:
- `_abkhazia`
- `_basque-country`
- `_british-antarctic-territory`
- `_commonwealth`
- `_england`
- `_kosovo`
- `_mars`
- `_nagorno-karabakh`
- `_nato`
- `_northern-cyprus`
- `_olympics`
- `_red-cross`
- `_scotland`
- `_somaliland`
- `_south-ossetia`
- `_united-nations`
- `_unknown`
- `_wales`
#### `format`: PropTypes.string (default: 32)
- `png`: square png file.
- `icns`: square icns file.
- `ico`: square ico file.
- `svg`: normal sized flag SVG file.
#### `pngSize`: PropTypes.number (default: 32)
Size of the flag if we are using the PNG format.
Possible values are:
- `16`: 16 pixels
- `24`: 24 pixels
- `32`: 32 pixels
- `48`: 48 pixels
- `64`: 64 pixels
#### `shiny`: PropTypes.bool (default: `false`)
Display a shiny of flat flag. Default is a flat flag.
#### `width`: PropTypes.number (default: null)
Width of the flag ![]()
HTML tag.
#### `height`: PropTypes.number (default: null)
Height of the flag ![]()
HTML tag.
#### `alt`: PropTypes.string (default: `this.props.name`)
Alternative text of the flag ![]()
HTML tag.
#### `basePath`: PropTypes.string (default: `/img/flags`)
The base path of where the flags files from the vendor folder are in your project.
## Installation
```bash
npm install --save react-flags
```
You need to copy the content of the `vendor` folder to your local project. The default base path is `/img/flags`
## Usage
```js
import React from "react";
import Flag from "react-flags";
const App = React.createClass({
render() {
return (
);
}
});
React.render(, document.body);
```
## Development and testing
```bash
npm install
npm start
```
Then work on the `Flag.jsx` component in `src`.
## Change log
See the [change log](https://github.com/wiredmax/react-flags/blob/master/CHANGELOG.md).
## Sources
- [GoSquared](https://www.gosquared.com) - [2600 Flag Icon Set](https://www.gosquared.com/resources/flag-icons/)
- [flag-icon-css](http://flag-icon-css.lip.is/) - SVG flags icons
## Author
Maxime Poulin
## License
MIT (See [LICENSE](https://github.com/wiredmax/react-flags/blob/master/LICENSE))
[deps-badge]: https://david-dm.org/wiredmax/react-flags.svg
[deps]: https://david-dm.org/wiredmax/react-flags
[dev-deps-badge]: https://david-dm.org/wiredmax/react-flags/dev-status.svg
[dev-deps]: https://david-dm.org/wiredmax/react-flags#info=devDependencies
[peer-deps-badge]: https://david-dm.org/wiredmax/react-flags/peer-status.svg
[peer-deps]: https://david-dm.org/wiredmax/react-flags#info=peerDependencies