use-smooth-scroll-to

React hook for smooth scrolling

![License](https://www.npmjs.com/package/use-smooth-scroll-to)
![NPM Version](https://www.npmjs.com/package/use-smooth-scroll-to)
![Known Vulnerabilities](https://snyk.io/test/github/marshallku/use-smooth-scroll-to)
![NPM Downloads](https://www.npmjs.com/package/use-smooth-scroll-to)

Install

``bash

`npm`


npm i use-smooth-scroll-to
yarn

yarn add use-smooth-scroll-to
pnpm

pnpm i use-smooth-scroll-to


Usage

`tsx import { useRef } from "react"; import { useScroll } from "use-smooth-scroll-to";

function App() { const { scroll } = useScroll({ easing: "easeInCirc" }); const divRef = useRef(null);

return (


                            onClick={() => {
                    scroll(divRef.current);
                }}
            >
                Go to hello world
            
            
            HELLO WORLD

                            onClick={() => {
                    scroll(0);
                }}
            >
                Go to top
            
        

    );
}

export default App;`

`Props`

| Property | Type | required | Description | | --------------- | --------------------------------- | -------- | ---------------------------------------------------------------- | | useNativeScroll | boolean | false | Usewindow.scrollTo` for scrolling |
| easing | ((x: number) => number) \| string | false | Your own easing function or name of implemented easing functions |

$3

- linear
- easeInSine
- easeInCubic
- easeInQuint
- easeInCirc
- easeOutSine
- easeOutCubic
- easeOutQuint
- easeOutCirc
- easeInOutSine
- easeInOutCubic
- easeInOutQuint
- easeInOutCirc