Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
By Philipp Burckhardt - Oct 17, 2024
wavescrollbar
Advanced tools
wavescrollbar
🚀 Wavescrollbar 🌐 is a javascript library, which adds modern progress bar at the top.
🚀 Wavescrollbar 🌐 is a javascript library, which adds modern progress bar at the top.
🌍 Guia en español
🌐 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!
// 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.css">
</head>
<body>
<wavescrollbar>
</wavescrollbar>
<script src="js/wavescrollbar.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.css">
<!-- Import the javascript file -->
<script src="js/wavescrollbar.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.
FAQs
🚀 Wavescrollbar 🌐 is a javascript library, which adds modern progress bar at the top.
We found that wavescrollbar demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Package last updated on 04 Dec 2019
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Related posts
Product
Enhancing Open-Source Compliance: Introducing Socket’s Advanced License Analysis
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
By Christopher Bailey - Oct 17, 2024
Product
Introducing Socket Optimize
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.
By John-David Dalton - Oct 16, 2024