Skip to content

README.md

Latest commit

 

History

History
34 lines (25 loc) · 1.04 KB

README.md

File metadata and controls

34 lines (25 loc) · 1.04 KB

solid-circle-flags

npm package MIT License

SolidJS component with 300+ minimal circular SVG country flags.

Quick start

Install it:

npm i solid-circle-flags
# or
yarn add solid-circle-flags
# or
pnpm add solid-circle-flags

Use it:

import { CircleFlag, CircleFlagLanguage } from 'solid-circle-flags';

// Using default cdn
<CircleFlag countryCode="us" width={100} height={100}/>
<CircleFlagLanguage languageCode="an" width={100} height={100}/>

// With custom cdn
// You can also set the CDN via the 'VITE_PUBLIC_CIRCLE_FLAGS_CDN_URL' env.
// Do not set the cdn={} if you plan on using the env
<CircleFlag countryCode="es-ar" width={100} height={100} cdn="https://hatscripts.github.io/circle-flags/flags/"/>
<CircleFlagLanguage languageCode="an" width={100} height={100} cdn='some-language-cdn-url'/>