Плагин Parallax.js позволяет создать простой параллакс-эффект при прокрутке страницы.
Загрузка
Загрузить parallax.js можно по ссылке с github или подключив через пакетный менеджер:
npm:
npm i --save jquery-parallax.js
yarm:
yarn add jquery-parallax.js
bower (не рекомендуется):
bower i --save parallax.js
Использование
Необходим jQuery версии не ниже 1.7. Существует несколько способов добавления параллакса:
Использование data-атрибутов у html-тега:
Для создания простого параллакс эффекта элементу задается класс .parallax-window, а так же атрибуты data-parallax="scroll" (включает эффект параллакса при прокрутке страницы) и data-image-src="/path/to/image.jpg" (данный атрибут содержит путь к изображению, которое вы хотите использовать для эффекта).
Использование JavaScript:
Вручную выберите элемент с помощью jQuery и вызовите плагин.
$('.parallax-window').parallax({imageSrc: '/path/to/image.jpg'});
Параметры
Настройки плагина могут изменяться с использованием JavaScript. В том случае, если необходимо использовать для этого html-аттрибуты - используйте префикс data- перед названием параметра, а так же добавляйте дефис в качестве разделителя между словами. (Например, параметр imageSrc будет выглядеть, как data-image-src.
Параметр | Тип | По-умолчанию | Описание |
---|---|---|---|
imageSrc | путь | null | Путь к изображению, для которого будет применяться эффект. |
naturalWidth | number | auto | Вы можете указать реальные размеры изображения. Это может ускорить работу плагина и предотварить ошибки при автоматическом определении размеров выбранного изображения. |
naturalHeight | |||
position | xPos yPos | center center | Аналогично css-свойству background-position. Принимает координаты вида: top, bottom, right, left, center или в пикселях. Параллакс-изображение будет позиционироваться по заданным координатам до тех пор пока это возможно. |
positionX | xPos | center | |
positionY | xPos | center center | |
speed | float | 0.2 | Скорость с которой происходит параллакс-эффект. Значение 0.0 фиксирует изображение в пространстве, 1.0 - значение при котором изображение будет двигаться с такой же скоростью, что и контент страницы. |
zIndex | number | -100 | Положение относительно других элементов страницы. По-умолчанию, параллакс-элемент находится позади остальных элементов на странице. |
bleed | number | 0 | Вы можете опционально установить элемент-зеркало на несколько пикселей выше или ниже зеркальному элементу. Это поможет скрыть подтормаживания и прыгающий скролл в некоторых браузерах. |
iosFix | boolean | true | Устройства на iOS несовместимы с данным плагином. Если данный параметр включен и был обнаружен iOS user agent, параллакс-изображение будет центрировано и отображаться статично. |
androidFix | boolean | true | Если данный параметр включен и был обнаружен Android user agent параллакс-изображение будет центрировано и отображаться статично. Отключите данный параметр, если вы хотите отключить параллакс-прокрутку на устройствах с Android. |