Skip to content

A simple, tiny, configurable jQuery smooth scrolling anchor link plugin. Developers are able to target specific links (using any jQuery selector), or just apply smooth scrolling to all anchor links in a page using one simple command.

License

MIT, MIT licenses found

Licenses found

MIT
LICENSE
MIT
license.md

jpederson/Creep.js

Repository files navigation

Creep.js

Quickly add smooth scrolling to any links in your site using this simple plugin.


Available on Github Available on NPM MIT


Getting Started

To get going quickly with Creep, just include the library after jQuery, select your link tags, and run creep on them. This would do it if you're starting fresh:

<script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<script src="jquery.creep.min.js"></script>
<script>
$(function(){
  $("a").creep();
});
</script>

After that, any link with a anchor associated with it (a # in the href) will smoothly scroll instead of jumping.


Install

Github

git clone https://github.com/jpederson/Creep.js creep

NPM

npm install jquery-creep

Yarn

yarn install jquery-creep

Plugin Options

This plugin needs only 2 options, as follows:

$("a").creep({
  offset: 0,
  speed: 1000
});

offset

Add an offset to change the distance above or below anchor destinations. Helpful when you have a fixed menu and you need to scroll a certain number of pixels above the anchor destination so that your menu doesn't cover the content.

speed

Adjust the scroll time. Set in milliseconds.


Contributing

To contribute, you'll need nodejs and Grunt installed. Fork and clone the repo, then visit the directory in the terminal and type npm install. After that you can simply run the grunt command to watch the files in the project. It'll automatically lint, test, compile, and minify the plugin files so you can just code.

Built with Grunt

About

A simple, tiny, configurable jQuery smooth scrolling anchor link plugin. Developers are able to target specific links (using any jQuery selector), or just apply smooth scrolling to all anchor links in a page using one simple command.

Topics

Resources

License

MIT, MIT licenses found

Licenses found

MIT
LICENSE
MIT
license.md

Stars

Watchers

Forks

Packages

No packages published