@ionic-enterprise/cs-demo-weather-widgets

Demo Weather Widgets

This is a sample custom element library that contains some simple weather related elements. This library contains the following custom elements:

• Simple
  • csdemo-temperature - takes a temperature in Kelvin and displays the value in either Celsius or Fahrenheit
  • csdemo-uv-index - takes a UV Index value and displays the value with a description and color coding
  • csdemo-condition - given a mapping of condition types to image URLs and a condition code, determines which code to use and displays the image with a label
• Compound
  • csdemo-daily-forecast - condition, date, low, high

Usage

If you are using Angular, React, or Vue, please see the framework specific version of this package instead:

• Angular
• React
• Vue

If you are using another framework, or no framework at all, please refer to the Stencil integration docs for hints on how to directly consume Stencil built web components.

Images

This library does not include its own images. In order to inform the library how to get the images to use, you need to set up a mapping object that specifies the image file to use for each of the weather conditions.

Here is an example:

export class IconMap {
  sunny = 'assets/images/sunny.png';
  cloudy = 'assets/images/cloudy.png';
  lightRain = 'assets/images/light-rain.png';
  shower = 'assets/images/shower.png';
  sunnyThunderstorm = 'assets/images/sunny-tstorm.png';
  thunderstorm = 'assets/images/tstorm.png';
  fog = 'assets/images/fog.png';
  snow = 'assets/images/snow.png';
  unknown = 'assets/images/unknown.png';
}

Components

Any component that take a condition assumes that the condition is one of the condition codes used by OpenWeatherMap.org.

Examples shown below are using Angular property bindings. Use whatever is appropriate for the architecture of your application.

csdemo-temperature

Displays the temperature, given in Kelvin, in the given scale (C or F).

<csdemo-temperature scale="F" temperature="297"></csdemo-temperature>

csdemo-condition

Displays the current condition in both text and icon form.

<csdemo-condition [condition]="200" [iconPaths]="iconMap"></csdemo-condition>

csdemo-daily-forecast

Displays the forecast for a given day.

<csdemo-daily-forecast scale="F" [forecast]="forecastData" [iconPaths]="iconMap"></csdemo-daily-forecast>

The forecast property is a forecast data object in the following format:

export interface Forecast {
  date: Date;
  condition: number;
  low: number;
  high: number;
}

The low and high temperatures are specified in Kelvin.

csdemo-uv-index

Displays the UV index along with a risk level, in a color appropriate for the level of risk.

<csdemo-uv-index [uvIndex]="value"></csdemo-uv-index>