wavescrollbar-react
v1.0.0
Published
π Wavescrollbar React πΈ is a javascript library, which adds modern progress bar at the top.
Downloads
4
Maintainers
yonicbReadme
π Description
π Philosophy
π¦ 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!
// To install using npm
npm install wavescrollbar -S
// Para instalar mediante yarn
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!
<!-- Import the CSS file -->
<link rel="stylesheet" href="css/wavescrollbar-react.css">
<!-- Import the javascript file -->
<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:
// We instantiate the animation method
wavescrollbar.setAnimation() //It does not need parameters.π Method setContainerBackground
Example:
/**
* @param color
* */
//
// Default-> #eeeeee
const color = "#eafbea"
wavescrollbar.setContainerBackground(color)π Method setGradient
Example:
/**
* @param options: object
* */
const options = {
// default-> 90deg
angle: "45deg", // 0deg - 360deg
// Default-> ["#11998e", "#38ef7d"]
colors: [
"#11998e",
"#38ef7d",
"red",
"blue"
]
}
wavescrollbar.setGradient(options)π Method setBackground
Example:
/**
* @param color
* */
// Default-> pink
const color = "red"
wavescrollbar.setBackground(color)π Method setTransition
Example:
/**
* @param options
* */
const options = {
// Default-> .2s
duration: "100ms",
// Default-> 0s
delay: '0s',
// Default-> linear
timing: "ease-in-out" // "linear" | "ease" | "ease-in" | "ease-in-out" | "ease-out"
}
wavescrollbar.setTransition(options)π Method setHeight
Example:
/**
* @param value
* */
// Default-> 5px
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
- Author Yoni Calsin
- Twitter Yoni Calsin
π License
Wavescrollbar is MIT licensed.