npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@substrate-system/scroll-progress

v0.1.6

Published

A webcomponent that shows scroll progress

Downloads

7

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

nichothnichoth

Keywords

scrollprogresscomponent

Readme

scroll progress

tests types module semantic versioning license

A progress bar that shows how far down the page you have scrolled, implemented as a web component.

demonstration

See substrate-system.github.io/scroll-progress for an example with the default CSS.

install

npm i -S @substrate-system/scroll-progress

use

You've got options.

Bundler

Use this with a bundler by using import syntax.

import '@substrate-system/scroll-progress'
import '@substrate-system/scroll-progress/css'
// or minified css
import '@substrate-system/scroll-progress/min/css'

pre-bundled

This is the progress component and its one dependency, raf-scroll, combined into a single file. First copy the bundled file to a location that is accessible to your web server:

cp ./node_modules/@substrate-system/scroll-progress/dist/index.bundle.js ./public/scroll-progress.js

Then link to the bundled file, and you can use as an html element.

<body>
    <scroll-progress></scroll-progress>
</div>
<script type="module" src="./scroll-progress.js"></script>

pre-bundled + minifed

Copy the bundled and minified file to a location that is accessible to your web server:

cp ./node_modules/@substrate-system/scroll-progress/dist/index.bundle.min.js ./public/scroll-progress.min.js

Link to the minified file in HTML:

<body>
    <scroll-progress></scroll-progress>
</div>
<script type="module" src="./scroll-progress.min.js"></script>

css

Override the variable --scroll-progress-color to customize the color.

.scroll-progress {
    --scroll-progress-color: pink;
}

examples

// index.js
import { ScrollProgress } from '@substrate-system/scroll-progress'
<!-- index.html -->
<body>
    <div id="root">
        <scroll-example></scroll-example>
    </div>

    <script type="module" src="./index.js"></script>
</body>

pre-bundled

First copy a bundled file to a place where your webserver can access it.

cp ./node_modules/@substrate-system/scroll-progress/dist/index.bundle.min.js ./public/scroll-progress.js
cp ./node_modules/@substrate-system/scroll-progress/dist/index.min.css ./public/scroll-progress.css

Then include a script tag in HTML, and use the component like any other HTML element.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">

    <!-- link to the css -->
    <link rel="stylesheet" href="./scroll-progress.css">
    <title>Example</title>
</head>

<body>
    <div id="root">
        <scroll-progress></scroll-progress>
    </div>

    <!-- link to JS -->
    <script type="module" src="./scroll-progress.js"></script>
</body>
</html>

develop

Start a localhost server:

npm start