Skip to content

souporserious/use-scroll-sync

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

useScrollSync

Sync scroll positions between multiple elements.

Note, if the main thread is too busy or the user's battery is low, scrollbars can get out of sync.

Install

yarn add use-scroll-sync
npm install use-scroll-sync

Example

import * as React from 'react'
import { useScrollSync } from 'use-scroll-sync'

function SyncedScrollbars() {
  const headerRef = React.useRef()
  const mainRef = React.useRef()
  useScrollSync(headerRef, mainRef)
  return (
    <div>
      <header ref={headerRef}>...</header>
      <main ref={mainRef}>...</main>
    </div>
  )
}

About

Sync scroll positions between multiple elements.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published