api documentation for react-scroll (v1.5.2)

A scroll component for React.js

table of contents

  1. module react-scroll
    1. function react-scroll.Button (props)
    2. function react-scroll.Element (props)
    3. function react-scroll.Link (props)
    4. object react-scroll.Events
    5. object react-scroll.Helpers
    6. object react-scroll.animateScroll
    7. object react-scroll.scrollSpy
    8. object react-scroll.scroller
  2. module react-scroll.Helpers
    1. function react-scroll.Helpers.Element (Component)
    2. function react-scroll.Helpers.Scroll (Component, customScroller)
  3. module react-scroll.animateScroll
    1. function react-scroll.animateScroll.animateTopScroll (y, options, to, target)
    2. function react-scroll.animateScroll.getAnimationType (options)
    3. function react-scroll.animateScroll.scrollMore (toY, options)
    4. function react-scroll.animateScroll.scrollTo (toY, options)
    5. function react-scroll.animateScroll.scrollToBottom (options)
    6. function react-scroll.animateScroll.scrollToTop (options)
  4. module react-scroll.scrollSpy
    1. function react-scroll.scrollSpy.addSpyHandler (handler, scrollSpyContainer)
    2. function react-scroll.scrollSpy.addStateHandler (handler)
    3. function react-scroll.scrollSpy.currentPositionY (scrollSpyContainer)
    4. function react-scroll.scrollSpy.isMounted (scrollSpyContainer)
    5. function react-scroll.scrollSpy.mount (scrollSpyContainer)
    6. function react-scroll.scrollSpy.scrollHandler (scrollSpyContainer)
    7. function react-scroll.scrollSpy.unmount (stateHandler, spyHandler)
    8. function react-scroll.scrollSpy.update ()
    9. function react-scroll.scrollSpy.updateStates ()
    10. object react-scroll.scrollSpy.scrollSpyContainers
    11. object react-scroll.scrollSpy.spyCallbacks
    12. object react-scroll.scrollSpy.spySetState
  5. module react-scroll.scroller
    1. function react-scroll.scroller.get (name)
    2. function react-scroll.scroller.getActiveLink ()
    3. function react-scroll.scroller.register (name, element)
    4. function react-scroll.scroller.scrollTo (to, props)
    5. function react-scroll.scroller.setActiveLink (link)
    6. function react-scroll.scroller.unmount ()
    7. function react-scroll.scroller.unregister (name)

module react-scroll

function react-scroll.Button (props)

function react-scroll.Element (props)

function react-scroll.Link (props)

module react-scroll.Helpers

function react-scroll.Helpers.Element (Component)

function react-scroll.Helpers.Scroll (Component, customScroller)

module react-scroll.animateScroll

function react-scroll.animateScroll.animateTopScroll (y, options, to, target)

function react-scroll.animateScroll.getAnimationType (options)

function react-scroll.animateScroll.scrollMore (toY, options)

function react-scroll.animateScroll.scrollTo (toY, options)

function react-scroll.animateScroll.scrollToBottom (options)

function react-scroll.animateScroll.scrollToTop (options)

module react-scroll.scrollSpy

function react-scroll.scrollSpy.addSpyHandler (handler, scrollSpyContainer)

function react-scroll.scrollSpy.addStateHandler (handler)

function react-scroll.scrollSpy.currentPositionY (scrollSpyContainer)

function react-scroll.scrollSpy.isMounted (scrollSpyContainer)

function react-scroll.scrollSpy.mount (scrollSpyContainer)

function react-scroll.scrollSpy.scrollHandler (scrollSpyContainer)

function react-scroll.scrollSpy.unmount (stateHandler, spyHandler)

function react-scroll.scrollSpy.update ()

function react-scroll.scrollSpy.updateStates ()

module react-scroll.scroller

function react-scroll.scroller.get (name)

function react-scroll.scroller.getActiveLink ()

function react-scroll.scroller.register (name, element)

function react-scroll.scroller.scrollTo (to, props)

function react-scroll.scroller.setActiveLink (link)

function react-scroll.scroller.unmount ()

function react-scroll.scroller.unregister (name)

[ this document was created with utility2 ]