# uxcore-icon

> uxcore-icon component for uxcore.

Latest version **0.1.29** (published 2019-04-17) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.29 |
| Published | 2019-04-17 |
| First published | 2017-03-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 38.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | eternalsky |
| Maintainers | eternalsky, ex90rts, taoqili |
| Keywords | react, react-component, uxcore-icon, Icon, component |

## Links

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

## Dependencies (3)

- [classnames](https://npm.io/package/classnames.md) ^2.1.2
- [prop-types](https://npm.io/package/prop-types.md) 15.x
- [object-assign](https://npm.io/package/object-assign.md) ^4.0.0

## 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
- [stockfish](https://npm.io/package/stockfish.md) — 27.0K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads

## Recent versions

- 0.1.29 (latest) — 2019-04-17
- 0.1.28 — 2019-04-09
- 0.1.27 — 2019-01-23
- 0.1.26 — 2019-01-18
- 0.1.25 — 2019-01-18
- 0.1.24 — 2018-12-25
- 0.1.23 — 2018-12-24
- 0.1.22 — 2018-08-27
- 0.1.21 — 2018-08-15
- 0.1.20 — 2018-06-14
- 0.1.19 — 2018-05-09
- 0.1.18 — 2018-04-11
- 0.1.17 — 2018-01-16
- 0.1.16 — 2017-10-10
- 0.1.15 — 2017-06-29
- … 13 more at https://npm.io/package/uxcore-icon/versions

## README

## uxcore-icon

React icon

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test Coverage][coveralls-image]][coveralls-url]
[![Dependency Status][dep-image]][dep-url]
[![devDependency Status][devdep-image]][devdep-url] 
[![NPM downloads][downloads-image]][npm-url]

[![Sauce Test Status][sauce-image]][sauce-url]

[npm-image]: http://img.shields.io/npm/v/uxcore-icon.svg?style=flat-square
[npm-url]: http://npmjs.org/package/uxcore-icon
[travis-image]: https://img.shields.io/travis/uxcore/uxcore-icon.svg?style=flat-square
[travis-url]: https://travis-ci.org/uxcore/uxcore-icon
[coveralls-image]: https://img.shields.io/coveralls/uxcore/uxcore-icon.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/uxcore/uxcore-icon?branch=master
[dep-image]: http://img.shields.io/david/uxcore/uxcore-icon.svg?style=flat-square
[dep-url]: https://david-dm.org/uxcore/uxcore-icon
[devdep-image]: http://img.shields.io/david/dev/uxcore/uxcore-icon.svg?style=flat-square
[devdep-url]: https://david-dm.org/uxcore/uxcore-icon#info=devDependencies
[downloads-image]: https://img.shields.io/npm/dm/uxcore-icon.svg
[sauce-image]: https://saucelabs.com/browser-matrix/uxcore-icon.svg
[sauce-url]: https://saucelabs.com/u/uxcore-icon


### Development

```sh
git clone https://github.com/uxcore/uxcore-icon
cd uxcore-icon
npm install
npm run server
```

if you'd like to save your install time，you can use uxcore-tools globally.

```sh
npm install uxcore-tools -g
git clone https://github.com/uxcore/uxcore-icon
cd uxcore-icon
npm install
npm run dep
npm run start
```

### Test Case

```sh
npm run test
```

### Coverage

```sh
npm run coverage
```

## Usage

`<Icon usei name="menu" />`

## Props

| Name | Type | Required | Default | Comments |
|---|---|---|---|---|
|usei|bool|no|false| 使用 `<i>` 标签渲染 ICON，建议开启 |
|name|string|no|shezhi| 图标名字 |
|className|string|no| | 额外类名 |

其他 props 将透传给 icon 元素

## Contribute

Yes please! See the [CONTRIBUTING](https://github.com/uxcore/uxcore/blob/master/CONTRIBUTING.md) for details.

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