Skip to content
Branch: master
Find file History
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
README.md - Documentation: updating sponsors Nov 29, 2018
how-to-activate-fullpage-extension.md - Updating localised docs Jun 21, 2018
parallax-extension.md - Updating localised docs Jun 21, 2018

README.md

fullPage.js

предварительный просмотр совместимость

English | Español | Pусский | 中文 | 한국어

Available for Vue, React and Angular.


Версия fullPage.js Лицензия Перечисление на PayPal jsDelivr Hits    |   7Кб в формате gzip   |   Создано @imac2


Простая и удобная в использовании библиотека для создания веб-сайтов с полноэкранной прокруткой (также известных, как одностраничные сайты). Она позволяет создавать веб-сайты с полноэкранной прокруткой, а также добавлять горизонтальные ползунки для разделов сайта.

Введение

Более чем приветствуются ваши предложения, касающиеся не только функций и возможностей, но и улучшения стиля кодирования. Давайте вместе создадим замечательную библиотеку, чтобы облегчить жизнь пользователям!

Совместимость

fullPage.js полностью функционирует во всех современных браузерах, также, как и в некоторых устаревших, таких как Internet Explorer 9, Opera 12 и т.д. Работает в браузерах, имеющих и не имеющих поддержку CSS3, что обеспечивает идеальную совместимость с устаревшими браузерами. Обеспечивает поддержку сенсорного управления для мобильных телефонов, планшетов и компьютеров с сенсорным экраном.

Выражаем особую благодарность Browserstack за поддержку fullpage.js.

Лицензия

Коммерческая лицензия

Если вы хотите использовать fullPage для разработки коммерческих сайтов, тем, проектов и приложений, то вам подойдёт коммерческая лицензия. С такой опцией ваш исходный код будет закрытым. Это значит, что вам не придётся менять весь исходный код вашего приложения на лицензию с открытым исходным кодом. [Приобретите Коммерческую лицензию Fullpage здесь]

Лицензия с открытым исходным кодом

Если вы создаёте приложение с открытым исходным кодом по лицензии, совместимой с Лицензией GNU GPL v3, вы можете использовать fullPage на условиях GPLv3.

Сведения об авторе в JavaScript и файлах CSS должны оставаться без изменений (даже после комбинации или минификации)

Прочесть больше о лицензии fullPage.

Использование

Как вы можете увидеть в файлах-примерах, вам необходимо будет включить:

  • Файл JavaScript fullpage.js (или его минифицированную версию fullpage.min.js)
  • Файл css fullpage.css

Опционально, при использовании css3:false вы можете добавить библиотеку jQuery UI, в случае если вы хотите использовать другие анимационные эффекты, в дополнение к включённым в библиотеку (easeInOutCubic ).

Установка bower или npm

Опционально, вы можете установить fullPage.js с bower или npm согласно вашим предпочтениям:

Введите:

// С bower
bower install fullpage.js

// С npm
npm install fullpage.js

Включение файлов:

<link rel="stylesheet" type="text/css" href="fullpage.css" />


<!-- Следующая строчка опциональна. Необходима лишь в случае, если вы используете опцию css3:false и хотите использовать другие анимационные эффекты, кроме "linear", "swing" или "easeInOutCubic". -->
<script src="vendors/easings.min.js"></script>

<!-- Следующая строчка опциональна, необходима лишь в случае, если вы хотите использовать опцию `scrollOverflow:true` -->
<script type="text/javascript" src="vendors/scrolloverflow.min.js"></script>

<script type="text/javascript" src="fullpage.js"></script>

Using Webpack, Browserify or Require.js? Check how to use fullPage.js with module loaders.

Опциональное использование CDN

Если вы предпочитаете использовать CDN для загрузки необходимых файлов, fullPage.js есть в CDNJS: https://cdnjs.com/libraries/fullPage.js

Требуемая HTML-структура

Начиная свой документ HTML, обязательно введите HTML DOCTYPE declaration в первой строке вашего HTML-кода. Иначе у вас могут возникнуть проблемы с вертикальным размером разделов. В приведённых примерах используется тип документа HTML 5 <!DOCTYPE html>.

Каждый раздел будет определён элементом, содержащим класс section. Активный раздел по умолчанию будет являться первым разделом, то есть домашней страницей.

Разделы должны помещаться в обёрточный код (в данном случае - <div id="fullpage">). Обёрточный код не может быть элементом body.

<div id="full page">
	<div class="section">Определённый раздел</div>
	<div class="section">Определённый раздел</div>
	<div class="section">Определённый раздел</div>
	<div class="section">Определённый раздел</div>
</div>

Если вы хотите определить другую точку входа (не первый раздел или первый слайд раздела), просто добавьте класс active к разделу и слайду, которые вы хотите загружать в первую очередь.

<div class="section active">Определённый раздел</div>

Чтобы создать горизонтальный ползунок в разделе, каждый слайд должен определяться по умолчанию с помощью элемента, содержащего класс slide:

<div class="section">
	<div class="slide"> Слайд 1 </div>
	<div class="slide"> Слайд 2 </div>
	<div class="slide"> Слайд 3 </div>
	<div class="slide"> Слайд 4 </div>
</div>

Вы можете посмотреть на полностью работоспособный пример HTML-структуры здесь: файл simple.html.

Инициализация

Инициализация с Vanilla Javascript

Всё, что вам нужно сделать, - это указать fullPage.js перед закрывающим тегом </body>.

new fullpage('#fullpage', {
	//options here
	autoScrolling:true,
	scrollHorizontally: true
});

//methods
fullpage_api.setAllowScrolling(false);

