Elevator.js Quarto Extension

Quarto Extension

Author

Mickaël CANOUIL, Ph.D.

This extension provides support and shortcode to Elevator.js.

Animation is only available for HTML-based documents.

Installation

quarto add mcanouil/quarto-elevator@1.5.0

This will install the extension under the _extensions subdirectory.

If you’re using version control, you will want to check in this directory.

Usage

To add an elevator button, use the {{< elevator >}} shortcode:

  • Mandatory:

    {{< elevator >}}

  • Optional <text-button>, <anchor-target>, and <audio=audio.mp3>:

    {{< elevator <text-button> <anchor-target> <audio=audio.mp3> >}}

  • Volume, loop, and keyboard shortcut:

    {{< elevator "Back" audio=music.mp3 volume=0.5 loop-audio=false shortcut="t" >}}

  • Built-in named sound (ding resolves to the bundled ding.mp3):

    {{< elevator "Back" end=ding >}}

  • Global disable via document metadata:

    ---
extensions:
  elevator:
    enabled: false
---

Elevator.js fixes those awkward “scroll to top” moments the old fashioned way.

▼
First we need to get to the bottom of the page.
▼
Because you’re already at the top.
▼
So a “back to top” button wouldn’t make sense.
▼
Down down down.
▼
## Wow, all this scrolling
▼
This had better be worth it.
▼
It’s going to take ages to get back to the top.
▼
If only we had an easy way to get back…
▼
…that is both functional and fun.
▼
I call “back to top” buttons elevators…
▼
…they should really behave more like them.
▼
Ok, here we are… click that elevator!

Or {{< elevator "Return to 'Wow, all this scrolling.'" wow-all-this-scrolling audio=BossaBossa.mp3 >}} to scroll up to ## Wow, all this scrolling.

Press t anywhere outside a form field to ride the elevator.

BossaBossa by Kevin MacLeod | https://incompetech.com/. Music promoted by https://www.chosic.com/free-music/all/. Creative Commons Creative Commons: By Attribution 3.0 License (http://creativecommons.org/licenses/by/3.0/).