1.1.0 • Published 5 years ago

scroll-animations v1.1.0

Weekly downloads
7
License
MIT
Repository
github
Last release
5 years ago

SCROLL ANIMATION FOR SMOOTH SCROLLBAR

JavaScript plugin that implement AOS and Relax animations on scrolling with Smooth Scrollbar

DEPENDENCIES

HOW USE

  1. Download or git clone
    git clone https://github.com/BiserStoilov/scroll-animations.git
  2. Install dependencies
    npm install
  3. Run demo
    npm run demo
  4. Build production with dependencies
    npm run build
  5. Run plugin

    <body data-aos-easing="ease-in-out" data-aos-duration="1000" data-aos-delay="100">
        <div id="scroll-animation-content">
            <div data-type-animation="aos" data-aos="fade-up"></div>
            <div data-type-animation="parallax"></div>
            <div data-type-animation="parallax" data-parallax-speed="10"></div>
        </div>
    </body>
    import scrollAnimations from 'path/to/scroll-animations/src/index'; 
    const sa = scrollAnimations({
        element: '#scroll-animation-content'
    });
  6. Public methods

    // Get Smooth Scrollbar instance
    const smoothScrollBar = sa.getScrollBar();
    // Destroy
    sa.destroy();
  7. Smoot ScrollBar Methods

    const sa = scrollAnimations({
        element: '#scroll-animation-content'
    });
    const smoothScrollBar = sa.getScrollBar();
    const element = document.querySelector('#your-element');
    smoothScrollBar.addListener(() => {
        console.log(smoothScrollBar.isVisible(element));
    }); 

NPM

npm i scroll-animations