Русская версия README

jQuery Scroll-To-Top Plugin

What does the plugin?

• Display scroll button when scrolling down the page or specified scrolling height;
• Scroll up the page when you press button "Top^";
• Works on desktop and mobile site versions.

Dependencies

• jQuery - only jQuery library need for this plugin.

Bower installation

$> bower install jquery-scrolltotop --save

Происходит установка плагина. В текущем пакете есть зависимость jQuery. Если jQuery не были установлены через Bower, он установится вместе с плагином ScrollToTop.

How to include plugin

Include jQuery library and self plugin to your page:

// jQuery
<script src="http://code.jquery.com/jquery-2.1.4.min.js"></script>

// ScrollToTop Plugin
<script src="url-to-module/jquery-scrolltotop/dist/jquery.scrolltotop.min.js"></script>
// Plugin Styles
<link rel="stylesheet" href="url-to-module/jquery-scrolltotop/dist/jquery.scrolltotop.min.css">

##Описание параметров

$.scrolltotop({аргументы функции}); 

Тип входящих данных: JSON Варианты входящих данных:

Параметр	Описание	Значение по умолчанию
top_standoff	Минимальная высота в пикселях от верха страницы, при которой отображается кнопка прокрутки страницы.	700
speed	Скорость прокрутки в мс до верха страницы.	400
segment	Если параметр segment будет равен TRUE, то скорость прокрутки высчитывается из формулы (высота всей прокрутки экрана / значение top_standoff) * speed. Т.е. будет происходить плавная прокрутка всей страницы, вне зависимости от длинны прокрутки страницы с заданной скоростью speed для каждого интервала top_standoff на странице. Если параметр segment будет равен FALSE, то скорость прокрутки всей страницы будет равна скорости, заданной параметром speed, вне зависимости от высоты страницы	True
class	Задаем имя класса для кнопки прокрутки.	scroll1
object_id	Задаем ID кнопке прокрутки.	jquery-scrolltotop

##Примеры использования Для активации плагина достаточно запустить функцию

// Run plugin with default parameters
$.scrolltotop();

Запускаем плагин со своими настройками

// Run plugin with custom parameters
$.scrolltotop({top_standoff: 500, speed: 100, class: 'my_scroll_class'});

В этом случае запускаем плагин с измененными параметрами высоты и скорости прокрутки. А так же задаем для кнопки имя собственного класса.