npm

Bring the best of OSS JavaScript development to your projects with npm Orgs - private packages & team management tools.Learn more »

react-native-weather

0.2.11 • Public • Published

react-native-weather: A dynamic weather component for React Native apps

react-native-weather provides a React Native <WeatherWidget /> component that takes in props and generates a widget containing the current weather conditions, temperature, and chance of precipitation for a given location via the DarkSky.net weather API.

In order to use this widget, you will need a DarkSky.net API key. Click here to sign up for a DarkSky API key.

Table of Contents

  1. Installation

  2. Usage

  3. Optional Props

  4. Example Usage

  5. Credits

  6. Contribute!

Installation

npm i --save react-native-weather

Usage

To use the WeatherWidget, import the WeatherWidget from 'react-native-weather', placing curly braces around WeatherWidget in your import statement:

...
import { WeatherWidget } from 'react-native-weather';
...

Then place the <WeatherWidget /> component in your render(){ return(); } method, passing your DarkSky.net API key, your latitude (lat), and your longitude(lng) through it as props:

...
render() {
  return(
    <WeatherWidget
      api={"your-DarkSky.net-api-here"}
      lat={"lat"}
      lng={"lng"}
      />
  );
}

<WeatherWidget /> should have a parent view with a style prop of Flex: 1.

Note re: lat & lng

Northern latitudes and eastern longitudes are positive values, while southern latitudes and western longitudes are negative(-) values.

i.e.: If the location you are passing through the widget is in the northwestern hemisphere, you will pass it through as: lat={"val"} lng={"-val"}.

Optional Props

<WeatherWidget /> also accepts the optional prop location={"location"}, which will render a string in the left title area of the widget.

If you do not pass a location prop through WeatherWidget, the default text for the widget title area will read "Current Weather".

Example Usage

The following is an example of the <WeatherWidget /> in use in the Elephant Swamp Guide iOS and Android mobile app.

The Weather Widget in use in the Elephant Swamp Guide app

Please feel free to email me (mail@NickWest.io) screenshots of react-native-weather in use in your app and I will post links/screenshots here!

Credits

react-native-weather was coded by Nick West

react-native-weather was built for use with the DarkSky.net Weather API

react-native-weather uses Allessio Atzeni's Meteocons

Contribute!

If you would like to contribute code to react-native-weather, contact me at mail@NickWest.io with your component and improvement ideas or open up an issue to get my attention!

install

npm i react-native-weather

Downloadsweekly downloads

1

version

0.2.11

license

CC-BY-3.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability