ngslides
v1.0.0
Published
AngularJS 1.6 module for creating presentations on webpage
Downloads
2
Maintainers
Readme
ngSlides
Angular 1.6 module for creating presentations on webpage.
You can download this module directly from github page. And add it with CSS file directly to html page.
Dependencies: JQuery 3.2, Angular 1.6 and font awesome css.
Basic using
- Add this module to module that will use ngSlides
angular.module('yourmodule', ['ngSlides']);
- Create configuration object for ngSlides directive
// Available options
var configuration = {
timeout: 5000,
animation: 'fade',
toolbarVisibility: true,
toolbarAutohide: true,
autoStart: true
};
- Add directive to html page
<div class="directive" ng-slides="configuration">
<ng-slide>
Slide code
</ng-slide>
...
</div>
Available animations
- fade
- slideLeft
- slideRight
- slideDown
- slideUp
- cascade
- custom
Custom animations
- Declare custom animation object:
customAnimation: {
animationEnter: {
transitions: [
{ css: 'opacity 1s linear', from: 0, to: 1 },
( ... )
]
},
animationLeave: {
transitions: [
{ css: 'opacity 0.5s ease-in-out', from: 1, to: 0 },
( ... )
]
}
}
- Configure ngSlide:
var configuration = {
(...)
animation: 'custom'
customAnimation: customAnimation
}
API
Module exposes an basic API. To use it you need to pass an empty object to directive
<div ng-slide="configuration" ng-slide-api="apiObject">
(...)
</div>
Available methods:
- toggleToolbar()
- toggleAutohide()
- prevSlide()
- fullscreen()
- play()
- pause()
- loop()
- nextSlide()
- selectSlide(Number): Boolean
Warning! SelectSlide will change slide when current transition between slides is finished. This method returns false if slide cannot be changed in current moment otherwise it returns true.
Style
There are available some basic classes for slides:
- title-slide
- title
- sub-title
- content-slide
- title
- content
- two-columns-slide
- title
- col-1
- col-2