use-overflow-scroll
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

UseOverflowScroll

use-overflow-scroll is a custom React hook designed to add draggable scroll functionality to any scrollable div element in your React application. This hook makes it easy to click and drag to scroll through content, mimicking the interaction style of touch interfaces.

Installation

You can install use-overflow-scroll using npm or yarn:

npm install use-overflow-scroll
yarn add use-overflow-scroll

Usage

To use use-overflow-scroll, import the hook and call it in your component. The hook takes a single argument, a ref to the scrollable element you want to add draggable scroll functionality to.

import useOverflowScroll from 'use-overflow-scroll';

const MyComponent = () => {
	const scrollRef = useOverflowScroll();

	return (
		<div ref={scrollRef} style={{ overflow: 'auto', height: '300px' }}>
			{/* Your scrollable content here */}
		</div>
	);
};

Props

use-overflow-scroll does not take any props.

Testing

To run the test suite for use-overflow-scroll, you can use the following command:

npm test

Contributing

If you would like to contribute to use-overflow-scroll, please open an issue or submit a pull request.

License

use-overflow-scroll is licensed under the MIT license.

Package Sidebar

Install

npm i use-overflow-scroll

Weekly Downloads

4

Version

1.0.1

License

MIT

Unpacked Size

9.01 kB

Total Files

12

Last publish

Collaborators

  • raymardev