tholman/elevator.js
Elevator.js
elevator.js is a lightweight JavaScript library that adds a playful, elevator-themed scroll-to-top button to a webpage. When clicked, it smoothly animates the page back to the top while playing a looping elevator music track in the background, masking the transition and adding a whimsical touch to the user experience.
The library goes beyond a simple scroll-to-top button by offering configurable scroll duration, the ability to scroll to any specified DOM element with optional vertical padding, and callback hooks that fire user-defined functions at the start and end of the animation. This allows developers to integrate custom side effects or trigger other page behaviors alongside the scroll action.
The project provides a smooth scroll animation with click event binding, making it easy to attach the scroll action to any user-selected element. It is distributed as a single JavaScript file that can be included in any web project.
Features
- Back-to-Top Links - Provides a configurable back-to-top button with smooth animation and optional elevator music.
- Animated Back-to-Top Buttons - Animates a smooth scroll to the top of the page while playing elevator music.
- Audio-Enhanced Back-to-Top Buttons - Plays elevator music during the scroll-to-top animation to mask the transition with a playful audio cue.
- Audio-Enhanced - Plays elevator music during a smooth scroll-to-top animation, masking the transition with a playful audio cue.
- Audio-Enhanced Scroll Experiences - Plays background music during a scroll animation to create a more engaging and thematic user interaction.
- Scroll Animation Audio Cues - Play a short audio clip during a scroll animation to add a playful auditory cue to the return-to-top action.
- Audio-Overlay - Animates page scrolling while playing a looping audio track to mask the transition.
- Smooth Scrolling - Implements a customizable smooth scroll animation to the top of a page or to a specific element.
- Animated Page-Top Scrolls - Animates the page smoothly upward when a user clicks a button, with optional elevator music.
- Element-Targeted Scrolling - Moves the viewport to any specified DOM element with optional vertical padding and smooth animation.
- Target Offset Configurators - Ships configurable vertical offset when scrolling to any specified DOM element for precise positioning.
- Scroll Lifecycle Callbacks - Provides callback hooks that fire at the start and end of scroll animations for custom integration.
- Smooth Scroll Libraries - Provides a smooth scroll animation library with configurable duration, custom targets, and callback hooks.
- Audio Playback - Plays a looping elevator music track in the background during scroll animation.
- Scroll Effects - Back-to-top button with elevator-style animation.
- 平滑滚动插件(Smooth Scroll) - Listed in the “平滑滚动插件(Smooth Scroll)” section of the Awesome Frontend awesome list.
