1.0.0 • Published 6 months ago

ngx-weather v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

ngx-weather

npm npm NPM GitHub issues

Overview

ngx-weather is an Angular library that provides a weather widget for displaying current weather conditions and forecasts in your Angular applications. It's designed to be highly customizable and easy to integrate into your projects.

!IMPORTANT This library provide an api key from weatherapi

Features

  • Display current weather conditions (temperature, description, icon).
  • Show weather forecasts for the upcoming days.
  • Automatic geolocation detection or manual location setting.
  • Units conversion (Celsius/Fahrenheit).

Supported Versions

Angular Versionngx-weather VersionStatus
>= 16.x>= 1.0.0✅ Supported
< 16.0>= 1.0.0❌ Not Supported

Installation

You can install ngx-weather via npm or yarn. Make sure you have Angular installed in your project.

npm install ngx-weather
# or
yarn add ngx-weather

Usage

Import the Module

In your Angular module, import and add the NgxWeatherModule to the imports array.

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    //...
    NgxWeatherModule.forRoot({
      apiKey: '--Your weatherapi key--'
      }),
    //...
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

Weather Widget Component

In your template, use the <ngx-weather> component to display the weather widget. You can configure it with various options.

<ngx-weather
  [options]="{location: 'Tunisia'}"
></ngx-weather>

Additional Options

Here are the available options you can use when configuring the NgxWeatherComponent:

PropertyTypeRequiredDefault ValueDescription
typeWidgetTypeEnumNo"FORECAST"Widget type (day, week, or forecast)
temperatureUnitsTemperatureUnitsEnumNoCELSIUSTemperature units (CELSIUS or FAHRENHEIT)
langLanguagesEnum (optional)No"en"Language for weather information
locationstring or PositionModelYesnullWeather location (string or PositionModel)
daysnumberNo3Number of days for weather forecast

Social Links:

LinkedIn GitHub Repo

1.0.0

6 months ago

0.0.2

6 months ago

0.0.1

6 months ago