Skip to content

Latest commit

 

History

History
119 lines (86 loc) · 8.15 KB

README.md

File metadata and controls

119 lines (86 loc) · 8.15 KB

React Awesome Loaders

🚀 High quality, super responsive and
completely customisable Loading Animations.

NodeJS NPM Made With Gatsby code style: prettier
Netlify Status Build Status License Maintenance Website Price

Loved the project? Please consider donating to help it improve!

See the official launch of the project and demo on my YouTube Channel.

If you want to discuss about something, then you can ask on my Discord Server.

⭐ Star us on GitHub — it helps!
To view a documentation website, click here

Getting Started 🎬

The easiest way to use one of the loaders from Awesome Loaders is to install the NPM package and import the particular loader to use it.

Install NPM Package

npm install react-awesome-loaders

Import And Use

import { LoaderName } from "react-awesome-loaders"
...
function LoadingComponent(props) {
    return (
        ...
        <LoaderName {...passParametersToCustomise} />
        ...
    );
}
export default LoadingComponent

The loaders are very flexible to import and use wherever you want and in any web framework that uses NPM.
The loaders are auto-responsive. i.e. The size of loader automatically adjusts itself on smaller screen sizes.
Ofcourse, you can set different sizes for different screens by passing props desktopSize and mobileSize.
Read the complete in detail documentation on the project website.

License 📄

This project is licensed under the MIT License - see the LICENSE.md file for details. You can use this project for personal as well as commercial purposes. But if you think you have modified the project and built something really good, we will humbly request you to raise the pull request and share with the opensource community.

Contributing 💡

We have provided detailed description on how & what to contribute to this project on website. Please, take a look.

If you can help us with these. Please don't hesitate to open an pull request or issue. If you want to know about how to create pull request, then please refer to this youtube playlist.

Donate 💉

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can use this project for personal and commercial purpose for free.

However, if you are using this project and happy with it or just want to encourage me to continue creating stuff, there are few ways you can do it :-

  • Giving proper credit when you use this on your project, linking back to it :D
  • Starring, giving shoutouts and sharing the project 🚀
  • You can make one-time donations by clicking the buttons below. I'll probably buy an amazing workstation which will help me build more aggressively.

paypal Buy Me A Coffee

You can look at the Appreciate page on website to know more about how you can help the project.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Ashutosh Hathidara

💻 📖 🎨 🤔 🚧

Satyam Pandey

💻

Julius

📖

This project follows the all-contributors specification. Contributions of any kind welcome!

References 👏🏻

We have used many of the amazing resources to create this project and it is difficult to display all those resources here on github repository.

That is why we have displayed almost all used dependencies on our website.

Also, I have also mentioned the link and profile url of the original concept creators of the loaders at the bottom of corresponding loader documentation on website.