Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More β†’
Socket
Sign inDemoInstall
Socket

wavescrollbar

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

wavescrollbar

πŸš€ Wavescrollbar 🌐 is a javascript library, which adds modern progress bar at the top.

  • 1.0.2
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

Wavescrollbar Logo

πŸš€ Wavescrollbar 🌐 is a javascript library, which adds modern progress bar at the top.

NPM Version Package License NPM Downloads Coverage

🌍 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Β°MethodParameter
1setAnimationNone
2setContainerBackgroundcolor
3setGradientoptions
4setBackgroundcolor
5setTransitionoptions
6setHeightvalue
πŸ“š 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

Yoni Stack Yoni Stack

🎩 Stay in touch

πŸ“œ License

Wavescrollbar is MIT licensed.

Keywords

FAQs

Package last updated on 04 Dec 2019

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚑️ by Socket Inc