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

use-drag-scroll

v1.0.1

Published

Adds horizontal drag scrolling with momentum

Downloads

8,729

Readme

useDragScroll

Adds horizontal drag scrolling with momentum

1kb minified + gzipped, no dependencies

Usage

yarn add use-drag-scroll or npm i use-drag-scroll

Basic

! The wrapping element must have overflow-x: scroll and white-space: nowrap.

Simple JSX setup:

  import React, {useRef} from 'react'
  import useDragScroll from 'use-drag-scroll'

  const Component = () => {
    const ref = useRef(null)

    useDragScroll({
      sliderRef: ref
    })

    return (
      <div className='items' ref={ref}>
        <div className='item'></div>
        <div className='item'></div>
        <div className='item'></div>
      </div>
    )
  }

Dynamic children

If the components within .items can change or be dynamically added/removed, pass reliants to useDragScroll like you would useEffect:

  import React, {useRef, useState} from 'react'
  import useDragScroll from 'use-drag-scroll'

  const Component = () => {
    const ref = useRef(null)
    const [myFilter, setMyFilter] = useState('DESC')

    useDragScroll({
      sliderRef: ref,
      reliants: [myFilter]
    })

    return (
      <div className='items' ref={ref}>
        <div className='item'></div>
        <div className='item'></div>
        <div className='item'></div>
      </div>
    )
  }

Momentum velocity

You can also alter the momentum velocity (recommended between 0.8-1.0, default 0.9):

  import React, {useRef, useState} from 'react'
  import useDragScroll from 'use-drag-scroll'

  const Component = () => {
    const ref = useRef(null)
    const [myFilter, setMyFilter] = useState('DESC')

    useDragScroll({
      sliderRef: ref,
      reliants: [myFilter],
      momentumVelocity: 0.8 
    })

    return (
      <div className='items' ref={ref}>
        <div className='item'></div>
        <div className='item'></div>
        <div className='item'></div>
      </div>
    )
  }

Arguments & Return values

Args

useDragScroll({
  sliderRef: ReactRef, // Wrapper/container ref (REQUIRED)
  reliants: [...], // Array
  momentumVelocity: Number
})

Returns

useDragScroll returns hasSwiped only. This tells you if the user has moved the mouse more than 3px horizontally. It's handy for when your items are links. You can tell links to preventDefault if the user has scrolled previously.

const { hasSwiped } = useDragScroll({
  sliderRef: ReactRef
})

return (
  <div className='items' ref={ref}>
    <a className='item' href='...' onClick={(e) => {
      if (hasSwiped) {
        e.preventDefault()
      }
    }}></a>
  </div>
)

Adapted from @toddwebdev's codepen here: https://codepen.io/loxks/pen/KKpVvVW