React Indiana Drag Scroll

Implements scroll on drag

Examples / Documentation / Sandbox

Welcome to journey!

Try it yourself! Go to demo website.

Install

🔥 You're currently looking at the branch for the alpha release. If you're looking for the stable branch, please check out master branch.

npm install --save react-indiana-drag-scroll@next

yarn add react-indiana-drag-scroll@next

Usage

You can use the ScrollContainer component:

import React, { Component } from 'react'
import { ScrollContainer } from 'react-indiana-drag-scroll';
import 'react-indiana-drag-scroll/dist/style.css'

export const Example = () => {
   return (
      <ScrollContainer>
         {/* scrollable content */}
      </ScrollContainer>
   )
};

Or, if you need to get more flexibility you can use useScrollContainer hook:

import { useScrollContainer } from 'react-indiana-drag-scroll';

export const Example = () => {
    const scrollContainer = useScrollContainer(options);
    return (
      <div ref={scrollContainer.ref}>
        {/* scrollable content */}
      </div>
    )
};

In this case you should provide the corresponding styles by yourself (for example, overflow: auto).

Props

Configuration

License

The source code is licensed under MIT, all images (except hieroglyphs) are copyrighted to their respective owner © Norserium