README.md

fullPage.js

preview compatibility

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

适用于VueReact

---

fullPage.js version License PayPal Donate jsDelivr Hits    |   7Kb gziped   |   Created by @imac2


通过调用本库可轻易创建全屏滚动网站(也称为单页网站)。 本库可创建全屏滚动网站,同时也可在网站中添加横向滚动条。

介绍

不仅限于提需求,也欢迎提出编码风格改进的建议。 集思广益,让这个库更加强大,让写代码更轻松!

兼容性

fullPage.js兼容所有的现代浏览器,以及一些旧版浏览器,如Internet Explorer 9,Opera 12等都能兼容。 可兼容支持CSS3的浏览器与非支持CSS3的浏览器,适用于旧版浏览器。 同时,手机、平板电脑和触摸屏电脑还提供触屏支持。

特别感谢Browserstack 支持fullpage.js。

许可证

商业许可证

如果您想使用fullPage开发商业网站、主题、项目和应用程序,商业许可证是您应使用的许可证。使用这个许可证,您的源代码将保留专有权。 这意味着,您不必将整个应用程序源代码更改为开源许可证。点击此处购买fullpage商业许可证

开源许可证

如果您使用与GNU GPL license v3兼容的许可证创建开源应用程序,则可以在GPLv3条款下使用fullPage。

JavaScript和CSS文件中的信用评论应保持完整 (即使在组合或缩小后)

阅读更多关于fullPage的许可证

用法

正如示例文件所示,需要引用:

  • JavaScript 文件fullpage.js (或其缩小版本 fullpage.min.js)
  • css 文件fullpage.css

可选,使用css3:false时,如果您想要使用库中包含的其他缓动效果的功能(easeInOutCubic),您可以添加easings file

使用bower或npm进行安装

或者,如果您愿意,可以使用bower或npm安装fullPage.js:

终端:

// 使用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代码必须使用HTML DOCTYPE 声明,否则可能会遇到代码段高度问题。HTML 5 doctype中的示例: <!DOCTYPE html>.

每个代码段定义为包含section类的元素。 第一个代码段作为主页,是默认激活代码。 代码段应进行封装(即<div id="fullpage"> )。 封装不能是body元素。

<div id="fullpage">
	<div class="section">Some section</div>
	<div class="section">Some section</div>
	<div class="section">Some section</div>
	<div class="section">Some section</div>
</div>

如果你想定义一个与众不同的起始页面,而不是原始第一段或第一个滑动页,只需将active类添加到你想首先载入的段或滑动页。

<div class="section active">Some section</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>

可以在simple.html文件看到完整的HTML结构的例子

初始化

用Vanilla Javascript初始化

您只需要在关闭</body>标签之前调用fullPage.js。

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']
});

URL#secondPage/2 结尾处的锚分别定义了目标段落和幻灯片。 在前面的URL中,目标段落将是使用锚点 secondPage 定义的段落,幻灯片将会是第2张幻灯片,因为我们使用索引 2 。 (一个段落的第一个幻灯片有索引0,在技术上这是一个段落)。

如果我们在HTML标记中使用属性data-anchor,就可以使用自定义锚点来代替它的索引:

<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

请注意,如果没有提供anchors数组,则也可以使用data-anchor属性以同样的方式定义节锚点。

注意!data-anchor标记的值不能与站点上的任何ID元素(或IE的NAME元素)相同。

创建更小或更大的段落

