🚀 Wavescrollbar React 🌐 is a javascript library, which adds modern progress bar at the top.
🌐 Description
Wavescrollbar is a library to create a modern, efficient and scalable scroll bar. It uses modern JavaScript, is built with TypeScript (retains compatibility with pure JavaScript) and combines elements of OOP (Object Oriented Programming).
Under the hood, Wavescrollbar uses javascript, but also provides compatibility with a wide range of other libraries, such as p. Eg ReactJs, Vuejs, Angular, which allows easy use of the countless third-party add-ons that are available.
📝 Philosophy
Wavescrollbar aims to provide a ready-to-use application architecture that allows effortless creation of applications with progress bar at the top, and highly verifiable, scalable, poorly coupled and easy to maintain.
📦 Installation
To start using Wavescrollbar you need to install it with the package manager npm or yarn, as shown in the next section or download it directly!
npm install wavescrollbar -S
yarn add wavescrollbar
▶️ Getting started
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Wavescrollbar</title>
<link rel="stylesheet" href="css/wavescrollbar-react.css">
</head>
<body>
<wavescrollbar>
</wavescrollbar-react>
<script src="js/wavescrollbar-react.js"></script>
<script>
var wavescrollbar = new Wavescrollbar()
</script>
</body>
</html>
Add the javascript and css file to make it work properly!
<link rel="stylesheet" href="css/wavescrollbar-react.css">
<script src="js/wavescrollbar-react.js"></script>
📝 Features
N° | Method | Parameter |
---|
1 | setAnimation | None |
2 | setContainerBackground | color |
3 | setGradient | options |
4 | setBackground | color |
5 | setTransition | options |
6 | setHeight | value |
📚 Method setAnimation
Example:
wavescrollbar.setAnimation()
📚 Method setContainerBackground
Example:
const color = "#eafbea"
wavescrollbar.setContainerBackground(color)
📚 Method setGradient
Example:
const options = {
angle: "45deg",
colors: [
"#11998e",
"#38ef7d",
"red",
"blue"
]
}
wavescrollbar.setGradient(options)
📚 Method setBackground
Example:
const color = "red"
wavescrollbar.setBackground(color)
📚 Method setTransition
Example:
const options = {
duration: "100ms",
delay: '0s',
timing: "ease-in-out"
}
wavescrollbar.setTransition(options)
📚 Method setHeight
Example:
const height = "10px"
wavescrollbar.setHeight(height)
⭐ Support for
Wavescrollbar is an open source project licensed by MIT. You can grow thanks to the sponsors and the support of the amazing sponsors. If you want to join them, contact me here.
🎩 Contributors
🎩 Stay in touch
📜 License
Wavescrollbar is MIT licensed.