# theme-icons

> A simple icon collection for when you just need essential icons.

Latest version **0.1.4** (published 2021-07-14) · MIT license · 0 weekly downloads

## Install

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

## 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.4 |
| Published | 2021-07-14 |
| First published | 2021-07-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | José Ulisses |
| Maintainers | jos3s |
| Keywords | icons, theme, theme icons |

## Links

- npm: https://www.npmjs.com/package/theme-icons
- Repository: https://github.com/jos3s/theme-icons
- Homepage: https://github.com/jos3s/theme-icons#readme
- Issues: https://github.com/jos3s/theme-icons/issues
- npm.io page: https://npm.io/package/theme-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.1.4 (latest) — 2021-07-14
- 0.1.3 — 2021-07-14
- 0.1.2 — 2021-07-14
- 0.1.1 — 2021-07-14
- 0.1.0 — 2021-07-14

## README

# Theme Icons

A simple icon collection for when you just need essential icons.

## Installation and How to use

In your react project, use:

```bash
npm i theme-icons

-- or -- 

yarn add theme-icons

```

example usage:

```jsx
import { Moon } from "theme-icons";

function ThemeSwitch() {
  render() {
    return <button>  <Moon /> Switch Theme? </button>
  }
}
```

## Props

example usage

```jsx
import { Moon } from "theme-icons";

function ThemeSwitch() {
  render() {
    return <button><Moon color="#C4C4C4" details="#E5E5E5" /> </button>
  }
}
```

| Key         | Default     | Type     | Notes                           |
| ----------- | ----------- | -------- | ------------------------------- |
| `color`     | `white`     | `string` | use to set main icon color      |
| `details`   | `undefined` | `string` | use to set secondary color if it exists |
| `size`      | `22`        | `number` |                           |

## Icons avaliable

- `Moon`
- `Sun`
- `FullMoon`

## License

- [MIT](./LICENSE.md)

---

<p align="center">
   Developed by <a href="https://github.com/jos3s">José Ulisses </a>
</p>

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