演示 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) SECTIONSLIDE部分将成为当前部分和幻灯片的锚(或索引,如果没有提供锚)。
  • 当进入响应模式时,fp-responsive添加到body元素`
  • 当启用fullpage.js时,fp-enabled添加到html元素。 (并在销毁时被移除)。
  • 当fullPage.js被销毁时,fp-destroyed被添加到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的延迟加载解决方案,则可以通过设置 lazyLoading: false选项来禁用fullPage.js延迟加载。

自动播放/暂停嵌入式媒体

注意:根据操作系统和浏览器的不同,自动播放功能可能无法在某些移动设备上使用(即iOS的Safari 版本 < 10.0)。

播放部分/幻灯片载入:

对于视频或音频使用属性 autoplay,或者对于youtube iframe使用参数autoplay=1将使得在加载页面时播放媒体元素。 在段落/幻灯片载入使用而不是属性data-autoplay播放。 例如:

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

暂停

嵌入式HTML5<video>/<audio>和Youtube iframe在离开某个段落或幻灯片时自动暂停。 可以通过使用属性data-keepplaying来禁用。 例如:

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

使用扩展

fullpage.js 提供了一组扩展您可以使用它来增强其默认功能。 所有这些都被列为 fullpage.js 选项.

扩展需要使用在dist 文件夹中的缩小文件 fullpage.extensions.min.js,而不是通常的fullPage.js文件 (fullpage.jsfullpage.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商业许可证时提供的许可证密钥。 否则,您可以使用字符串OPEN-SOURCE-GPLV3-LICENSE。 请阅读更多关于许可[这里](https://github.com/alvarotrigo/fullPage.js#license)和[在网页上](https://alvarotrigo.com/fullPage/pricing/)。例如:

new fullpage({
    licenseKey: 'YOUR_KEY_HERE'
});
  • v2compatible: (默认 false). 确定是否使其与版本2编写的任何代码100%兼容,忽略版本3的新功能或api更改。状态类,回调签名等的工作方式与在版本2上完全相同。请注意该选项将在之后的某个时候被删除。

  • controlArrows:(默认为 true)确定是否将幻灯片的控制箭头向右或向左移动。

  • verticalCentered:(默认为true)在段落内部垂直居中。 当设置为true时,您的代码将被库包装。可考虑使用委托或在afterRender回调中加载其他脚本。

  • scrollingSpeed:(默认700)滚动转换的速度(以毫秒为单位)。

  • sectionsColor:(默认none)为每个部分定义CSSbackground-color属性。 例:

new fullpage('#fullpage', {
	sectionsColor: ['#f2f2f2', '#4BBFC3', '#7BAABE', 'whitesmoke', '#000'],
});
  • anchors:(默认[])定义要在每个部分的URL上显示的锚链接(#example)。 锚点的值应该是独一无二的。 数组中的锚的位置将限定锚被应用于哪些部分。 (第二部分的第二个位置等等)。 通过浏览器也可以使用锚点向前和向后导航。 该选项还允许用户为特定的部分或幻灯片添加书签。 **注意!**锚点不能与站点上的任何ID元素(或IE的NAME元素)具有相同的值。 现在可以通过使用属性data-anchor直接在HTML结构中定义锚点,如此处所述。

  • lockAnchors:(默认为false)确定URL中的锚是否在库中完全有效。 您仍然可以在函数和回调内部使用锚,但是它们在滚动网站时不起任何作用。 如果你想在URL中使用锚点来将fullPage.js和其他插件结合起来,那就很有用。

重要理解 anchors选项数组中的值通过在标记中的位置直接关联到具有.section 类的元素是有帮助的。

  • easing:(默认easeInOutCubic)定义用于垂直和水平滚动的过渡效果。 它需要文件vendors / easings.min.jsjQuery UI来使用它的转换。 其他库可以用来代替。

  • easingcss3: (默认ease)定义在使用css3:true的情况下使用的过渡效果。 你可以使用预定义的(比如linearease-out ...)或者使用立方bezier功能创建你自己的。 你可能想使用Matthew Lein CSS缓动动画工具

  • 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将滚动到顶部,如果您来自目的地之下的部分,则会滚动到底部。 可能的值是topbottomnull

  • keyboardScrolling: (默认为true)定义是否可以使用键盘浏览内容。

  • touchSensitivity: (默认5)定义浏览器窗口宽度/高度的百分比,以及滑动到下一个节/幻灯片必须测量的距离

  • continuousVertical:(默认为false)定义是否在最后一个区段向下滚动,或是否应该向下滚动到第一个区段,或如果在第一个区段向上滚动时是否应该滚动到最后一个区段。 不兼容loopToploopBottom或站点中存在的任何滚动条(scrollBar:trueautoScrolling:false)。

  • continuousHorizontal: (默认falsefullpage.js的扩展。 定义在最后一张幻灯片中向右滑动是否应该向右滑动到第一张幻灯片,或者如果在第一张幻灯片中向左滚动是否应向左滑动到最后一张。 不兼容loopHorizontal。 需要fullpage.js> = 2.8.3。

  • scrollHorizontally:(默认falsefullpage.js的扩展。 定义是否使用鼠标滚轮或触控板在滑块内水平滑动。 讲故事的理想选择。 需要fullpage.js> = 2.8.3。

  • interlockedSlides: (默认falsefullpage.js的扩展。 确定移动一个水平滑块是否会强制滑块在其他段落中的滑动方向相同。 可能的值是truefalse或带有互锁部分的数组。 例如[1,3,5]`从1开始。需要fullpage.js> = 2.8.3。

  • dragAndMove: (默认falsefullpage.js的扩展。 启用或禁用鼠标或手指拖动和滑动部分和幻灯片。 需要fullpage.js> = 2.8.9。 可能的值是:

    • true: 启用该功能。
    • false: 禁用该功能。
    • vertical: 只能在垂直情况下启用该功能。
    • horizontal: 只能在水平情况下启用该功能。
    • fingersonly: 仅启用触摸设备的功能。
    • mouseonly: 仅启用桌面设备的功能(鼠标和触控板)。
  • offsetSections: (默认falsefullpage.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的扩展。 定义是否使用淡入淡出效果,而不是默认的滚动效果。 可能的值是truefalsesectionsslides。 因此,可以垂直或水平地应用,或者同时应用于两者。 需要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)可以设置为leftright,并定义导航栏显示的位置(如果使用的话)。

  • navigationTooltips: (默认为[])定义要使用导航圈的工具提示。 例如:navigationTooltips:['firstSlide','secondSlide']。 如果您愿意,也可以在每个部分中使用属性data-tooltip来定义它们。

  • showActiveTooltip: (默认为false)显示垂直导航中主动查看节的持久工具提示。

  • slidesNavigation: (默认为false)如果设置为true,则会显示一个导航栏,该导航栏由站点上每个横向滑块的小圆圈组成。

  • slidesNavPosition: (默认bottom)定义滑块的横向导航栏的位置。 值为topbottom。 您可能需要修改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">

在section元素中使用fp-auto-height-responsive时,您也可以防止scrolloverflow应用于响应模式。

  • scrollOverflowReset:(默认falsefullpage.js的扩展。 如果设置为true,当离开另一个垂直节时,使用滚动条向上滚动节/幻灯片的内容。 这样,即使从下面的节滚动,节/幻灯片也会始终显示其内容的开始。

  • scrollOverflowOptions: 当使用scrollOverflow:true时,fullpage.js将使用iScroll.js库文件的分叉和修改版本。 您可以通过为要使用的iScroll.js选项提供fullpage.js来自定义滚动行为。 查看它的文档了解更多信息。

  • sectionSelector: (默认.section)定义用于插件部分的Javascript选择器。 有时可能需要更改,以避免与使用与fullpage.js相同的选择器的其他插件的问题。

  • slideSelector: (默认.slide)定义用于插件幻灯片的Javascript选择器。 有时可能需要更改,以避免与使用与fullpage.js相同的选择器的其他插件的问题。

  • responsiveWidth: (默认0)一个正常的滚动(autoScrolling:false)将在定义的宽度下以像素为单位使用。 如果用户希望将自己的响应式CSS用于身体标记,则会将fp-responsive类添加到身体标记中。 例如,如果设置为900,则每当浏览器的宽度小于900时,插件将像正常站点一样滚动。

  • responsiveHeight: (默认0)一个正常的滚动(autoScrolling:false)将在定义的高度下以像素为单位使用。 如果用户希望将自己的响应式CSS用于身体标记,则会将fp-responsive类添加到身体标记中。 例如,如果设置为900,则每当浏览器的高度小于900时,插件将像正常站点一样滚动。

  • responsiveSlides: (默认falsefullpage.js的扩展。 设置为true时,在响应模式被触发时,幻灯片将变成垂直节。 (通过使用上面详述的responsiveWidthresponsiveHeight选项)。 需要fullpage.js> = 2.8.5。

  • parallax: (默认falsefullpage.js的扩展。 定义是否在节/幻灯片上使用视差背景效果。 详细了解如何应用视差选项.

  • parallaxOptions: (默认:{type:'reveal',percent:62,property:'translate'})。 允许在使用选项parallax:true时配置视差背景效果的参数。 详细了解如何应用视差选项.

  • lazyLoading: (默认true)延迟加载默认是激活的,这意味着它会延迟加载包含属性data-src的任何媒体元素,详见Lazy Loading docs。 如果你想使用任何其他的后加载库,你可以禁用这个fullpage.js功能。

方法

你可以在这里看到它们

getActiveSection()

示例 获取包含活跃部分及其属性的对象(键入[Section](https://github.com/alvarotrigo/fullPage.js/tree/master/lang/chinese#callbacks))。

fullpage_api.getActiveSection();

getActiveSlide()

示例 获取包含活跃部分及其属性的对象(键入[Slide](https://github.com/alvarotrigo/fullPage.js/tree/master/lang/chinese#callbacks))。)。

fullpage_api.getActiveSlide();

moveSectionUp()

示例 向上滚动一节:

fullpage_api.moveSectionUp();

moveSectionDown()

示例 向下滚动一节:

fullpage_api.moveSectionDown();

moveTo(第节, 幻灯片)

示例 将页面滚动到给定节并滑动。 第一张幻灯片,默认情况下,将有索引0。

/*滚动到锚链接`firstSlide`和第二张幻灯片的部分 */
fullpage_api.moveTo('firstSlide', 2);
//滚动到网站的第三节
fullpage_api.moveTo(3, 0);

//这是一样的
fullpage_api.moveTo(3);

silentMoveTo(第节, 幻灯片)

示例moveTo完全相同,但是在这种情况下,它将执行没有动画的滚动。 直接跳到目的地。

/*滚动到锚链接`firstSlide`和第二张幻灯片的部分 */
fullpage_api.silentMoveTo('firstSlide', 2);

moveSlideRight()

示例 将当前节的水平滑块滚动到下一张幻灯片:

fullpage_api.moveSlideRight();

moveSlideLeft()

示例 将当前节的水平滑块滚动到上一张幻灯片:

fullpage_api.moveSlideLeft();

setAutoScrolling(boolean)

示例 实时设置滚动配置。 定义页面滚动行为的方式。 如果设置为true,则将使用"自动"滚动,否则将使用站点的"手动"或"正常"滚动。

fullpage_api.setAutoScrolling(false);

setFitToSection(boolean)

示例 设置选项fitToSection的值,确定是否适合屏幕中的部分。

fullpage_api.setFitToSection(false);

fitToSection()

示例 滚动到最近的适合视口的活动节。

fullpage_api.fitToSection();

setLockAnchors(boolean)

示例 设置选项lockAnchors的值,确定锚是否在URL中有效。

fullpage_api.setLockAnchors(false);

setAllowScrolling(boolean, [directions])

示例 添加或删除通过使用鼠标滚轮/触控板或触摸手势(默认处于活动状态)滚动节/幻灯片的可能性。 注意这不会禁用键盘滚动。 您将需要使用setKeyboardScrolling

  • directions:(可选参数)允许的值:allupdownleftright或者它们的组合,用down,right等逗号分隔。 它定义了滚动将被启用或禁用的方向。
//禁用滚动
fullpage_api.setAllowScrolling(false);

//禁用向下滚动
fullpage_api.setAllowScrolling(false, 'down');

//禁用向下和向右滚动
fullpage_api.setAllowScrolling(false, 'down, right');

setKeyboardScrolling(boolean, [directions])

示例 添加或删除通过使用键盘(默认情况下处于活动状态)滚动节的可能性。

  • directions: (可选参数)允许的值:allupdownleftright或者它们的组合,用down,right等逗号分隔。 它定义了滚动将被启用或禁用的方向。
//禁用所有键盘滚动
fullpage_api.setKeyboardScrolling(false);

//禁用键盘向下滚动
fullpage_api.setKeyboardScrolling(false, 'down');

//禁用键盘向下和向右滚动
fullpage_api.setKeyboardScrolling(false, 'down, right');

setRecordHistory(boolean)

示例 定义是否在URL中记录每个散列更改的历史记录。

fullpage_api.setRecordHistory(false);

setScrollingSpeed(milliseconds)

示例 定义以毫秒为单位的滚动速度。

fullpage_api.setScrollingSpeed(700);

destroy(type)

示例 销毁插件事件以及可选的HTML标记和样式。使用AJAX加载内容时的理想选择。

  • type: (可选参数)可以为空或all。 如果all被传递,fullpage.js使用的HTML标记和样式将被删除。 这样,原始的HTML标记,即任何插件修改之前使用的标记都将被保留。
//销毁由fullPage.js创建的所有Javascript事件(URL中的卷动,hashchange)
fullpage_api.destroy();

//销毁所有的JavaScript事件,以及在原始HTML标记中由fullPage.js所做的任何修改。
fullpage_api.destroy('all');

reBuild()

更新DOM结构以适应新的窗口大小或其内容。   非常适合与AJAX调用或站点的DOM结构中的外部更改结合使用,特别是在使用scrollOverflow:true时。

fullpage_api.reBuild();

setResponsive(boolean)

示例 设置页面的响应模式。 当设置为true时,自动滚动将被关闭,结果与responsiveWidthresponsiveHeight`选项被触发时的结果完全相同。

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();

Callbacks

示例 你可以在这里看到他们。

一些回调,例如onLeave将包含SectionSlide类型的参数。 这些对象将包含以下属性:

  • anchor: (String) 项目的anchorLink。
  • index: (Number) 项目的index。
  • item: (DOM element) 项目元素。
  • isFirst: (Boolean) 判断游标是否在第一行。
  • isLast: (Boolean) 判断游标是否在最后一行。

afterLoad (origin, destination, direction)

滚动结束之后,一旦加载了节,就会触发回调。参数:

  • origin: (Object) active section
  • destination: (Object) 终点部分。
  • direction: (String) 它将根据滚动方向采用updown值。

例如:

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

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

		//使用 index
		if(origin.index == 2){
			alert("第3节停止加载");
		}

		//使用 anchorLink
		if(origin.anchor == 'secondSlide'){
			alert("第2节停止加载");
		}
	}
});

onLeave (origin, destination, direction)

一旦用户离开某个节,过渡到新节,就会触发此回调。 返回“false”将在移动发生之前取消移动。

参数:

  • origin: (Object) 起始部分
  • destination: (Object) 终点部分。
  • direction: (String) 它将根据滚动方向采用updown值。

例如:

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

		//离开第二节后
		if(origin.index == 1 && direction =='down'){
			alert("前往第3节!");
		}

		else if(origin.index == 1 && direction == 'up'){
			alert("前往第1节!");
		}
	}
});

触发之前取消滚动

您可以通过在onLeave回调函数上返回`false来取消滚动:

new fullpage('#fullpage', {
	onLeave: function(origin, destination, direction){
		//如果目标是第三节,它将不会滚动
		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("是否响应" + isResponsive);
	}
});

afterSlideLoad (section, origin, destination, direction)

滚动结束后,加载一个节的幻灯片后触发回调。

参数:

  • section: (Object) 活跃垂直部分。
  • origin: *(Object)*水平滑动起始。
  • destination: *(Object)*水平滑动终点。
  • direction: (String) 它将根据滚动方向采用rightleft 值。

例如:

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("第一张幻灯片加载完毕");
		}

		//第二节的第二张幻灯片(假设#secondSlide是
        //为第二张幻灯片锚点
		if(section.index == 1 && destination.anchor == 'secondSlide'){
			alert("第二张幻灯片加载完毕");
		}
	}
});

onSlideLeave (section, origin, destination, direction)

一旦用户离开幻灯片转到另一个幻灯片,就会触发此回调。返回false将在移动发生之前取消移动。

参数:

  • section: (Object) active vertical section.
  • origin: (Object) horizontal slide of origin.
  • destination: (Object) destination horizontal slide.
  • direction: (String) right or left depending on the scrolling direction.

例如:

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

		//留下第二节的第一张幻灯片
		if(section.index == 1 && origin.index == 0 && direction == 'right'){
			alert("离开第一张幻灯片!");
		}

		//将第二节的第三张幻灯片留在左边
		if(section.index == 1 && origin.index == 2 && direction == 'left'){
			alert("前往第二张幻灯片!");
		}
	}
});

在发生移动之前取消移动

您可以通过在onSlideLeave回调中返回false来取消移动。 与使用onLeave取消动作一样

报告问题

1.请在提问之前使用github问题搜索查找您的问题。 2.确保使用最新的fullpage.js版本。 不支持旧版本。 3.使用Github问题论坛来创建问题。 4.需要单独复制该问题使用jsfiddlecodepen,如果可能的话。

贡献给fullpage.js

请参阅贡献给fullpage.js

更新日志

要查看最近更改的列表,请参见发行版部分.

构建任务

想要构建fullpage.js分发文件? 请参阅Build Tasks

参考资源

谁在使用 fullPage.js

如果你想让你的页面在这里列出。 请使用网址与我联系

Google Coca-cola eBay BBC Sony

Vodafone British Airways McDonalds EA Vogue Mi

Mercedes sym Bugatti eDarling Ubisoft

你可以找到另一个列表这里.

捐献

非常欢迎您的捐款:)

Patreon page

Donate

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

People