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

@axn/backtotop

v1.0.1

Published

Simple back-to-top button library.

Downloads

11

Vulnerabilities

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

Links

Git

Maintainers

axnaxn

Keywords

a11yaccessibilityback-to-top

Readme

BackToTop

BackToTop is a package with no dependencies to make simple "back to top" buttons.

Table of Contents

Install

Installing with npm:

npm i @axn/backtotop

Usage

BackToTop makes use of ESM exports. Most bundlers can import the module directly like so:

import * as BackToTop from '@axn/backtotop';

const element = document.querySelector('#back-to-top');
const button = BackToTop.applyToElement(element, {
    animationInDuration: 1000
});

// Destroy BackToTop when you're done
button.destroy();

For a full example, see floating-button.html.

Docs

applyToElement(element, [options]) {#docs-applytoelement}

Enables BackToTop events on an element.

  • element The element to apply BackToTop to.
  • options optional
    • yThreshold optional Minimum scroll position in pixels before element appears.
    • animationInDuration optional Duration of fade-in animation in milliseconds.
    • animationOutDuration optional Duration of fade-out animation in milliseconds.
    • scrollBehavior optional Scrolling method to use. Possible values: auto, instant, smooth.
    • animationIn optional Fade-in animation name.
    • animationOut optional Fade-out animation name.

Note

When applyToElement() is first called, BackToTop injects it's own stylesheet inside <head> with ID backtotop-style. This is to provide the default fade-in and fade-out animations.

License

See LICENSE