Инициализация с jQuery

Если хотите, можете также использовать fullpage.js в качестве плагина jQuery!

$(document).ready(function() {
	$('#fullpage').fullpage({
		//options here
		autoScrolling:true,
		scrollHorizontally: true
	});

	//methods
	$.fn.fullpage.setAllowScrolling(false);
});

Функции и методы можно делать так же, как и с jQuery, как в fullPage.js v2.X.

Пример Vanilla JS со всеми опциями

Более сложная инициализация с установкой всех параметров может выглядеть так:

var myFullpage = new fullpage('#fullpage', {
	//Навигация
	menu: '#menu',
	lockAnchors: false,
	anchors:['firstPage', 'secondPage'],
	navigation: false,
	navigationPosition: 'right',
	navigationTooltips: ['firstSlide', 'secondSlide'],
	showActiveTooltip: false,
	slidesNavigation: false,
	slidesNavPosition: 'bottom',

	//Скроллинг
	css3: true,
	scrollingSpeed: 700,
	autoScrolling: true,
	fitToSection: true,
	fitToSectionDelay: 1000,
	scrollBar: false,
	easing: 'easeInOutCubic',
	easingcss3: 'ease',
	loopBottom: false,
	loopTop: false,
	loopHorizontal: true,
	continuousVertical: false,
	continuousHorizontal: false,
	scrollHorizontally: false,
	interlockedSlides: false,
	dragAndMove: false,
	offsetSections: false,
	resetSliders: false,
	fadingEffect: false,
	normalScrollElements: '#element1, .element2',
	scrollOverflow: false,
	scrollOverflowReset: false,
	scrollOverflowOptions: null,
	touchSensitivity: 15,
	normalScrollElementTouchThreshold: 5,
	bigSectionsDestination: null,

	//Доступ
	keyboardScrolling: true,
	animateAnchor: true,
	recordHistory: true,

	//Дизайн
	controlArrows: true,
	verticalCentered: true,
	sectionsColor : ['#ccc', '#fff'],
	paddingTop: '3em',
	paddingBottom: '10px',
	fixedElements: '#header, .footer',
	responsiveWidth: 0,
	responsiveHeight: 0,
	responsiveSlides: false,
	parallax: false,
	parallaxOptions: {type: 'reveal', percentage: 62, property: 'translate'},

	//Настроить селекторы
	sectionSelector: '.section',
	slideSelector: '.slide',

	lazyLoading: true,

	//события
	onLeave: function(origin, destination, direction){},
	afterLoad: function(origin, destination, direction){},
	afterRender: function(){},
	afterResize: function(width, height){},
	afterResponsive: function(isResponsive){},
	afterSlideLoad: function(section, origin, destination, direction){},
	onSlideLeave: function(section, origin, destination, direction){}
});

Создание ссылок на разделы или слайды

Если вы используете fullPage.js с ссылками привязки для разделов (пользуясь опцией anchors или атрибутом data-anchor в каждом разделе), то вы сможете использовать ссылки привязки также для перемещения напрямую к определённому слайду в разделе.

Вот пример ссылки с привязкой: http://alvarotrigo.com/fullPage/#secondPage/2 (это URL, который вы увидите при доступе к данному разделу/слайду вручную) Обратите внимание на то, что последняя часть URL заканчивается элементом #secondPage/2.

При следующей инициализации:

new fullpage('#fullpage', {
	anchors:['firstPage', 'secondPage', 'thirdPage']
});

Привязка #secondPage/2 в конце URL определяет заданный раздел и слайд соответственно. В предыдущем URL заданным разделом будет являться раздел, определённый привязкой secondPage, а заданным слайдом будет второй слайд, так как для этого мы и использовали индекс 2. (первый слайд в разделе имеет индекс 0, так как технически это раздел).

Мы могли бы использовать свою привязку для слайда, а не его индекс, если бы мы использовали атрибут data-anchor в HTML-разметке следующим образом:

<div class="section">
	<div class="slide" data-anchor="slide1"> Слайд 1 </div>
	<div class="slide" data-anchor="slide2"> Слайд 2 </div>
	<div class="slide" data-anchor="slide3"> Слайд 3 </div>
	<div class="slide" data-anchor="slide4"> Слайд 4 </div>
</div>

В данном случае мы бы использовали URL #secondPage/slide3, являющийся эквивалентным предыдущему - #secondPage/2.

Обратите внимание, что привязки к разделам могут создаваться точно также, с помощью атрибута data-anchor, если не предусмотрен ряд каких-либо привязок - anchors.

Внимание! обозначения data-anchor не могут иметь значение, совпадающее с каким-либо элементом ID на сайте (или элементом NAME - для IE).

Создание больших и малых разделов

Демо fullPage.js обеспечивает возможность убрать ограничение по высоте разделов и слайдов. Есть возможность создавать разделы, высота которых больше или меньше окна просмотра. Эта функция идеальна при использовании колонтитулов. Важно понимать, что нет смысла в применении данной функции ко всем вашим разделам. При наличии более чем одного раздела при первоначальной загрузке сайта fullPage.js не сможет сделать прокрутку, чтобы увидеть следующий раздел, так как он уже и так будет находиться в окне просмотра.

Для создания меньших разделов просто используйте класс fp-auto-height в разделе, к которому хотите применить эту функцию. Тогда высота будет определяться контентом вашего раздела/слайда.

<div class="section">Полное окно просмотра</div>
<div class="section fp-auto-height">Автовысота</div>

Разделы с подстройкой автовысоты

Демо Подстройка автовысоты может быть применена с помощью класса fp-auto-height-responsive. В таком случае разделы будут отображаться в полную высоту, пока не будет активирован режим подстройки.

