Skip to content

jQuery plugin, which implements pretty page scrolling to HTML anchor on same page or anchor is placed on different page

Notifications You must be signed in to change notification settings

alexxxxey/prettyscroll

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 

Repository files navigation

prettyScroll (Demo page)

jquery.prettyScroll.js is a jQuery plugin, which implements pretty page scrolling to HTML anchor (<a name="..."></a>).

  • Plugin supports both smooth page scrolling, when anchor are placed in the same page or anchor is placed on different page (raise page refresh).
  • Plugin can be inserted on page without any source code modifications, like adding special classnames to tags, etc.
  • Plugin doesn't modify HTML code, doesn't delete link hashes.

Usage

  1. Include into page jQuery and prettyScroll files like this:
<script type="text/javascript" src="js/jquery.js"></script>`
<script type="text/javascript" src="js/jquery.prettyScroll.js"></script>
  1. Simply call prettyScroll function, for example:
    $(function() {
        $.prettyScroll();
    });
  1. If all are right, now your standart anchor jumps will be animated by scrolling.

Parameters:

By default:

$.prettyScroll({
        speed: '2000',
        exclude: {},
        adaptive: true,
        animation: 'swing'
});
  • speed - animation speed;
  • exclude - basically, plugin works on all links with anchors in page. If you need stay some links standart anchor behavior you can do this by pass parametrs to exclude option:
$.prettyScroll({
    exclude: 'a.no_scroll'
});

or

$.prettyScroll({
    exclude: $('a.no_scroll, a.no_class')
});
  • adaptive - if adaptive true, animation speed calculates by speed = <pixels_to_object> / 4000 * speed;
  • animation - animation type. Supports swing / linear;

About

jQuery plugin, which implements pretty page scrolling to HTML anchor on same page or anchor is placed on different page

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published