1.0.3 • Published 4 years ago

react-back-to-top v1.0.3

Weekly downloads
14
License
ISC
Repository
github
Last release
4 years ago

react-Back-To-Top

a customizable back-to-top component for react

Install

npm i react-back-to-top

or

yarn add react-back-to-top

Use

First import into the project:

import BackToTop from 'react-back-to-top';

Used is JSX:

<BackToTop
    mainStyle={{
        width:'100%',
        height:'100%',
        background:'url(...)'
    }}
    percentStyle={{
        width:'100%',
        height:'100%',
    }}
    animate='rotate'
    offsetTop={20}
    step={50}
    percent={true}
    visiblePercent={50}
  />

Custom animation

If you do not like the preset animation,you can customize the animation like this:

your css:

.c-animate-hide{
   transition: all 1s;
  -moz-transition: all 1s;
  -o-transition: all 1s;
  -webkit-transition: all 1s;
  transform: translateY(100%)
}
.c-animate-show{
   transition: all 1s;
  -moz-transition: all 1s;
  -o-transition: all 1s;
  -webkit-transition: all 1s;
  transform: translateY(0)
}

Under these two class names, you can use transitions or other transitional animations to achieve your favorite effects

API

ParameterExplainTypedefault
offsetTopBack to the position of a specified number of pixels from the topnumber0
stepThe distance each time you move. Used to control the speed of movement.The larger the value the fasternumber50
isPercentWhether to display the current content as a percentage of all content (excluding offsetTop)Booleantrue
visiblePercentLess than this percentage does not show percent.Valid when 'isPercent' is truenumber1
animateAnimation when 'Percent' showing or hiding'fade','rotate','none''fade'
mainStyleCustom component style,You can replace any picturestyle object{}
percentStyleCustom 'Percent'component stylestyle object{}