gregle / elevator.js

Finally, a "back to top" button that behaves like a real elevator.

Home Page:http://tholman.com/elevator.js

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

elevator.js Chrome Extension -- Gregle

Now you can ride the elevator where ever you are. With the touch of a button you can ride to the top of the page in style every time. Though it has a hard time on web pages that designed around using the browser's scroll bar.

Original elevator.js credit to Tim Holman ~ timothy.w.holman@gmail.com

Icon made by Freepik from www.flaticon.com is licensed by CC BY 3.0

Original elevator.js

Finally, a "back to top" button that behaves like a real elevator, by adding elevator music to quietly soothe the awkwardness that can ensue when being smoothly scrolled to the top of the screen.

This is very serious stuff, here's a demo!

Instructions

Elevator.js is a stand alone library (no jquery, or the likes) so usage is pretty straight forward. All styling of elements is up to you. Elevator.js only handles the audio management, and the scroll functionality!

JS

Elevator.js lives entirely within the js realm, which makes things fairly simple to use.

You'll need to create a new instance of Elevator, and pass it some audio elements.

<script>
// Elevator script included on the page, already.

window.onload = function() {
  var elevator = new Elevator({
    mainAudio: '/src/to/audio.mp3',
    endAudio: '/src/to/end-audio.mp3'
  });
}

// You can run the elevator, by calling.
elevator.elevate();
</script>

You can also add an "element" option, clicking this element will invoke the "Scroll to top" functionality, we all love and crave.

<div class="elevator-button">Back to Top</div>

<script>
// Elevator script included on the page, already.

window.onload = function() {
  var elevator = new Elevator({
    element: document.querySelector('.elevator-button'),
    mainAudio: '/src/to/audio.mp3',
    endAudio: '/src/to/end-audio.mp3'
  });
}
</script>

If you're really serious (boring), you don't have to use audio... and can also set a fixed time to scroll to the top

<div class="elevator-button">Back to Top</div>

<script>
// Elevator script included on the page, already.

window.onload = function() {
  var elevator = new Elevator({
    element: document.querySelector('.elevator-button'),
    duration: 1000 // milliseconds
  });
}
</script>

License

Elevator.js is covered by the MIT License.

Audio in the Demo (sourced from BenSound) is licenced under Creative Commons.

Copyright (C) 2015 ~ Tim Holman ~ timothy.w.holman@gmail.com

About

Finally, a "back to top" button that behaves like a real elevator.

http://tholman.com/elevator.js


Languages

Language:JavaScript 100.0%