Git Product home page Git Product logo

weather-styled-icon's Introduction

weather-styled-icon

⚠️ This project is no longer maintained due to the a new library for weather icons was released based on only CSS, and I don't see any benefit on using this instead of that.

Build status semantic-release dependabot NPM Version Storybook eslint

Weather styled Icon

Animated and configurable weather icons made in React, using styled-components πŸ’… and CSS Animations.

Live Demo ✨

Icons and styles were taken from this Codepen, please leave him a start 🌟

Installation

> yarn add styled-components weather-styled-icon

Usage example

import React from 'react';
import { Sunny, Cloudy, Rain, Snow } from 'weather-styled-icon';

const App = () => (
  <div>
    <Sunny />
    <Cloudy />
    <Rain />
    <Snow />
  </div>
);

For more examples and usage, please refer to the Docs page.

Theming

Given all the icons are using styled-components, theming is quite easy to do. You can import WeatherThemeProvider from the library, which comes with the default colors already set up, and by providing a new theme object you can override them. You can find the theme structure in this file.

import React from 'react';
import { WeatherThemeProvider, Sunny, Rain } from 'weather-styled-icons';

const myCustomTheme = {
  sunColor: 'Orange',
  raysColor: 'OrangeRed',
};

const App = () => (
  <WeatherThemeProvider theme={myCustomTheme}>
    <Sunny />
    <Rain />
  </WeatherThemeProvider>
);

Contributing

  1. Fork this project: https://github.com/EmaSuriano/weather-styled-icon/fork
  2. Create your feature branch: git checkout -b my-cool-feature
  3. Commit your changes: git commit -am 'feat: add my cool feature'
  4. Push the changes to your repository: git push origin my-cool-feature
  5. Create a new Pull Request: https://github.com/EmaSuriano/weather-styled-icon/compare

Licence

MIT.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.