# tingle-icon

> tingle-icon component for tingle.

Latest version **1.0.0-rc2** (published 2016-04-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install tingle-icon
pnpm add tingle-icon
yarn add tingle-icon
bun add tingle-icon
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-rc2 |
| Published | 2016-04-01 |
| First published | 2015-08-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | zhangyang |
| Maintainers | gnosaij, lpgray, yize, zoloadang |
| Keywords | tingle-icon, Icon |

## Links

- npm: https://www.npmjs.com/package/tingle-icon
- Repository: https://github.com/tinglejs/tingle-icon
- Homepage: https://github.com/tinglejs/tingle-icon#readme
- Issues: https://github.com/tinglejs/tingle-icon/issues
- npm.io page: https://npm.io/package/tingle-icon

## Dependencies (4)

- [fastclick](https://npm.io/package/fastclick.md) ~1.0.6
- [classnames](https://npm.io/package/classnames.md) ~2.2.3
- [tingle-style](https://npm.io/package/tingle-style.md) ~0.3.1
- [tingle-context](https://npm.io/package/tingle-context.md) ^1.0.1

## 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

- 1.0.0-rc2 (latest) — 2016-04-01
- 1.0.0-rc1 — 2016-04-01
- 0.2.2 — 2015-11-19
- 0.1.1 — 2015-09-11
- 0.1.0 — 2015-09-08
- 0.0.2 — 2015-08-31
- 0.0.1 — 2015-08-28

## README

# tingle-icon

[![npm version](https://badge.fury.io/js/tingle-icon.svg)](http://badge.fury.io/js/tingle-icon)

Icon图标展示，适用于移动端图标展示

<img src="http://gtms01.alicdn.com/tps/i1/TB1LYlgIVXXXXcWXXXXHXIoYFXX-285-253.png" width="285"/>

## Install

```bash
npm install tingle-icon --save
```

## Simple Usage

__[注]__ 使用最新的tingle-icon组件需要最新的tingle-context支持，具体详情可查看History记录。

这是一个 tingle 组件，使用SVG来制作icon系统的解决方案。


```js
<Icon className="icon" id="baby"/>
<Icon className="icon customCls" id="headphones"/>
...
```


## Props

### id

描述：需要引用的SVG的ID标识
类型：'string'
必选：是

示例：

```
<Icon className="icon" id="baby"/>
```

### className

描述：自定义样式名，默认为 'tIcon'
类型：'string'
必选：否

示例：

```
<Icon className="icon" id="xxxx"/>
```

> 注1: id的值默认情况下是根据SVG资源名称相对应的


## Links 相关链接

- [Fire a bug/Issues 提Bug](http://github.com/tinglejs/tingle-icon/issues)

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