Skip to content

Library for creating jelly scrolling effect

Notifications You must be signed in to change notification settings

afdallah/jellyscroll

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cuberto JellyScroll

Frontend dependencies

Smooth Scrollbar (https://github.com/idiotWu/smooth-scrollbar)

GSAP v3 (https://greensock.com/gsap/)

Intersection Observer Polyfill, if you want support IE11 (https://www.npmjs.com/package/intersection-observer)

Usage

import JellyEffect from 'jelly';

// Basic usage
const jelly = new JellyEffect();

// Options with defaults
const jelly = new JellyEffect({
    intensity: 0.15, // delta multiplier, set negative to invert
    speed: 0.6, // duration of animation
    min: -5, // minimum deformation value
    max: 5, // maximum deformation value
    scrollPos: () => window.pageYOffset // function that return current scroll position
});

// Programmatically init for each element
import {Jelly} from 'jelly';

const jelly = new Jelly(element, options);

Setup demo project

npm install or yarn install

Start demo project

gulp or gulp serve deploy app and start browsersync server + watchers

File structure

├── /tmp/                       # Temporary served files
└── /src/                       # The source code of the application
    ├── /js/                    # JavaScript source
    ├── /pug/                   # Pug templates
        └── /_includes/         # Pug partials
    ├── /scss/                  # SCSS styles
    ├── /static/                # Static files (fonts, images, videos, etc..)

About

Library for creating jelly scrolling effect

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 40.5%
  • Pug 30.0%
  • SCSS 29.5%