/FullPageScroll

Full Page Scroll - Javascript

Primary LanguageJavaScriptMIT LicenseMIT

Simple Full Page Scroll

Create amazing fullpage:

Installation

###Step 1: Link required files

html

<!-- fullPage Javascript file -->
<script src="/js/fullPage.min.js"></script>

###Step 2: Create HTML markup

html

<div id="main">
	<section class="section"></section>
	<section class="section"></section>
	<section class="section"></section>
	<section class="section"></section>
</div>

###Step 3: Call the FullPage

Call .FullPage() on <div id="main">.

var page = new FullPage("#main");

##Options

section selector

default: '.section'
options: String

easing

default: 'ease'
options: 'ease-in', 'ease-out', 'linear'

For more options check: <a href="https://developer.mozilla.org/pt-BR/docs/Web/CSS/animation-timing-function", target="_blank">Mozilla MDN

transform

default: 'transform'

animation duration

default: 700,
options: int

Millesecond(ms) not second(s)

pagination

default: 'true',
options: boolean (true / false)

keyboard

default: 'true',
options: boolean (true / false)

touch

default: 'true',
options: boolean (true / false)

touchLimit

default: 100,
options: int

##Methods See here

NOTE: Verify your instace before call method check it

moveTo()

page.moveTo(index);

##Callbacks onLeave

default: null,
option: onLeave: function(index) {},

afterLoad

default: null,
option: afterLoad: function(index) {},

Gulp commands

  • gulp —— Default for task development
  • gulp --prod —— Task production
  • Access http://localhost:3000

Changelog

1.0

  • Added callbacks, onLeave() and afterLoad()
  • Added moveTo method

1.1

  • Added prototype for every functions
  • Touch event

Contributing

Everyone is welcome to help contribute and improve this project. There are several ways you can contribute:

  • Reporting issues (please read issue guidelines)
  • Suggesting new features
  • Writing or refactoring code
  • Fixing issues

Version BETA

**I create this fullpage for study, sorry for any bugs, contribute with this repo. Thank's enjoy! **

License:

This boilerplate is free and open source software, distributed under the The MIT License. So feel free to use this to create your site without linking back to me or using a disclaimer.