Smooth-scroll-ak NPM

Smooth Scroll AK

A customizable smooth scrolling library for ReactJS applications. This package provides fluid, momentum-based scrolling with adjustable settings for momentum, touch, and speed.

Installation

Install the package using npm:

npm install smooth-scroll-ak

Or using yarn:

yarn add smooth-scroll-ak

Usage

Wrap your content with the SmoothScroll component to enable smooth scrolling:

import React from 'react';
import SmoothScroll from 'smooth-scroll-ak';

const App = () => {
  return (
    <SmoothScroll momentum={0.2} touchMomentum={0.1} speed={0.1}>
      <div style={{ height: '200vh' }}>
        <h1>Smooth Scrolling Example</h1>
        <p>Scroll down to see the smooth scrolling effect.</p>
      </div>
    </SmoothScroll>
  );
};

export default App;

Props

Prop	Type	Default	Description
`momentum`	number	`0.1`	Controls the momentum effect on mouse wheel scroll.
`touchMomentum`	number	`0.05`	Controls the momentum effect on touch scroll.
`speed`	number	`0.05`	Controls the speed of the smooth scrolling animation.

Features

Fluid, Momentum-based Scrolling: Smooth and natural scrolling experience.
Customizable Settings: Adjust momentum, touchMomentum, and speed to fit your needs.
Peer Dependency Support: Compatible with React 17 and 18.
Browser Compatibility: Works with all modern browsers.