Skip to content

A simple React sticky component that can stick to the top and the bottom at the same time

License

Notifications You must be signed in to change notification settings

doanhtu07/StickySideBar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

StickySideBar

A React sticky component that can stick to top when scrolling up and can stick to bottom when scrolling down.

Support

If you like the project, don't forget to give a star.

If you have any issues, post them on Github.

Github | https://github.com/doanhtu07/StickySideBar

Thank you!

Demo

Demo.mov

CodeSandbox Demo

https://codesandbox.io/s/test-sticky-n-scroll-qr1p3

Setup

npm install sticky-n-scroll

or

yarn add sticky-n-scroll

Use in React

import StickySideBar from "sticky-n-scroll"

...

class Demo extends React.Components {
  render() 
  {
    return (
      <StickySideBar topSpace={20} bottomSpace{20}>
        <div> 
          Your content 
        </div>
      </StickySideBar>
    )
  }

}
export default Demo;

Extra Power

Now you can freely manipulate StickySideBar with StickySideBar_ID: imported { StickySideBar_ID } from "sticky-n-scroll"

There are 3 main parts of StickySideBar: Parent, Space, Content. These 3 parts are all div with id equals to corresponding StickySideBar_ID values. You can either use jQuery or any DOM manipulations (such as ResizeObserver, etc.) to get to these elements by ids.

Important Note

In order for StickySideBar to be able to scroll, Parent should have larger height than Content.

Props of StickySideBar

Props Type Description
topSpace number (in pixels) Determine how much space between the content's top and screen's top when scrolling up.
bottomSpace number (in pixels) Determine how much space between the content's bottom and screen's bottom when scrolling down.
turnOff (optional) boolean Turn off sticky mode -> Become a normal div
initialSpaceDivHeight (optional) number Force initial height of space div when StickySideBar mounts

About

A simple React sticky component that can stick to the top and the bottom at the same time

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published