README.md

Stacky.js

Create beautiful scrolling driven navigation lists with stacking headers that remain visible at all times.

Vanilla JS alternative to Slinky.js with no dependencies.

You can see demo here: https://matronator.github.io/stacky.js/

Getting Started

Instalation

NPM

Instal with

npm install stacky.js

and import into your project

import Stacky from "stacky.js"

Browser

Download files from the dist folder and include in your HTML file

<script src="path/to/stacky.min.js"></script>

Example

A minimal HTML structure for Stacky to work with can look something like this:

<main>
  <nav>
    <section>
      <header>First header</header>
      <p>Some content</p>
    </section>
    <section>
      <header>Second header</header>
      <ul>
        <li>First item</li>
        <li>Second item</li>
      </ul>
    </section>
    <!-- More sections here -->
  </nav>
</main>

Then you just initialize Stacky like this:

const stacky = new Stacky()
stacky.init()

Stacky.js looks for <header> tags by default, but you can change it to any CSS selector you want.

For example if you want to use Stacky on headings with some custom class like this one:

<h2 class="stack-me">Heading</h2>

You just have to specify the selector when declaring Stacky like so:

const stacky = new Stacky('h2.stack-me')
stacky.init()

Credits

Original jQuery plugin: Slinky.js