/lit-weather

Lit powered weather forecast web component, leveraging the OpenWeatherMap API. It's customizable with tailwindcss, lightweight, and shadow dom free.

Primary LanguageTypeScriptMIT LicenseMIT

lit-weather

Lit powered weather forecast web component, leveraging the OpenWeatherMap API. It's customizable with tailwindcss, lightweight, and shadow dom free. Replaces paper-weather

example

Installation

pnpm i -S lit-weather

Usage

import 'lit-weather';

<lit-weather api-key="API_KEY" query="ZIP_CODE_OR_CITY" />;

Getting an API Key

To use the lit-weather component, you will need an API key from OpenWeatherMap. You can get one here. Afrer you request a key, it take a few minutes to be approved.

Free tier limits are:

  • 60 calls/minute
  • 1,000,000 calls/month

I left a key exposed in the demo but it is not guaranteed to work.I don't know if they enfore these limits as I have not reached them but have definitely made more than 60 calls/minute. 😄

The component calls both the "current weather" and "3-hour forecast 5 days" endpoints.

Styles

Shadow root is turned off, styles are accessible just like any other html element. This is done so that you can style the component to your liking and we can use tailwindcss without shipping any css. We provide classes for each element in the component.

If you do not overwrite the styles and want to use the default tailwind classes, you must either import the dist/tw.css file or include the dist/dist/src/LitWeather.js in your tw configs content array.

/** @type {import('tailwindcss').Config} */
module.exports = {
  darkMode: 'class',
  content: ['node_modules/lit-weather/dist/src/LitWeather.js'],
  theme: {
    extend: {},
  },
  plugins: [],
};

Frameworks

This should work in any framework that supports web components. If you have any issues, please open an issue.

Roadmap

Aknowledgements