A lightweight and customizable button component that scrolls to the top of a page when pressed The button is only visible once a certain height has been reached on the page


Keywords
react, top, scroll, scroll-to-top, scroll up
License
MIT
Install
npm install react-scroll-to-top@3.0.0

Documentation

react-scroll-to-top

A lightweight and customizable button component that scrolls to the top of a page when pressed
The button is only visible once a certain height has been reached on the page

NPM

Live demo

A live demo can be found here

Installation

Run npm i react-scroll-to-top

Usage

Import and then include <ScrollToTop /> anywhere in your render/return function:

import ScrollToTop from "react-scroll-to-top";

function CoolPage() {
  return (
    <div>
      <ScrollToTop smooth />
      <h1>Hello, world!</h1>
    </div>
  );
}

Props

Prop Type Description Default
smooth boolean Whether to use smooth scrolling* false
top number Height after page scroll to be visible 20
color string The arrow (SVG fill) color black
style Object Object to add/override styling
className string Classname to completely override styling

Smooth scrolling uses a newer window.scrollTo implementation.
Check out its support in browsers at MDN web docs.

Types

Written in TypeScript, no need for @types installation