@latice/flags-vue
v0.1.3
Published
Country flag components for Vue. Lightweight, tree-shakable, SSR-ready.
Downloads
62
Maintainers
Readme
Country flag components for Vue. 250+ flags, three sizes, optional border, shadow and gradient overlays. Ships two entry points: a dynamic component that lazy-loads flags on demand, and a static entry for full tree-shaking.
Installation
npm install @latice/flags-vue
# or
pnpm add @latice/flags-vueUsage
Dynamic
Flag lazy-loads each SVG on first render and caches the result for subsequent renders – no upfront bundle cost regardless of how many codes your app might encounter. The right choice when you want zero configuration and don't mind a small runtime registry.
<script setup>
import { Flag } from "@latice/flags-vue";
</script>
<template>
<Flag code="PL" size="md" />
<!-- Alpha-2 -->
<Flag code="POL" size="lg" />
<!-- Alpha-3 -->
<Flag code="616" size="sm" />
<!-- Numeric -->
</template>Static — fully tree-shakable
Import individual flag components directly. Only the flags you import end up in your bundle — ideal when you know upfront which flags you need.
<script setup>
import { FlagPL, FlagGB_SCT } from "@latice/flags-vue/static";
</script>
<template>
<FlagPL size="lg" shadow />
<FlagGB_SCT size="sm" :rounded="false" />
</template>Naming: Flag + ISO 3166 Alpha-2, uppercase. Hyphens become underscores: GB-SCT => FlagGB_SCT.
API
| Key | Value | Required | Default | Format |
| :--------- | :-------- | :------- | :------ | :----------------------------------------------------------------------------------------------------- |
| code | string | true* | — | See all codes |
| size | string | false | 'md' | 'sm', 'md', 'lg' |
| gradient | string | false | — | 'top-down', 'linear' |
| shadow | boolean | false | false | — |
| border | boolean | false | true | — |
| rounded | boolean | false | true | — |
*
codeis required for<Flag>only. Individual flag components from the static entry (<FlagPL />, etc.) do not accept a code prop.
Special codes
Beyond standard ISO 3166-1 country codes, the library includes a small collection of additional flags such as constituent countries, territories, and international organizations.
UK constituent countries
| Code | Territory |
| :------- | :-------- |
| GB-ENG | England |
| GB-SCT | Scotland |
| GB-WLS | Wales |
<Flag code="GB-SCT" />
<!-- static: <FlagGB_SCT /> -->