react-weather

0.1.3 • Public • Published

Alt text

ReactWeather

npm license

Minimalistic react weather component.

Features

  • Beautiful Widgets
  • Minimal Design
  • Supports openweathermap API
  • Extendable to more external API'S
  • Simple & Minimal API.

Installing

Install via npm:

npm install react-weather --save

Quick Example

This example shows how to use the GenericWeather component. The component display static data via props.

import ReactDOM from 'react-dom';
import { GenericWeather } from 'react-weather';
 
 
ReactDOM.render(
  <GenericWeather city="Jerusalem" temp=17.61 status="sun" />,
  document.getElementById('root')
)

Example using Openweathermap api

https://openweathermap.org/api - Get real time weather via Openweathermap api.

import ReactDOM from 'react-dom';
import { OpenWeatherMap } from 'react-weather';
 
 
ReactDOM.render(
  <OpenWeatherMap city="Jerusalem" country="IL" appid="your-api-key" />,
  document.getElementById('root')
)

ReactWeather API

GenericWeather

The basic component is GenericWeather. this component is the main component, all the other components use it.

<GenericWeather />

props:

  • city - The city name
  • temp - the temperature
  • status - the icon to show - meanwhile it's just sun / rain
OpenWeatherMap

This component use the openweathermap api to get weather data. the component fetch using axios data from the api, and render the GenericWeather for you.

<OpenWeatherMap />

props:

  • city - The city name - required
  • country - The country code - not required
  • appid - The api key from openweathermap - required
  • units - The units of the temperature - metric / imperial - not required, default is metric

Credits

ReactWeather is inspired by Soumya Ranjan Bishi credits to Alberto Jerez about the sass code

License

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i react-weather

Weekly Downloads

19

Version

0.1.3

License

MIT

Last publish

Collaborators

  • shakedamar