Need private packages and team management tools?Check out npm Teams »

react-scroll-to-top-effect

1.0.10 • Public • Published

react-scroll-to-top-effect Logo

A React effect hook that scrolls to the top of the page on first render. Great for router components!

react hook npm version

useScrollToTopEffect();

Installation

npm i react-scroll-to-top-effect

Usage

Just call useScrollToTopEffect() at the top of your functional component, like so:

import * as React from "react";
import useScrollToTopEffect from "react-scroll-to-top-effect";
 
export default function MyPage(props) {
  useScrollToTopEffect();
  return (
    <div>
      This page component automatically scrolls to the top on first render!
    </div>
  );
}

Attributions

Logo Font

Hind	SIL Open Font License, 1.1
Hind-Regular.ttf: Copyright (c) 2014 Indian Type Foundry (info@indiantypefoundry.com)

MIT License

This project is covered under the MIT License.

Copyright © 2019 Justin Mahar

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Install

npm i react-scroll-to-top-effect

DownloadsWeekly Downloads

1

Version

1.0.10

License

MIT

Unpacked Size

10.6 kB

Total Files

5

Last publish

Collaborators

  • avatar