Данный плагин разработан для организации блока, который "приклеился" к верху экрана в независимости от позиции прокрутки страницы, но при этом не перемещается за границы родительского контейнера.

Например, сайдбар справа демонстрирует такой блок, организованный с помощью описываемого плагина. При прокрутке страницы вниз, чтобы прочитать о доступных опциях плагина, можно заметить, что сайдбар постоянно остается сверху экрана до тех пор, пока не прокрутится полностью родительский контейнер.

Однако некоторым пользователям не нравится такое поведение сайдбара, поэтому у плагина также есть опция, которая позволяет отключать пользователю "прилипание" к верху экрана, что приводит к возвращению сайдбара на его позицию по умолчанию. Нужно всего лишь нажать на символ циркумфлекс (^) для включения данной опции.

Чтобы инициализировать плагин, нужно использовать обычную синтаксическую конструкцию:

jQuery('.sidebar').containedStickyScroll();
		

А если используются какие-то особенные установки опций плагина:

jQuery('.sidebar').containedStickyScroll({
        duration: 300,
        unstick: true,
        closeChar: 'x' 
    });

Плагин имеет следующие опции:

easing Строка - Позволяет устанавливать тип перехода при анимации. Значение по умолчанию: linear.
duration Целое число - Позволяет устанавливать длительность анимации. Значение по умолчанию: 500
queue Логическое значение - Позволяет определять возможность размещения анимации в очереди. Если установлено значение false, анимация начинается немедленно. Значение по умолчанию: false
unstick Логическое значение - Отключает/Включает подвижность блока. Значение по умолчанию: true (включено)
closeChar Строка - Определяет набор символов, который используется в качестве надписи для отключения подвижности блока. Значение по умолчанию: ^
closeTop Целое число - Определяет смещение по вертикали надписи для отключения подвижности относительно верха блока, в пикселях. Значение по умолчанию: 0
closeRight Целое число - Определяет смещение по горизонтали надписи для отключения подвижности относительно верха блока, в пикселях. Значение по умолчанию: 0