https://github.com/polgubau/flags
A react library for displaying fancy flags as components with metadata and multiple customization options
https://github.com/polgubau/flags
flags library react svg
Last synced: 3 months ago
JSON representation
A react library for displaying fancy flags as components with metadata and multiple customization options
- Host: GitHub
- URL: https://github.com/polgubau/flags
- Owner: PolGubau
- License: mit
- Created: 2024-11-19T18:27:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-17T08:05:48.000Z (over 1 year ago)
- Last Synced: 2025-03-24T19:29:32.552Z (over 1 year ago)
- Topics: flags, library, react, svg
- Language: TypeScript
- Homepage: https://flags.polgubau.com
- Size: 7.41 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# **React Beauty Flags**
**React Beauty Flags** is a simple and elegant collection of over 250 flags from around the world, designed with a modern and user-friendly aesthetic. Perfect for your React projects, these flags include countries, regions, cities, historical symbols, and more.
## **Features**
- 🌍 Over 250 beautifully designed flags
- 📦 Lightweight and easy to integrate
- 🎨 Simple, modern, and consistent design
- 🛠️ Fully customizable and open source
## **Installation**
```bash
npm install react-beauty-flags
```
## **Usage**
```jsx
import { Flag } from "react-beauty-flags"
function App() {
return (
)
}
export default App
```
### **Props**
- **`code`** (string): The ISO code of the flag to display.
- **`size`** (number | string, optional): Set the flag's width (height adjusts automatically).
All native svg's props can also be passed.
## **Flags Included**
React Beauty Flags includes:
- Country flags
- Regional flags
- City flags
- Historical
- Symbolic flags
For a complete list, visit [Flags Directory](https://flags.polgubau.com/).
## **Contributing**
Contributions are welcome! If you find a bug or have a flag design to add, feel free to open an issue or submit a pull request.
## **Author**
Created by [Pol Gubau Amores](https://polgubau.com/).
## **License**
This project is open source under the MIT License.
## **Links**
- 🌐 [Website](https://flags.polgubau.com/)
- 📦 [npm Package](https://www.npmjs.com/package/react-beauty-flags)
- 🐙 [GitHub Repository](https://github.com/PolGubau/flags)
---
Hope you enjoy using React Beauty Flags! 🚀