README.md

ng-front-page

Angularjs directive for full page landing and scolling

Demo

demo.html file contains example usage. View demo

Installation

$ bower install ng-front-page

Usage

1. Require ng-front-page.js in your html file

<script src="ng-front-page.js"></script>

2. Require base CSS style

a. If you use less import ng-front-page.less in your less file

@import "ng-front-page.less"

b. Else require ng-front-page.css in your html file

<link rel="stylesheet" href="ng-front-page.css">

3. Add module name 'ngFrontPage' to your apps dependencies

var app = angular.module('yourApp', ['ngFrontPage']);

4. Add front-page or data-front-page attribute to the parent element.

<div data-front-page data-options="options"></div>

5. Add slide-container if horizontal slide is required.

6. Add slide class for each child slide page

7. Add horizontal-nav if page indicator is required.

8. Add prev-button and next-button if previous and next slide buttons are required.

<div data-front-page data-options="options">
    <div class="slide-container">
      <div class="slide"></div>
      <div class="slide"></div>
    </div>

  <div class="prev-button"></div>
  <div class="next-button"></div>
  <div class="horizontal-nav"></div>
</div>

9. Define class to be added to body when a front page element becomes active by data-enter-class attribute

10. Define class to be removed from body when a front page element becomes inactive by data-exit-class attribute

11. For enabling automatic loop through horizontal slides, add attribute data-auto-loop="true"

12. Define auto loop period by data-auto-loop-period attribute in milliseconds

13. ng-front-page collaborates with ui-router. It makes transition to route when front page becomes active and if scrolls to front page when route is changed. For binding with router, define route name by data-route-nameattribute.