# koi-icons

> KUI的iconfont组件

Latest version **0.0.3** (published 2023-06-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install koi-icons
pnpm add koi-icons
yarn add koi-icons
bun add koi-icons
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2023-06-20 |
| First published | 2023-06-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 455.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | 樊浩强 |
| Maintainers | elcker |
| Keywords | koi-icons, vue |

## Links

- npm: https://www.npmjs.com/package/koi-icons
- Repository: https://gitee.com/koi_2/koi-ui
- npm.io page: https://npm.io/package/koi-icons

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 0.0.3 (latest) — 2023-06-20
- 0.0.2 — 2023-06-08

## README

## Introduction

<p>  
  <a href="https://www.npmjs.com/package/koi-icon"><img src="https://img.shields.io/npm/v/koi-icon.svg?sanitize=true" alt="Version"></a>
  <a href="https://www.npmjs.com/package/koi-icon-vue"><img src="https://img.shields.io/npm/l/koi-icon.svg?sanitize=true" alt="License"></a>
  <a href="https://travis-ci.org/sentsin/kui"><img alt="Build Status" src="https://img.shields.io/travis/sentsin/kui/master.svg"></a>
  <a href="https://coveralls.io/r/sentsin/kui?branch=master"><img alt="Test Coverage" src="https://img.shields.io/coveralls/sentsin/kui/master.svg"></a>
</p>

**[🔶 Explore the docs »](http://www.koi-vue.com)** **[Join us](https://jq.qq.com/?_wv=1027&k=ffiUQgnE)**

The abstract trees of the kui iconfont icons.

## Get Started

Use npm to install.

```bash
npm i koi-icon
```

Font icon files need to be introduced before use

```
import "koi-icon/lib/index.css"
```

Componentization, using the class of iconfont as the component name.

```
<template>
    <AlignCenterIcon></AlignCenterIcon>
    <DiamondIcon></DiamondIcon>
</template>

<script lang="ts" setup>
import { AlignCenterIcon, DiamondIcon } from 'koi-icon';
</script>
```

Traditionally, components are rendered by passing class through type.

```
<template>
  <!-- 动态图标 -->
  <KIcon type="koi-icon-not-found"></KIcon>
  <KIcon type="koi-icon-diamond"></KIcon>
</template>

<script lang="ts" setup>
import { KIcon } from 'koi-icon';
</script>
```

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