Классы состояний, добавляемые fullpage.js

Fullpage.js добавляет различные классы к разным элементам, чтобы отслеживать статус сайта:

  • active добавляется к текущему отображаемому разделу и слайду.
  • active добавляется к текущему элементу меню (если используется опция menu).
  • Класс вида fp-viewing-SECTION-SLIDE добавляется к элементу body. (например: fp-viewing-secondPage-0) Части SECTION и SLIDE будут являться привязками (или индексами, если привязки не предусмотрены) к текущему разделу и слайду.
  • fp-responsive добавляется к элементу body при входе в режим подстройки
  • fp-enabled добавляется к элементу html, когда fullpage.js активирован. (и удаляется при деактивации).
  • fp-destroyed добавляется к хранилищу fullpage.js при деактивации fullPage.js.

Отложенная загрузка

Демо fullPage.js обеспечивает возможность отложенной загрузки изображений, видео- и аудиоэлементов, чтобы они не замедляли загрузку вашего сайта и не тратили без необходимости трафик при передаче данных. При использовании отложенной загрузки все эти элементы будут загружаться только при открытии в окне конструирования. Всё, что вам нужно сделать для активации отложенной загрузки, - это изменить ваш атрибут src на data-src, как показано ниже:

<img data-src="image.png">
<video>
	<source data-src="video.webm" type="video/webm" />
	<source data-src="video.mp4" type="video/mp4" />
</video>

Если вы уже применяете другой способ для отложенной загрузки, который также использует data-src, вы можете отключить отложенную загрузку fullPage.js, установив опцию lazyLoading: false.

Автопроигрывание/приостановка встроенного медиа

Примечание: функция автопроигрывания может не работать на некоторых мобильных устройствах, в зависимости от их ОС и браузера (то есть, в Safari в iOS, в версиях до 10.0).

Проигрывание при загрузке раздела/слайда:

При использовании атрибута autoplay для видео или аудио, или параметра autoplay=1 для встроенных фреймов youtube, медиа будет проигрываться при загрузке страницы. Для проигрывания медиа при загрузке раздела/слайда, используйте data-autoplay. Например:

<audio data-autoplay>
	<source src="http://metakoncept.hr/horse.ogg" type="audio/ogg">
</audio>

Приостановка при покидании страницы

Встроенные фреймы HTML5 <video> / <audio> и Youtube автоматически останавливаются, когда вы покидаете раздел или слайд. Это можно отключить с помощью атрибута data-keepplaying. Например:

<audio data-keepplaying>
	<source src="http://metakoncept.hr/horse.ogg" type="audio/ogg">
</audio>

Использование расширений

fullpage.js предоставляет ряд расширений, которые вы можете использовать для улучшения его функций, предусмотренных по умолчанию. Все они представлены как опции fullpage.js.

Для расширений вам требуется использовать минифицированный файл fullpage.extensions.min.js, находящийся в папке dist, а не обычный файл fullPage.js (fullpage.js или fullpage.min.js).

После приобретения файла расширения вам нужно будет добавить его перед fullPage. Например, если я хочу использовать расширение Continuos Horizontal, мне нужно будет включить файл расширения, а затем – версию файла fullPage для расширений.

<script type="text/javascript" src="fullpage.continuousHorizontal.min.js"></script>
<script type="text/javascript" src="fullpage/fullpage.extensions.min.js"></script>

Ключ активации и ключ лицензии потребуются для каждого расширения. Узнайте более подробно об этом здесь.

Затем вы сможете использовать и настраивать их, как разъясняется в разделе опции.

Опции

  • licenseKey: (по умолчанию null). Эта опция является обязательной. Если вы используете fullPage для проекта с закрытым исходным кодом, то вам следует воспользоваться лицензионным ключом, предоставляемым при приобретении коммерческой лицензии fullPage.если ваш проект открыт с открытым исходным кодом, свяжитесь со мной, чтобы получить лицензионный ключ.. Вы можете прочесть подробнее о лицензиях здесь и на веб-сайте. Пример:
new fullpage({
    licenseKey: 'YOUR_KEY_HERE'
});
  • v2compatible: (значение по умолчанию: false). Определяет 100% совместимость с любым кодом, написанным для версии 2, игнорируя новые функции или изменения API версии 3. Классы состояний, сигнатуры обратных вызовов и т.п. будут работать так же, как в версии 2. Обращаем ваше внимание на то, что данная опция в будущем будет удалена..

  • controlArrows: (по умолчанию true) Определяет использование клавиш-стрелок для передвижения вправо или влево при просмотре слайдов.

  • verticalCentered: (по умолчанию true) Вертикальное центрирование контента в разделах. При установке данного расширения - true, ваш контент будет обёрнут библиотекой. Рассмотрите возможность делегирования или загрузите ваши скрипты для обратного вызова afterRender.

  • scrollingSpeed: (по умолчанию 700) Ускорьте на миллисекунды переходы при скроллинге.

  • sectionsColor: (по умолчанию none) Присвойте CSS-свойство background-color каждому разделу. Пример:

