Fullpage template and plugin documentation
<link rel="stylesheet" href='../HTWF/scripts/jquery.fullPage.css'> <script src='../HTWF/scripts/jquery.fullPage.min.js'></script>
<body> <header> ... </header> <nav class="fullpage-varrow"> <div class="arrow down"><span>GO DOWN</span><i class="fa fa-angle-down"></i></div> <div class="arrow up"><i class="fa fa-angle-up"></i><span>GO UP</span></div> </nav> <nav id="fullpage-menu" class="fullpage-menu menu-dots"> <ul> <li><a></a></li> <li><a></a></li> </ul> </nav> <div id="fullpage-main"> <div class="section overlay-container"> <div class="container content"> ... </div> </div> <div class="section overlay-container"> <div class="container content"> ... </div> </div> </div> <footer> ... </footer> </body>
<div id="fullpage-main" data-options="verticalCentered:false"> <div class="section overlay-container"> <div class="container content box-middle"> ... </div> </div> </div>
<div id="fullpage-main" data-options="verticalCentered:false"> <div class="section overlay-container"> <div class="container content box-middle"> <div class="row vertical-row"> <div class="col-md-8"> ... </div> <div class="col-md-4"> ... </div> </div> </div> </div> </div>
Name | Type | Description |
---|---|---|
HTML initialization | HTML |
Initialization require ID id="fullpage-main" . No others settings are required.
|
Javascript initialization | Javascript |
You can initialize the Fullpage via Javascript by remove ID id="fullpage-main" and with this function:
$(document).ready(function () { $("#my-id").fullpage(); }); |
Settings | HTML |
Most of settings can be passed through data-options attribute data-options="option:value,option:value, ..." .
Example <div id="fullpage-main" data-options="verticalCentered:false"> ... </div>Full options here. |
Arrows top - bottom | HTML |
To add top and bottom arrows insert below code just before fullpage-main container, if you not want arrows remove this code.
Arrows animation require animation component. <link rel="stylesheet" href='../HTWF/css/animations.css'>
<nav class="fullpage-varrow"> <div class="arrow down"><span>GO DOWN</span><i class="fa fa-angle-down"></i></div> <div class="arrow up"><i class="fa fa-angle-up"></i><span>GO UP</span></div> </nav>You can use 3 icons family sets: Font Awesome, Icon Mind Solid, Icons Mind Line. Click the buttons below for the complete icons lists. Font Awesome icons list Icons Mind icons list To change a icon replace the class fa fa-icon-name with the choosen icon class.
|
Arrows top - bottom position | HTML |
To set right position add class right to arrows container, for left position use class left .
Example: <nav class="fullpage-varrow right"> ... </nav> .
|
Arrows style | HTML |
To set white circle style for vertical arrows, add class varrow-circle to arrows container. Example: <nav class="fullpage-varrow varrow-circle"> ... </nav> .
To set white circle style for horizontal arrows, add class arrow-circle to arrows container. Example: <nav class="fullpage-arrow arrow-circle"> ... </nav> .
|
Animations | HTML |
To start a animation on the visible section add attribute data-fullpage-anima="animation-name" .
All features of animation component continue to work.
Plugin dependencyThis feature require Animations component ( |
Centered section | HTML |
You can center a section in two ways: 1 ) With the default centering, you not need to do nothing, but default centering have some limitation. 2 ) With the Framework Y centering, it auto calculate correct height by subtract fixed menus height and it center only contents into container with class box-middle . To use this feature you must add attribute
data-options="verticalCentered:false" to fullpage-main object and add class box-middle to container object of section.
Example: <div id="fullpage-main"> <div class="section overlay-container"> <div class="container content box-middle"> ... </div> </div> ... </div> |
Centered section | HTML | To set a full centering, also into a section, use the row vertical centered component. Row vertical centered component documentation here |
Center adjustment | HTML |
If the contents are not perfectly centered to the screen you can adjust it by add attirbute data-offset="123" to fullpage container.
Ex. <div id="fullpage-main" data-offset="60"> ... <div> .
|
Horizontal arrows adjustment | HTML |
If the right \ left arrows are not perfectly centered to the screen you can adjust its by add attirbute data-horizonal-arrow-offset="123" to fullpage container.
Ex. <div id="fullpage-main" data-horizonal-arrow-offset="-30"> ... <div> .
|
Mobile fullpage | HTML |
By default fullpage is converted into a class one page website on mobile.
To mainatin the fullPage mode also on mobile use the option data-options="mobileMode:fullpage" .
|
<div id="fullpage-main"> ... <div class="section overlay-container" style="background-image:url('http://www.framework-y.com/images/thumb-hd.png');"> <div class="container content box-middle"> ... </div> </div> ... </div>
<div id="fullpage-main" data-options="scrollBar:true"> ... <div class="section overlay-container" data-parallax="scroll" data-position="top" data-image-src="http://www.framework-y.com/images/thumb-hd.png" data-natural-height="1080" data-natural-width="1920" data-bleed="0"> <div class="container content box-middle"> ... </div> </div> ... </div>
<div id="fullpage-main"> ... <div class="section overlay-container"> <div class="background-page"> <div class="flexslider slider" data-options="directionNav:false,animation:fade"> <ul class="slides"> <li> <div class="bg-cover" style="background-image:url('http://www.framework-y.com/images/thumb-hd.png')"></div> </li> <li> <div class="bg-cover" style="background-image:url('http://www.framework-y.com/images/thumb-hd.png')"></div> </li> </ul> </div> </div> <div class="container content box-middle"> ... </div> </div> ... </div>
<div class="background-page overlay-container"> <div class="flexslider slider" data-options="directionNav:false,animation:fade,slideshowSpeed:5000"> <ul class="slides"> <li> <div class="bg-cover" style="background-image:url('http://www.framework-y.com/images/thumb-hd.png')"></div> </li> <li> <div class="bg-cover" style="background-image:url('http://www.framework-y.com/images/thumb-hd.png')"></div> </li> </ul> </div> </div> <div id="fullpage-main"> <div class="section overlay-container"> <div class="container content box-middle"> ... </div> </div> <div class="section overlay-container"> <div class="container content box-middle"> ... </div> </div> </div>
<div id="fullpage-main"> <div class="section overlay-container"> <div class="background-page" style="background-image:url(video-poster.jpg)"> <video loop poster="video-poster.jpg"> <source src="video.mp4" type="video/mp4"> </video> </div> <div class="container content box-middle"> ... </div> </div> <div class="section overlay-container"> <div class="background-page"> <div data-video-youtube="NA6fPQTd22M"></div> </div> <div class="container content box-middle"> ... </div> </div> </div>
<div class="background-page overlay-container" style="background-image:url(video-poster.jpg)"> <video autoplay="autoplay" loop="loop" poster="video-poster.jpg" class="background-fullscreen"> <source src="video.mp4" type="video/mp4"> </video> </div> <div id="fullpage-main"> <div class="section overlay-container"> <div class="container content box-middle"> ... </div> </div> <div class="section overlay-container"> <div class="container content box-middle"> ... </div> </div> </div>
<div id="fullpage-main"> <div class="section overlay-container"> <div class="container content box-middle"> ... </div> </div> <footer class="section footer-base fp-auto-height"> <div class="container content box-middle"> ... </div> </div> </div>
Name | Type | Description | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Image section | CSS style |
Add style style="background-image:url('image.jpg');" to section object.
|
|||||||||||||||||||||
Isolated images background | HTML |
If you need to add single images as background add its to <div class="background-page"> ... </div> .
Add these classes for set the image position:
<div class="section overlay-container"> <div class="background-page" data-fullpage-anima="fade-right" data-timeline="desc"> <img class="bg-right bg-middle anima" src="image.png" style="margin-top: -250px;" /> <img class="bg-right bg-middle anima" src="image.png" style="margin-top: -50px;" /> <img class="bg-left bg-bottom anima anima-fade-left" src="image.jpg" /> </div> <div class="container content text-center box-middle"> ... </div> </div> |
|||||||||||||||||||||
Top area | HTML |
To add top area into a section add HTML code like example:
<div class="section"> <div class="top-area"> <div class="container"> ... </div> </div> <div class="container content text-center box-middle"> ... </div> </div> |
|||||||||||||||||||||
Bottom area | HTML |
To add bottom area into a section add HTML code like example:
<div class="section"> <div class="container content text-center box-middle"> ... </div> <div class="bottom-area"> <div class="container"> ... </div> </div> </div> |
|||||||||||||||||||||
Footer area | HTML |
To add a bottom section with partial height, perfect for footer, add a new section at bottom and add class fp-auto-height .
Check example above for more details.
|
|||||||||||||||||||||
Image parallax section | Mixed |
1 ) Add attributes data-options="scrollBar:true" to fullpage-main object.
2 ) Add attributes data-parallax="scroll" data-position="top" data-image-src="image.jpg" data-natural-width="123" data-natural-height="123" data-bleed="0" to section object.
Plugin dependencyThis feature require Parallax Plugin ( |
|||||||||||||||||||||
Slider section | HTML |
Insert slider code of examples above into section object, at the top, first row. Slider must use setting animation:fade .
Plugin dependencyThis feature require Flex Slider Plugin ( |
|||||||||||||||||||||
Slider single section | HTML | Insert slider code of examples outside the fullpage-main object, before it. | |||||||||||||||||||||
Video section | HTML |
Insert video code of examples above into section object, at the top, first row. You can use also Youtube videos with this code:<div class="background-page" style="background-image:url(video-poster.jpg)"> <div data-video-youtube="NA6fPQTd22M" video-quality="hd"></div> </div> Video documentationVideo Youtube feature is part of background video section. Complete documentation here |
|||||||||||||||||||||
Video single section | HTML | Insert video code of examples outside the fullpage-main object, before it. | |||||||||||||||||||||
Overlay pattern | HTML |
You can add a overlay to every background like images, videos and sliders. Insert it into <div class="background-page"> ... </div> object, in first row.
Example: <div class="background-page"> <div class="bg-overlay line-45"></div> <div data-video-youtube="NA6fPQTd22M" video-quality="hd"></div> </div> Overlay pattern documentationOverlay pattern is a feature of CSS and Javascript. Complete documentation here |
|||||||||||||||||||||
Mobile background | CSS class |
To set section images as background also on mobile add class background-mobile to section object.
|
<body> <header> ... </header> <nav class="fullpage-arrow"> <table class="arrow left"> <tr> <th><i class="fa fa-angle-left"></i></th> <th><span>BACK PAGE</span></th> </tr> </table> <table class="arrow right"> <tr> <th><i class="fa fa-angle-right"></i></th> <th><span>NEXT PAGE</span></th> </tr> </table> </nav> <div class="fixed-top"> <div id="fullpage-horizontal-menu" class="full-width-menu"> <div class="container"> <div class="row"> <div class="col-md-12"> <ul class="nav over inner"> <li class="active"><a>Home</a></li> <li><a>Our services</a></li> </ul> </div> </div> </div> </div> </div> <div id="fullpage-main"> <div class="section"> <div class="slide overlay-container"> <div class="container content text-center box-middle"> ... </div> </div> <div class="slide overlay-container"> <div class="container content text-center box-middle"> ... </div> </div> </div> </div> <footer> ... </footer> </body>
<nav id="fullpage-horizontal-menu" class="fullpage-horizontal-menu menu-dots"> <ul> <li class="active"><a></a></li> <li><a></a></li> <li><a></a></li> <li><a></a></li> <li><a></a></li> </ul> </nav>
Name | Type | Description |
---|---|---|
Settings | Information |
Horizontal fullpage is a single section object with multiple slides objects. You can use all features of vertical fullpage.
|
Setting new menu | HTML |
You can set every <ul><li><a></a></li></ul> object as a fullpage menu.
You only need to add ID id="fullpage-horizontal-menu" to container object.
Menu links must not have attribute href . Menu nav must not use class navbar-nav .
Menu is auto sync with the fullpage sections, by calculate items index.
|
Arrows right - left | HTML |
To add right and left arrows insert below code just before fullpage-main container, if you not want arrows remove this code.
Arrows animation require animation component. <link rel="stylesheet" href='../HTWF/css/animations.css'>
Example: <nav class="fullpage-arrow"> <table class="arrow left"> <tr> <th><i class="fa fa-angle-left"></i></th> <th><span>BACK PAGE</span></th> </tr> </table> <table class="arrow right"> <tr> <th><i class="fa fa-angle-right"></i></th> <th><span>NEXT PAGE</span></th> </tr> </table> </nav> You can use 3 icons family sets: Font Awesome, Icon Mind Solid, Icons Mind Line. Click the buttons below for the complete icons lists. Font Awesome icons list Icons Mind icons list To change a icon replace the class fa fa-icon-name with the choosen icon class.
|