# @uiwebkit/flag

> Uni Flags

Latest version **0.2.0** (published 2022-03-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install @uiwebkit/flag
pnpm add @uiwebkit/flag
yarn add @uiwebkit/flag
bun add @uiwebkit/flag
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2022-03-12 |
| First published | 2021-11-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 10.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Vitali Havryliuk |
| Maintainers | uiwebkit |

## Links

- npm: https://www.npmjs.com/package/@uiwebkit/flag
- Repository: https://github.com/uiwebkit/flag
- Homepage: https://uiwebkit.com/icn/1/flag/?type=element
- npm.io page: https://npm.io/package/@uiwebkit/flag

## Dependencies (2)

- [@stencil/core](https://npm.io/package/@stencil/core.md) 2.14.2
- [@uiwebkit/common](https://npm.io/package/@uiwebkit/common.md) 0.1.3

## Recent versions

- 0.2.0 (latest) — 2022-03-12
- 0.1.1 — 2021-12-03
- 0.1.0 — 2021-12-03
- 0.0.3 — 2021-11-28
- 0.0.2 — 2021-11-28
- 0.0.1 — 2021-11-13

## README

![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)

# Uni Flags

Uni Flags a set of Custom Elements to use Country flags icons in the declarative style.

Uni Flags takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components & Custom Elements that run in any browser supporting the Custom Elements v1 spec.

Uni Flags components are just HTML Web Components & Custom Elements, so they work in any major framework or with no framework at all.

## Getting Started

To start building a new web component using Stencil, clone this repo to a new directory:

```bash
git clone https://github.com/uiwebkit/flags.git uni-flags
cd uni-flags
```

and run:

```bash
npm i
npm run serve:dev
```

To build the component for production, run:

```bash
npm run build:prod
```

Check out our docs [here](https://uiwebkit.com/icn/1/flag/?type=element).


## Naming Components

When creating new component tags, use `uni` in the component name (ex: `<uni-flag>`) or use a prefix that fits your company or any name for a group of related components. For example, all the UiWebKit generated Web Components & Custom Elements use the prefix `uni`.


## Using Components

There are two strategies we recommend for using Uni Flags:

### Script tag

- Put a script tag `<script type="module" src="https://cdn.jsdelivr.net/npm/@uiwebkit/flag@latest/dist/flag/flag.esm.js"></script>` in the head of your index.html
- To support old browsers, also put a script tag `<script nomodule src="https://cdn.jsdelivr.net/npm/@uiwebkit/flag@latest/dist/flag/flag.js"></script>` in the head of your index.html
- Then you can use the element anywhere in your template, JSX, html etc

### Node Modules
- Run `npm i @uiwebkit/flag --save`
- Put a script tag similar to this `<script type="module" src="node_modules/@uiwebkit/flag/dist/flag/flag.esm.js"></script>` in the head of your index.html
- To support old browsers, also put a script tag `<script nomodule src="node_modules/@uiwebkit/flag/dist/flag/flag.js"></script>` in the head of your index.html
- Then you can use the element anywhere in your template, JSX, html etc

---
_Source: https://npm.io/package/@uiwebkit/flag · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._