new fullpage('#fullpage', {
	sectionsColor: ['#f2f2f2', '#4BBFC3', '#7BAABE', 'whitesmoke', '#000'],
});
  • anchors: (по умолчанию []) Обеспечивает размещение ссылок с привязками (#пример) в URL для каждого раздела. Значения привязок должны быть уникальными. Положение привязок в ряду будет определять то, к какому разделу применяется привязка. (вторая позиция для второго раздела и так далее). Использование привязок также даёт возможность навигации вперёд и назад в браузере. Эта опция также даёт пользователям возможность добавлять в закладки определённый раздел или слайд. Внимание! привязки не могут иметь значение, совпадающее с каким-либо элементом ID на сайте (или элементом NAME - для IE). Теперь привязки могут добавляться прямо в HTML-структуре с помощью атрибута data-anchor, как объясняется здесь.

  • lockAnchors: (по умолчанию false) Определяет, будут ли вообще действовать в библиотеке привязки в URL. Вы по-прежнему сможете использовать привязки в закрытом формате для ваших собственных функций и обратных вызовов, но в скроллинге сайта они участвовать не будут. Это полезная функция, если вы хотите совместить fullPage.js с другими плагинами, использующими привязки в URL.

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

  • easing: (по умолчанию easeInOutCubic) Определяет эффект перехода, используемый при вертикальном и горизонтальном скроллинге. Необходим файл vendors/easings.min.js или jQuery UI для использования некоторых из переходов. Могут использоваться другие библиотеки.

  • easingcss3: (по умолчанию ease) Определяет эффект перехода для применения в случае использования css3:true. Вы можете использовать предустановленные эффекты (такие как linear, ease-out...) или создать свои собственные при помощи функции cubic-bezier. Вы также можете использовать для этой цели Matthew Lein CSS Easing Animation Tool.

  • loopTop: (по умолчанию false) Определяет, будет ли осуществляться скроллинг к последнему разделу при пролистывании первого раздела вверх.

  • loopBottom: (по умолчанию false) Определяет, будет ли осуществляться скроллинг к первому разделу при пролистывании последнего раздела вниз.

  • loopHorizontal: (по умолчанию true) Определяет, будут ли горизонтальные слайдеры работать циклично после перехода к последнему или предыдущему слайду.

  • css3: (по умолчанию true). Определяет использование JavaScript или CSS3-трансформаций для скроллинга в пределах разделов и слайдов. Эта функция помогает ускорить пролистывание для планшетов и мобильных устройств, браузеры которых поддерживают CSS3. Если установлено значение true для этой опции и браузер не поддерживает CSS3, будет использована альтернатива.

  • autoScrolling: (по умолчанию true) Определяет использование «автоматического» скроллинга или «обычного». Также эта опция влияет на размещение разделов в окне браузера/устройства для планшетов и мобильных устройств.

  • fitToSection: (по умолчанию true) Определяет, нужна ли подстройка разделов под окно просмотра. При установке значения true для данной опции текущий активный раздел всегда будет заполнять окно просмотра. В противном случае пользователь будет иметь возможность остановиться на середине раздела (когда )

  • fitToSectionDelay: (по умолчанию 1000). Если для опции fitToSection установлено значение true, данная функция замедлит подстройку на настроенные миллисекунды.

  • scrollBar: (по умолчанию false) Определяет, будет ли использоваться полоса прокрутки на сайте. При использовании полосы прокрутки функция autoScrolling будет работать как обычно. Пользователь по-прежнему сможет пролистывать сайт с помощью полосы прокрутки, и fullPage.js подстроит раздел под экран по окончании скроллинга.

  • paddingTop: (по умолчанию 0) Определяет верхний отступ для каждого раздела в числовом формате (paddingTop: '10px', paddingTop: '10em'...) Данная функция удобна при использовании фиксированных верхних колонтитулов.

  • paddingBottom: (по умолчанию 0) Определяет нижний отступ для каждого раздела в числовом формате (paddingBottom: '10px', paddingBottom: '10em'...). Данная функция удобна при использовании фиксированных нижних колонтитулов.

  • fixedElements: (по умолчанию null) Определяет, какие элементы будут исключены из структуры скроллинга плагина, что необходимо при использовании опции css3 для их фиксации. Для этого необходима строка с селекторами Javascript для данных элементов. (Например: fixedElements: '#element1, .element2')

  • normalScrollElements: (по умолчанию null) Если вы хотите избежать автопрокрутки при скроллинге некоторых элементов, вам нужно использовать эту опцию. (пригодится для карт, прокрутки div-элементов и т.д.) Для этого необходима строка с селекторами Javascript для данных элементов. (Например: normalScrollElements: '#element1, .element2'). Данную опцию следует применять к самим разделам/слайдам.

  • normalScrollElementTouchThreshold : (по умолчанию 5) Определяет порог количества пролистываний, которое проверит дерево узлов html Fullpage, чтобы убедиться, что normalScrollElements позволяет скроллинг на div-элементах на сенсорном устройстве. (Например: normalScrollElementTouchThreshold: 3)

  • bigSectionsDestination: (по умолчанию null) Определяет, как должна осуществляться прокрутка к разделу, размер которого превышает размер окна просмотра. По умолчанию fullPage.js пролистывает вверх, если вы попадаете из раздела над заданным, и вниз, если вы попадаете из раздела под заданным. Возможные значения: top, bottom, null.

  • keyboardScrolling: (по умолчанию true) Определяет возможность навигации на сайте при помощи клавиатуры.

  • touchSensitivity: (по умолчанию 5) Определяет ширину и высоту браузеров в процентах, а также то, насколько длинным должно быть пролистывание для перехода к следующему разделу/слайду.

  • continuousVertical: (по умолчанию false) Определяет, будет ли осуществляться скроллинг к последнему разделу при пролистывании первого раздела вверх и к первому разделу при пролистывании последнего раздела вниз. Опция несовместима с опциями loopTop, loopBottom и любыми полосами прокрутки, используемыми на сайте (scrollBar:true или autoScrolling:false).

  • continuousHorizontal: (по умолчанию false) Расширение fullpage.js. Определяет, будет ли при пролистывании вправо последнего слайда осуществляться прокрутка вправо к первому слайду, а также приведёт ли прокрутка влево первого слайда к прокрутке влево к последнему слайду. Опция несовместима с опцией loopHorizontal. Необходима версия fullpage.js >= 2.8.3.

  • scrollHorizontally: (по умолчанию false) Расширение fullpage.js. Определяет осуществление горизонтального пролистывания ползунков при помощи колеса мыши или трекпада. Идеальна для рассказов. Необходима версия fullpage.js >= 2.8.3.

  • interlockedSlides: (по умолчанию false) Расширение fullpage.js. Определяет ,будет ли при передвижении одного горизонтального ползунка осуществляться пролистывание ползунков другого раздела в том же направлении. Возможные значения: true, false или последовательность взаимосвязанных разделов. Например: [1,3,5], начиная с 1. Необходима версия fullpage.js >= 2.8.3.

  • dragAndMove: (по умолчанию false) Расширение fullpage.js. Активирует или деактивирует протягивание и пролистывание разделов и слайдов при помощи мыши или пальцев. Возможные значения: true, false, vertical, horizontal, fingersonly, mouseonly,. Необходима версия fullPage.js >= 2.8.9.

  • offsetSections: (по умолчанию false)Расширение fullpage.js. Обеспечивает возможность использовать неполноэкранные разделы на основании их процентных значений. Опция идеальна для демонстрации пользователю того, что на сайте есть больше контента, показывая часть следующего или предыдущего раздела. Необходима версия fullPage.js >= 2.8.8 Для определения процентного значения каждого раздела необходимо использовать атрибут data-percentage. Центрирование раздела в окне просмотра может определяться при помощи логического значения в атрибуте data-centered (по умолчанию true, если не определено). Например:

    <div class="section" data-percentage="80" data-centered="true">
  • resetSliders: (по умолчанию false). Расширение fullpage.js. Определяет, необходимо ли возвращать в исходное положение каждый ползунок после покидания раздела, в котором он размещён. Необходима версия fullpage.js >= 2.8.3.

  • fadingEffect: (по умолчанию false). Расширение fullpage.js. Определяет, будет ли использоваться эффект затухания вместо используемого по умолчанию эффекта прокрутки. Возможные значения true, false, sections, slides. Таким образом, данный параметр может применяться только вертикально или горизонтально, или же одновременно в обоих направлениях. Необходима версия fullpage.js >= 2.8.6.

  • animateAnchor: (по умолчанию true) Определяет, будет ли во время загрузки сайта при использовании привязок (#) осуществляться прокрутка с анимацией к назначенному разделу или же напрямую.

  • recordHistory: (по умолчанию true) Определяет, нужно ли отображать состояние сайта в истории браузера. При установке значения true каждый раздел/слайд сайта будет действовать как новая страница, и кнопки браузера «назад» и «вперёд» прокрутят разделы/слайды для перехода к предыдущему или следующему состоянию сайта. При установке значения false URL будет продолжать меняться, но не отразится на истории браузера. Данная опция отключается автоматически при использовании опции autoScrolling:false.

  • menu: (по умолчанию false) Селектор может использоваться для связи элементов меню с разделами. Таким образом, скроллинг разделов активирует соответствующий элемент меню при помощи класса active. Это не приведёт к созданию нового меню, а лишь добавит класс active элементу в имеющемся меню с соответствующими ссылками с привязками. Чтобы связать элементы меню с разделами, необходимо будет использовать информационный блок HTML 5 (data-menuanchor) с теми же ссылками с привязками, которые используются в разделах. Пример:

<ul id="myMenu">
	<li data-menuanchor="firstPage" class="active"><a href="#firstPage">Первый раздел</a></li>
	<li data-menuanchor="secondPage"><a href="#secondPage">Второй раздел</a></li>
	<li data-menuanchor="thirdPage"><a href="#thirdPage">Третий раздел</a></li>
	<li data-menuanchor="fourthPage"><a href="#fourthPage">Четвёртый раздел</a></li>
</ul>
new fullpage('#fullpage', {
	anchors: ['firstPage', 'secondPage', 'thirdPage', 'fourthPage', 'lastPage'],
	menu: '#myMenu'
});

Внимание: элемент меню должен помещаться за пределами обёрточного кода для полного экрана во избежание проблем при использовании css3:true. В противном случае он будет присоединён к body самим плагином.

  • navigation: (по умолчанию false) При установке значения true панель навигации будет отображена в виде небольших кружков.

  • navigationPosition: (по умолчанию none) Могут быть установлены значения left или right. Опция определяет, какое положение займет панель навигации (если она используется).

  • navigationTooltips: (по умолчанию []) Определяет справочные надписи, которые будут показаны для кружков навигационной панели, если они используются. Например: navigationTooltips: ['firstSlide', 'secondSlide']. Вы можете также определить их с помощью атрибута data-tooltip в каждом разделе, если хотите.

  • showActiveTooltip: (по умолчанию false) Показывает постоянную справочную надпись для просматриваемого в данный момент раздела в вертикальной навигации.

  • slidesNavigation: (по умолчанию false) При установке значения true навигационная панель будет отображаться в виде небольших кружков для каждого горизонтального ползунка сайта.

  • slidesNavPosition: (по умолчанию bottom) Определяет местоположение горизонтальной навигационной панели для слайдеров. Возможные значения: top и bottom. При желании вы можете настроить стили CSS для определения расстояния от верхней до нижней части, так же как и любой другой стиль, например, цвет.

  • scrollOverflow: (по умолчанию false) определяет необходимость создания прокрутки для раздела/слайда, если контент превышает его высоту. При установке значения true ваш контент будет обёрнут плагином. Рассмотрите возможность делегирования или загрузите ваши скрипты для обратного вызова afterRender. При установке значения true необходима библиотека разработчика scrolloverflow.min.js, которая должна быть загружена до загрузки плагина fullPage.js, но после jQuery (если используется). Например:

<script type="text/javascript" src="vendors/scrolloverflow.min.js"></script>
<script type="text/javascript" src="fullpage.js"></script>

Чтобы предотвратить создание fullpage.js полосы прокрутки в определённых разделах или слайдах, используйте класс fp-noscroll. Например: <div class="section fp-noscroll">

Вы можете избежать применения scrolloverflow в отзывчивом режиме, используя fp-auto-height-responsive в элементе раздела.

  • scrollOverflowReset: (по умолчанию false) Расширение fullpage.js. При установке значения true будет осуществляться прокрутка контента раздела/слайда с помощью полосы прокрутки при покидании другого вертикального раздела. Таким образом, раздел/слайд будет всегда показывать начало контента даже при скроллинге из раздела/слайда, расположенного ниже.

  • scrollOverflowOptions: при применении scrollOverflow:true fullpage.js будет использовать модифицированную версию iScroll.js libary. Вы можете настроить поведение прокрутки, обеспечив fullpage.js опциями iScroll.js, которые вы хотите использовать. Более подробную информацию вы можете найти в документации.

  • sectionSelector: (по умолчанию .section) Определяет селектор Javascript, используемый для разделов с плагинами. Иногда требуется изменить его, чтобы избежать проблем с другими плагинами, использующими те же селекторы, что и fullpage.js.

  • slideSelector: (по умолчанию .slide) Определяет селектор Javascript, используемый для слайдов с плагинами. Иногда требуется изменить его, чтобы избежать проблем с другими плагинами, использующими те же селекторы, что и fullpage.js.

  • responsiveWidth: (по умолчанию 0) Будет использоваться стандартная прокрутка (autoScrolling:false), если ширина меньше, чем заданное значение в пикселях. Класс fp-responsive добавляется к тегу body, если пользователь желает использовать для собственного отзывчивого CSS. Например, если установлено значение 900, то, если ширина браузера составляет менее 900, плагин будет прокручивать, как обычный сайт.

  • responsiveHeight: (по умолчанию 0) Будет использоваться стандартная прокрутка (autoScrolling:false), если высота меньше, чем заданное значение в пикселях. Класс fp-responsive добавляется к тегу body, если пользователь желает использовать для собственного отзывчивого CSS. Например, если установлено значение 900, то, если высота браузера составляет менее 900, плагин будет прокручивать, как обычный сайт.

  • responsiveSlides: (по умолчанию false) Расширение fullpage.js. При установке значения true слайды будут трансформироваться в вертикальные разделы при активации отзывчивого режима. (с помощью опций responsiveWidth или responsiveHeight, подробно описанных выше). Необходима версия fullpage.js >= 2.8.5.

  • parallax: (по умолчанию false) Расширение fullpage.js. Определяет, будут ли использоваться эффекты параллакс для фона разделов / слайдов. Узнайте больше об использовании опции параллакс здесь.

  • parallaxOptions: (по умолчанию: { type: 'reveal', percentage: 62, property: 'translate'}). Позволяет настраивать параметры эффекта параллакс для фона при использовании опции parallax:true. Узнайте больше об использовании опции параллакс здесь.

  • lazyLoading: (по умолчанию true) Отложенная загрузка включена по умолчанию, что означает, что данная опция будет осуществлять отложенную загрузку любого медиа-элемента, содержащего атрибут data-src, как описано в документации отложенной загрузки. Если вы желаете использовать любую другую библиотеку отложенной загрузки, вы можете деактивировать данную функцию fullpage.js.

Функции

Можете увидеть их в действии здесь

getActiveSection()

Демо Даёт объект (наберите Section), содержащий активный слайд и его свойства.

fullpage_api.getActiveSection();

getActiveSlide()

Демо Даёт объект (наберите Slide), содержащий активный раздел и его свойства.

fullpage_api.getActiveSlide();

moveSectionUp()

Демо Прокручивает на один раздел вверх:

fullpage_api.moveSectionUp();

moveSectionDown()

Демо Прокручивает на один раздел вниз:

fullpage_api.moveSectionDown();

moveTo(раздел, слайд)

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

/*Прокручивание к разделу с ссылкой с привязкой `firstSlide` и ко 2-му слайду */
fullpage_api.moveTo('firstSlide', 2);
//Прокручивание к 3-му разделу на сайте
fullpage_api.moveTo(3, 0);

//То же самое, что и
fullpage_api.moveTo(3);

silentMoveTo(раздел, слайд)

Демо Абсолютно то же самое, что и moveTo, но в этом случае функция выполняет прокрутку без анимации. Прямой переход к заданной точке.

/*Прокручивание к разделу с ссылкой с привязкой `firstSlide` и ко 2-му слайду */
fullpage_api.silentMoveTo('firstSlide', 2);

moveSlideRight()

Демо Прокручивает горизонтальный ползунок текущего раздела к следующему слайду:

fullpage_api.moveSlideRight();

moveSlideLeft()

Демо Прокручивает горизонтальный ползунок текущего раздела к предыдущему слайду:

fullpage_api.moveSlideLeft();

setAutoScrolling(логическая операция)

Демо Устанавливает конфигурацию скроллинга в режиме реального времени. Определяет поведение прокрутки страницы. При установке значения true будет использоваться "автоматический" скроллинг, в противном случае будет применяться "стандартная" прокрутка сайта или прокрутка "вручную".

fullpage_api.setAutoScrolling(false);

setFitToSection(логическая операция)

Демо Устанавливает значение для опции fitToSection, определяющей, подстраивать ли раздел под экран.

fullpage_api.setFitToSection(false);

fitToSection()

Демо Прокручивает к ближайшему активному разделу, подстраивая его под окно просмотра.

fullpage_api.fitToSection();

setLockAnchors(логическая операция)

Демо Устанавливает значение для опции lockAnchors, определяющей, будут ли привязки отражаться в URL.

fullpage_api.setLockAnchors(false);

setAllowScrolling(логическая операция, [направления])

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

  • directions: (опциональный параметр) Значения: all, up, down, left, right или их комбинация, разделённая запятыми, например: down, right. Функция определяет направление, в котором будет активирован или деактивирован скроллинг.
//деактивация прокрутки
fullpage_api.setAllowScrolling(false);

//деактивация прокрутки вниз
fullpage_api.setAllowScrolling(false, 'down');

// деактивация прокрутки вниз и вправо
fullpage_api.setAllowScrolling(false, 'down, right');

setKeyboardScrolling(логическая операция, [направления])

Демо Даёт или убирает возможность скроллинга разделов с помощью клавиатуры (включено по умолчанию).

  • directions: (опциональный параметр) Значения: all, up, down, left, right или их комбинация, разделённая запятыми, например: down, right. Функция определяет направление, в котором будет активирован или деактивирован скроллинг.
// деактивация всей прокрутки с помощью клавиатуры fullpage_api.setKeyboardScrolling(false);

// деактивация прокрутки вниз с помощью клавиатуры
fullpage_api.setKeyboardScrolling(false, 'down');

//деактивация прокрутки вниз и вправо с помощью клавиатуры fullpage_api.setKeyboardScrolling(false, 'down, right');

setRecordHistory(логическая операция)

Демо Определяет, записывать ли историю для каждого изменения hash в URL.

fullpage_api.setRecordHistory(false);

setScrollingSpeed(миллисекунды)

Демо Определяет скорость прокрутки в миллисекундах.

fullpage_api.setScrollingSpeed(700);

destroy(тип)

Демо Разрушает события плагина и, опционально, его HTML-разметку и стили. Идеальна при использовании AJAX для загрузки контента.

  • type: (опциональный параметр) может быть пустым или иметь значение all. Если установлено all, HTML-разметка и стили, используемые fullpage.js, будут удалены. Таким образом, оригинальная HTML-разметка, используемая до произведения любой модификации плагина, будет сохранена.
//разрушение всех событий Javascript, созданных fullPage.js (прокручивания, изменения hash в URL...)
fullpage_api.destroy();

// разрушение всех событий Javascript и любых модификаций, произведённых fullPage.js поверх вашей оригинальной HTML-разметки.
fullpage_api.destroy('all');

reBuild()

Обновляет DOM-структуру для подстройки под новый размер окна или его содержимого. Идеальна для использования в комбинации с вызовами AJAX или внешними изменениями в DOM-структуре сайта, особенно при применении scrollOverflow:true.

fullpage_api.reBuild();

setResponsive(логическая операция)

Демо Устанавливает отзывчивый режима на странице. При установке хначения true автопрокрутка будет отключена, результат будет тем же самым, как при активации опций responsiveWidth или responsiveHeight.

fullpage_api.setResponsive(true);

responsiveSlides.toSections()

Расширение fullpage.js. Необходима версия fullpage.js >= 2.8.5. Трансформирует горизонтальные слайды в вертикальные разделы.

fullpage_api.responsiveSlides.toSections();

responsiveSlides.toSlides()

Расширение fullpage.js. Необходима версия fullpage.js >= 2.8.5. Трансформирует оригинальные слайды (теперь трансформированные в вертикальные разделы) обратно в горизонтальные слайды.

fullpage_api.responsiveSlides.toSlides();

Обратные вызовы

Демо Можете увидеть их в действии здесь.

Некоторые обратные вызовы, такие как onLeave, будут содержать тип параметров Section или Slide. Эти объекты будут содержать следующие свойства:

  • anchor: (String) ссылка с привязкой объекта.
  • index: (Number) индекс объекта.
  • item: (DOM element) элемент объекта.
  • isFirst: (Boolean) определяет, является ли объект первым дочерним элементом.
  • isLast: (Boolean) определяет, является ли объект последним дочерним элементом.

afterLoad (origin, destination, direction)

Обратный вызов активируется после загрузки разделов и завершения прокрутки. Параметры:

  • origin: (Object) активный раздел
  • destination: (Object) конечный раздел.
  • direction: (String) будет принимать значения up или down в зависимости от направления скроллинга.

Пример:

new fullpage('#fullpage', {
	anchors: ['firstPage', 'secondPage', 'thirdPage', 'fourthPage', 'lastPage'],

	afterLoad: function(origin){
		var loadedSection = this;

		//использование индекса
		if(origin.index == 2){
			alert("Section 3 ended loading");
		}

		//использование ссылки с привязкой
		if(origin.anchor == 'secondSlide'){
			alert("Section 2 ended loading");
		}
	}
});

onLeave (index, nextIndex, direction)

Этот обратный вызов активируется, когда пользователь покидает раздел, при переходе к новому разделу. Возврат false отменит переход до его осуществления.

Параметры:

  • origin: (Object) исходный раздел.
  • destination: (Object) конечный раздел.
  • direction: (String) будет принимать значения up или down в зависимости от направления скроллинга.

Пример:

new fullpage('#fullpage', {
	onLeave: function(origin, destination, direction){
		var leavingSection = this;

		//после покидания раздела 2
		if(origin.index == 1 && direction =='down'){
			alert("Going to section 3!");
		}

		else if(origin.index == 1 && direction == 'up'){
			alert("Going to section 1!");
		}
	}
});

Отмена прокрутки до её осуществления

Вы можете отменить прокрутку, установив возврат false на обратном вызове onLeave:

new fullpage('#fullpage', {
	onLeave: function(origin, destination, direction){
		//прокрутка не будет осуществлена, если заданный раздел – раздел 3
		if(destination.index == 2){
			return false;
		}
	}
});

afterRender()

Этот обратный вызов активируется сразу после того, как создаётся структура страницы. Данный обратный вызов вы можете использовать для инициализации других плагинов или активации любого кода, для чего требуется готовый документ (так как плагин изменяет DOM для создания финальной структуры). Более подробную информацию вы найдёте в разделе Часто задаваемые вопросы.

Пример:

new fullpage('#fullpage', {
	afterRender: function(){
		var pluginContainer = this;
		alert("Финальная DOM-структура готова");
	}
});

afterResize()

Этот обратный вызов активируется после изменения размера окна браузера. Сразу после изменения размера разделов.

Параметры:

  • width: (Number) ширина окна.
  • height: (Number) высота окна.

Пример:

new fullpage('#fullpage', {
	afterResize: function(width, height){
		var pluginContainer = this;
		alert("Завершено изменение размера разделов");
	}
});

afterResponsive(isResponsive)

Этот обратный вызов активируется после того, как fullpage.js переходит из стандартного режима в отзывчивый режим или из отзывчивого в стандартный.

Параметры:

  • isResponsive: (Boolean) логическая операция, которая определяет переход в режим отзывчивости (true) или переход обратно к стандартному режиму (false).

Пример:

new fullpage('#fullpage', {
	afterResponsive: function(isResponsive){
		alert("Is responsive: " + isResponsive);
	}
});

afterSlideLoad (section, origin, destination, direction)

Обратный вызов активируется после загрузки слайда раздела и окончания прокрутки.

Параметры:

  • section: (Object) активный вертикальный раздел.
  • origin: (Object) исходный горизонтальный слайд.
  • destination: (Object) конечный горизонтальный слайд.
  • direction: (String) right или left в зависимости от направления скроллинга.

Пример:

new fullpage('#fullpage', {
	anchors: ['firstPage', 'secondPage', 'thirdPage', 'fourthPage', 'lastPage'],

	afterSlideLoad: function( section, origin, destination, direction){
		var loadedSlide = this;

		//первый слайд второго раздела
		if(section.anchor == 'secondPage' && destination.index == 1){
			alert("Первый слайд загружен");
		}

		//второй слайд второго раздела (supposing #secondSlide is the
		//привязка для второго раздела
		if(section.index == 1 && destination.anchor == 'secondSlide'){
			alert("Второй слайд загружен");
		}
	}
});

onSlideLeave (section, origin, destination, direction)

Этот обратный вызов активируется после того, как пользователь покидает слайд для перехода к другому, при переходе к новому слайду. Возврат false отменит переход до его осуществления.

Параметр:

  • section: (Object) активный вертикальный раздел.
  • origin: (Object) исходный горизонтальный слайд.
  • destination: (Object) конечный горизонтальный слайд.
  • direction: (String) right или left в зависимости от направления скроллинга.

Пример:

new fullpage('#fullpage', {
	onSlideLeave: function( section, origin, destination, direction){
		var leavingSlide = this;

		//переход от первого слайда 2го раздела вправо
		if(section.index == 1 && origin.index == 0 && direction == 'right'){
			alert("Покидание первого слайда!!");
		}

		// переход от 3го слайда 2го раздела влево
               if(section.index == 1 && origin.index == 2 && direction == 'left'){
			alert("Переход к слайду 2! ");
		}
	}
});

Отмена перехода до его осуществления

Вы можете отменить переход с помощью возврата false на обратном вызове onSlideLeave. То же самое, что и при отмене перехода с помощью onLeave.

Сообщение о проблемах

  1. Пожалуйста, перед вопросом поищите свою проблему с помощью поиска github issues.
  2. Убедитесь, что используете последнюю версию fullpage.js. Техподдержка не работает со старыми версиями.
  3. Воспользуйтесь форумом Github Issues, чтобы задать вопрос.
  4. Потребуется отдельное воспроизведение проблемы. По возможности используйте для этого jsfiddle или codepen.

Внесение предложений для fullpage.js

Пожалуйста, прочтите Contributing to fullpage.js

Changelog

Чтобы посмотреть список последних изменений, пожалуйста, обратитесь к разделу Релизы.

Задачи по построению

Желаете построить дистрибутивные файлы fullpage.js? Пожалуйста, зайдите в раздел Задачи по построению

Ресурсы

Кто пользуется fullPage.js

Если вы хотите, чтобы ваша страница была указана в этом списке, пожалуйста, свяжитесь со мной и пришлите URL.

Google Coca-cola eBay BBC Sony

Vodafone British Airways McDonalds EA Vogue Mi

Mercedes sym Bugatti eDarling Ubisoft

Вы можете найти ещё один список здесь.

Денежные переводы

Денежные переводы более чем приветствуются :)

Patreon page

Перевести деньги

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor] | [Become a patreon]

Stackpath Browserstack HostPresto CodePen CodeFirst

People

You can’t perform that action at this time.