llms.txt
Compare with other sites' llms.txt files →# GeoIcons
> GeoIcons is a library of 799 geographic map icons: 255 countries and territories, 167 areas (continents, regions, unions, peninsulas, deserts, basins, seas), and 377 subdivisions (states, provinces, parishes, departments) across 23 countries. Every icon is a map outline of the place, not a flag. It ships as tree-shakable npm packages for React (`@geoicons/react`), Vue (`@geoicons/vue`), Angular (`@geoicons/angular`), and vanilla JavaScript (`@geoicons/vanilla`), and every icon is also a free SVG and PNG download. It is dual-licensed: free under GPLv3 for open source projects, with a commercial license for closed-source use.
## What it is
- **Packages:** `@geoicons/react` (React 18+), `@geoicons/vue` (Vue 3+), `@geoicons/angular` (Angular 15.1+), `@geoicons/vanilla` (no framework; a `createGeoIcons()` scanner that replaces `<i data-geoicon>` placeholders). Same icons and names in every package.
- **Import subpaths:** `@geoicons/<framework>/countries`, `@geoicons/<framework>/areas`, and `@geoicons/<framework>/subdivisions`. Every icon is its own named export, so bundlers ship only the icons you import (about 0.3 KB gzipped each).
- **Names:** countries accept the full name or the ISO 3166-1 alpha-2 code (`UnitedStates` or `Us`). Areas use the name (`EuropeanUnion`, `SaharaDesert`, `Gcc`). Subdivisions join the country code and the name (`UsTexas`, `CaOntario`, `JmKingston`).
- **API:** `size` (default 24) and `strokeWidth` (default 1). Color comes from `currentColor`; set the native `stroke` or `fill` attributes to change it. `fill="currentColor"` gives a solid shape. There is no `variant` or `color` prop.
- **Accessibility:** icons are decorative by default (`aria-hidden`). Pass `aria-label` to make an icon meaningful; it then gets `role="img"` and a `<title>` with a unique id.
## Install
```bash
npm install @geoicons/react
```
```tsx
import { UnitedStates } from "@geoicons/react/countries";
import { UsTexas } from "@geoicons/react/subdivisions";
<UnitedStates size={48} strokeWidth={1.5} aria-label="United States" />
<UsTexas size={48} />
```
## Licensing
- **Free (GPLv3):** for projects released as open source under a GPL-compatible license. No key needed.
- **Commercial:** a license key that waives GPLv3 copyleft for closed-source use, verified fully offline. Hobby $99 one-time or $29/year (1 product), Business $199 or $59/year (unlimited products), Extended $399 or $129/year (redistribution in SDKs, themes, and builders).
## Docs
- [Getting started](https://geoicons.io/docs/getting-started): install and render your first icon in React, Vue, Angular, or vanilla JS.
- [Icon types](https://geoicons.io/docs/icon-types): countries, areas, and subdivisions, and how each is named.
- [API](https://geoicons.io/docs/api): every prop, with pages for [React](https://geoicons.io/docs/api/react), [Vue](https://geoicons.io/docs/api/vue), [Angular](https://geoicons.io/docs/api/angular), and [vanilla JS](https://geoicons.io/docs/api/vanilla).
- [Styling](https://geoicons.io/docs/styling): weight, color, and fill with currentColor.
- [Accessibility](https://geoicons.io/docs/accessibility): decorative by default, meaningful with aria-label.
- [Licensing](https://geoicons.io/docs/commercial-license): GPLv3 vs commercial, and the license provider for each framework.
- [Changelog](https://geoicons.io/docs/changelog): release history.
## Use cases
- [React map icons](https://geoicons.io/use-cases/react-map-icons): country, state, and region outlines as tree-shakable React components, runtime lookups, and Server Components.
- [SVG map icons](https://geoicons.io/use-cases/svg-map-icons): SVG, PNG, and Data URI downloads for Figma and plain HTML, plus coloring an SVG inside an img tag.
- [Open source map icons](https://geoicons.io/use-cases/open-source-map-icons): coverage, using GeoIcons next to Lucide and Heroicons, and how the GPLv3 and commercial licenses work.
## Blog
- [Blog](https://geoicons.io/blog): releases, tutorials, and deep dives ([RSS](https://geoicons.io/blog/feed.xml)).
- [Introducing GeoIcons](https://geoicons.io/blog/introducing-geoicons): the launch post.
- [Subdivision icons](https://geoicons.io/blog/introducing-subdivision-icons): 377 states, provinces, and parishes, and how they are named.
- [Add country icons to a React app](https://geoicons.io/blog/add-country-icons-react), [a Vue 3 app](https://geoicons.io/blog/add-country-icons-vue), and [an Angular app](https://geoicons.io/blog/add-country-icons-angular): step-by-step setup guides.
- [Interactive SVG maps in React](https://geoicons.io/blog/how-to-build-interactive-svg-maps): a clickable region picker and a data-colored state grid without a map library.
- [Build a list view in React](https://geoicons.io/blog/country-listview-react): an accessible country list with icons.
- [Why an icon library doesn't have to bloat your bundle](https://geoicons.io/blog/tree-shaking-icons): how tree-shaking works and why a `<Icon name="..." />` registry defeats it.
- [SVG icons in React Server Components](https://geoicons.io/blog/svg-icons-react-server-components): what ships to the client.
- [Screen-reader accessible SVG icons](https://geoicons.io/blog/svg-icons-screen-reader-accessible): titles, aria-labels, and unique ids.
- [Icons that follow dark mode](https://geoicons.io/blog/dark-mode-icons): theming with currentColor.
- [Map shape icons vs flag emojis](https://geoicons.io/blog/map-shapes-vs-flag-emojis): why outlines work better in country selectors.
- [Aligning icons and labels in Tailwind CSS](https://geoicons.io/blog/visual-alignment-icons-labels-tailwind): sizing and optical alignment.
- [ISO 3166-1 alpha-2 country codes](https://geoicons.io/blog/iso-3166-1-alpha-2-country-codes): a developer's guide.
## Links
- [Home](https://geoicons.io): product overview.
- [Icon catalog](https://geoicons.io/icons): search, customize, copy, and download every icon. Browse [countries](https://geoicons.io/icons/countries), [areas](https://geoicons.io/icons/areas), and [subdivisions](https://geoicons.io/icons/subdivisions).
- [Pricing](https://geoicons.io/pricing): license tiers and FAQ.
- [npm](https://www.npmjs.com/package/@geoicons/react): @geoicons/react (also /vue, /angular, /vanilla).
- [GitHub](https://github.com/getgeoicons/geoicons): source and issues.
## Full documentation
- [llms-full.txt](https://geoicons.io/llms-full.txt): expanded brief with the full API, naming rules, licensing, and FAQ.