README.md

Sticky element, smooth scroll and menu item highlighter

The plugin combains three specific components for single page front-end:

• sticky element after scroll
• smooth scroll
• menu item highlighter on scroll.

Every from these tasks are independent. They can be used separate from each other on the page, together or in combination in two. Here you can see what they actually do together. You can choose which of the features suits to you.

Demo

Link

Edit this demo on JSFiddle

Start the demo locally

1. Clone the repo [email protected]:nadezhda-devlabs/jquery-stoocky-page.git or download
2. Run npm install
3. Run gulp
4. Open index.html file in the browser and scroll
5. Smile =)

Basic Usage

1. HTML Structure

*This section is needed about smooth scroll and highlighter tasks. Otherwise you do not need to add the attributes and ids.

Add data attributes data-item to your menu items, with the name of the menu item. Example: data-item="about"

<nav>
    <ul class="main-menu">
        <li><a href="javascript:;" data-item="home">Home</a></li>
        <li><a href="javascript:;" data-item="about">About</a></li>
        <li><a href="javascript:;" data-item="team">Team</a></li>
        <li><a href="javascript:;" data-item="pricing">Pricing</a></li>
        <li><a href="javascript:;" data-item="gallery">Gallery</a></li>
        <li><a href="javascript:;" data-item="blog">Blog</a></li>
        <li><a href="javascript:;" data-item="contacts">Contacts</a></li>
    </ul>
</nav>

Add id to every section, which will be anchored.

<section id="about">
    <h1>About</h1>
    <p>Lorem ipsum dolor sit amet</p>
</section>

Now every menu item matches its section.

2. CSS - Include the stylesheet

*This section is needed about sticky element task. Otherwise you do not need to add the style.

Example of element with normal behaviour and its position after adding class to fix it.

.header {
    position: absolute;
}
.header.header--fixed {
    position: fixed;
    top: 0;
}

*This section is needed about smooth scroll and highlighter tasks. Otherwise you do not need to add the style.

It is only an example to difference the normal menu item and active menu item.

.main-menu > li > a {
    color: red;
}

.main-menu > li > a.active {
    color: blue;
}

3. Include jQuery

<script src="path-to-your-file/jquery.min.js"></script>

4. Include plugin

You can find it in assets/js/jquery.stoocky-page.js or assets/js/jquery.stoocky-page.min.js

<script src="path-to-your-file/jquery.stoocky-page.min.js"></script>

5. Initialize

At the end of your page you need to initialize it by running the following code. Note that all config values are optional and will default as specified below.

$('body').stoockyPage();

6. Default settings configuration

var settings = {
    stickyElem   : {
        active            : true,
        elToFix           : 'header',
        classToFix        : 'header--fixed'
    },
    scrollToElem    : {
        active            : true,
        item              : '.main-menu > li > a',
        animDuration      : 1000,
    },
    itemHighlighter : {
        active            : true,
        item              : '.main-menu > li > a',
        lastItem          : '.main-menu > li:last-child > a',
        classToHighlight  : 'active'
    }
};

7.Options

Attribute	Type	Default Value	Description
stickyElem:
- active	boolean	true	Activate function stickyElem.
- elToFix	string	header	Show which element to be fixed.
- classToFix	string	header--fixed	The class, which is added to the element to make it fixed.
scrollToElem:
- active	boolean	true	Activate function scrollToElem.
- item	string	.main-menu > li > a	Menu item selector
- animDuration	number	1000	A string or number determining how long the animation will run.
itemHighlighter:
- active	boolean	true	Activate function itemHighlighter.
- item	string	.main-menu > li > a	Menu item selector.
- lastItem	string	.main-menu > li:last-child > a	Last menu item.
- classToHighlight	string	active	Highlight class to be added to the active item.

If you want to change some of the default values you need to add it to the initilisation, like this:

$('body').stoockyPage({
    stickyElem   : {
        active            : true,
        elToFix           : 'header',
        classToFix        : 'header--fixed'
    },
    scrollToElem    : {
        active            : true,
        item              : '.top-menu > li > a',
        animDuration      : 2000,
    },
    itemHighlighter : {
        active            : false
    }
});

Contributing

Open an issue to suggest changes or additions. PRs are welcome.

Thank you! :)