# @uiwebkit/icn > Uni Icons Kit Latest version **1.3.2** (published 2023-09-13) · MIT license · 0 weekly downloads ## Install ```sh npm install @uiwebkit/icn pnpm add @uiwebkit/icn yarn add @uiwebkit/icn bun add @uiwebkit/icn ``` ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads; large bundle. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.3.2 | | Published | 2023-09-13 | | First published | 2020-11-05 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 6 | | Unpacked size | 22.4 MB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 3 | | Author | Vitali Havryliuk | | Maintainers | uiwebkit | ## Links - npm: https://www.npmjs.com/package/@uiwebkit/icn - Repository: https://github.com/uiwebkit/icn - Homepage: https://uiwebkit.com/icn/1/ - Issues: https://github.com/uiwebkit/icn/issues - npm.io page: https://npm.io/package/@uiwebkit/icn ## Dependencies (6) - [@stencil/core](https://npm.io/package/@stencil/core.md) 2.14.2 - [@uiwebkit/flag](https://npm.io/package/@uiwebkit/flag.md) 0.2.0 - [bootstrap-icons](https://npm.io/package/bootstrap-icons.md) 1.10.5 - [@uiwebkit/common](https://npm.io/package/@uiwebkit/common.md) 0.2.0 - [@material-design-icons/svg](https://npm.io/package/@material-design-icons/svg.md) 0.14.12 - [@fortawesome/fontawesome-free](https://npm.io/package/@fortawesome/fontawesome-free.md) 5.15.4 ## Recent versions - 1.3.2 (latest) — 2023-09-13 - 1.3.1 — 2023-09-12 - 1.3.0 — 2023-03-16 - 1.2.3 — 2022-03-12 - 1.2.2 — 2021-12-05 - 1.2.1 — 2021-12-03 - 1.2.0 — 2021-12-02 - 1.1.1 — 2021-11-28 - 1.1.0 — 2021-11-13 - 1.0.1 — 2021-10-08 - 1.0.0 — 2021-08-31 - 0.2.0 — 2021-08-31 - 0.1.2 — 2021-08-01 - 0.1.1 — 2021-07-31 - 0.1.0 — 2021-07-31 - … 17 more at https://npm.io/package/@uiwebkit/icn/versions ## 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 Icons Kit Uni Icons Kit is a set of Web Components & Custom Elements to use Material Design Icons, Bootstrap Icons, Font Awesome Icons and Country flags in the declarative style. Uni Icons Kit components have two modes: 1. Custom Element - `100%` convenience; 2. Web Component - `100%` security; 3. Custom Element Wrapper - `100%` customization; Uni Icons Kit 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 Icons Kit 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/icn.git uni-icons cd uni-icons ``` 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). ## Naming Components When creating new component tags, use `uni` in the component name (ex: ``) 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 Icons Kit: ### Script tag - Put a script tag `` in the head of your index.html - To support old browsers, also put a script tag `` 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/icn --save` - Put a script tag similar to this `` in the head of your index.html - To support old browsers, also put a script tag `` 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/icn · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._