# weather-react-icons

> A React component for weather icons for use with Open Weather and Yahoo Weather APIs.

Latest version **4.0.2** (published 2021-06-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install weather-react-icons
pnpm add weather-react-icons
yarn add weather-react-icons
bun add weather-react-icons
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.2 |
| Published | 2021-06-03 |
| First published | 2021-01-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 809.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Taichi Tsujioka |
| Maintainers | taichi-t |
| Keywords | react, react-icon, icon, weather-icon, yahoo, open-weather-map, typescript |

## Links

- npm: https://www.npmjs.com/package/weather-react-icons
- Repository: https://github.com/taichi-t/weather-react-icons
- Homepage: https://github.com/taichi-t/weather-react-icons#readme
- Issues: https://github.com/taichi-t/weather-react-icons/issues
- npm.io page: https://npm.io/package/weather-react-icons

## Dependencies (3)

- [react](https://npm.io/package/react.md) ^17.0.1
- [react-dom](https://npm.io/package/react-dom.md) ^17.0.1
- [weather-icons](https://npm.io/package/weather-icons.md) git+https://github.com/erikflowers/weather-icons.git

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

- 4.0.2 (latest) — 2021-06-03
- 4.0.1 — 2021-02-11
- 4.0.0 — 2021-02-11
- 3.0.0 — 2021-01-04
- 2.0.8 — 2021-01-04
- 2.0.6 — 2021-01-04
- 2.0.5 — 2021-01-04
- 2.0.4 — 2021-01-04
- 2.0.3 — 2021-01-03
- 2.0.2 — 2021-01-03
- 2.0.1 — 2021-01-03
- 2.0.0 — 2021-01-03
- 1.0.2 — 2021-01-03
- 1.0.1 — 2021-01-03
- 1.0.0 — 2021-01-03

## README

# <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/typescript/typescript-original.svg" alt="typescript" width="35" height="35"/> weather-react-icons

![npm](https://img.shields.io/npm/v/weather-react-icons) [![Build Status](https://travis-ci.org/taichi-t/weather-react-icons.svg?branch=master)](https://travis-ci.org/taichi-t/weather-react-icons) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE) ![npm bundle size](https://img.shields.io/bundlephobia/min/weather-react-icons)

A React component for weather icons for use with Open Weather and Yahoo Weather APIs.

## Installaion

`$ npm i weather-react-icons`

## Usage

```javascript
import * as React from 'react';
// The following CSS file must be installed for use of WeatherIcon.
import 'weather-react-icons/lib/css/weather-icons.css';
import { WeatherIcon } from 'weather-react-icons';

const Weather = () => {
  return <WeatherIcon iconId={200} name="owm" night />;
};
```

## WeatherIcon Params

|   Name    |       Type       | Required? | default |                                   Description                                    |
| :-------: | :--------------: | --------- | :-----: | :------------------------------------------------------------------------------: |
|  iconId   |      number      | Required  |         |           Icon Id that OpenWeatherMap and Yahoo Weather API provides.            |
|   name    | `owm` or `yahoo` | Required  |         |                                API name you use.                                 |
|   night   |     boolean      | Optional  |  false  | If sets true, icons change to night icons. (note: night is only for "owe" icons) |
| className |      string      | Optional  |         |                               Your own className.                                |

## CSS usage

if only use CSS files, import them as follows,

```
import 'weather-react-icons/lib/css/weather-icons.css';
import 'weather-react-icons/lib/css/weather-icons-wind.css';
```

## Resources

- [Open Weather API](https://openweathermap.org/) : A scientific yet simple approach to weather forecast. Free. No ads.
- [Yahoo Weather API](https://developer.yahoo.com/weather/) : Get up-to-date weather information for any location, including 10-day forecast, wind, atmosphere, astronomy conditions, and more. You can lookup weather by location (city name) or lat/long.
- [Weather icons](https://erikflowers.github.io/weather-icons/) : The repository is created by [@erikflowers](https://github.com/erikflowers)

## Licensing

- Weather Icons licensed under [SIL OFL 1.1](http://scripts.sil.org/OFL)
- Code licensed under [MIT License](http://opensource.org/licenses/mit-license.html)

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