Package Exports
- ng-simple-slideshow
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ng-simple-slideshow) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
_ _ ___ _ _ ___ _ _ _ _
| \| |__ _/ __(_)_ __ _ __| |___/ __| (_)__| |___ __| |_ _____ __ __
| .` / _` \__ \ | ' \| '_ \ / -_)__ \ | / _` / -_|_-< ' \/ _ \ V V /
|_|\_\__, |___/_|_|_|_| .__/_\___|___/_|_\__,_\___/__/_||_\___/\_/\_/
|___/ |_|A simple slideshow for Angular 4+.
Click here the check out the demo.
Features
- NgSimpleSlideshow has no dependencies besides angular. All animations are 100% CSS, so @angular/animations is not needed.
- Compiled and packaged in the Angular Package Format v4.0 with ng-packagr.
- Compiled to es5, so this package is compatible with Angular Universal.
- AOT ready
- Responsive and captures swipes from phones and tablets
- Lazy load option to help with initial pageload speed
Installation
Easy, just npm install:
npm i -S ng-simple-slideshowNext, import the module:
import {SlideshowModule} from 'ng-simple-slideshow';
@NgModule({
imports: [
SlideshowModule,
...
],
declarations: [
...
],
exports: [
...
]
})
...Usage
The simplest use case is the following, but the full list of options is below:
<slideshow [imageUrls]="imageUrlArray"></slideshow>Options
Inputs
| Option | Required | Default | Type | Description |
|---|---|---|---|---|
| imageUrls | yes | [] | string[] or IImage[] | array of image urls or IImage |
| height | no | '100%' | string | CSS height of slideshow |
| minHeight | no | string | CSS min-height of slideshow | |
| arrowSize | no | '30px' | string | length of arrow lines |
| showArrows | no | true | boolean | show or hide the arrows |
| disableSwiping | no | false | boolean | turn swipe detection on or off |
| autoPlay | no | false | boolean | turn autoPlay on or off |
| autoPlayInterval | no | 3333 | number | time in ms between autoPlay slides |
| stopAutoPlayOnSlide | no | true | boolean | stop autoPlay if slideshow is interacted with |
| autoPlayWaitForLazyLoad | no | false | boolean | autoplay to waits for images to lazy load before changing slides |
| debug | no | false | boolean | write debugging information to the console |
| backgroundSize | no | 'cover' | string | overwrite background-size property |
| backgroundPosition | no | 'center center' | string | overwrite background-position property |
| backgroundRepeat | no | 'no-repeat' | string | overwrite background-repeat property |
| showDots | no | false | boolean | show clickable dots at the bottom |
| dotColor | no | '#FFF' | string | color of clickable dots at the bottom |
| showCaptions | no | true | boolean | show or hide captions |
| captionColor | no | '#FFF' | string | color of caption text |
| captionBackground | no | 'rgba(0, 0, 0, .35)' | string | color of caption background |
| lazyLoad | no | false | boolean | turn on to lazy load images instead of preload |
| lazyLoadSpinnerUrl | no | '/assets/_loading.gif' | string | url of loading spinner image |
Output Events
| Event | Description |
|---|---|
| onSlideLeft | when the left arrow is clicked |
| onSlideRight | when the right arrow is clicked |
| onSwipeLeft | when a swipe left occurs |
| onSwipeRight | when a swipe right occurs |
Note: all events emit the index number of the new slide
API
Take control of the slideshow if you want! Simply create a reference to your slideshow like so:
<slideshow #slideshow [imageUrls]="imageUrlArray"></slideshow>and in your component.ts reference it as a ViewChild:
@ViewChild('slideshow') slideshow: ElementRef;Now you can access the public members such as the goToSlide and onSlide:
this.slideshow.goToSlide(3); // go to slide index 3 (i.e. imageUrls[3])this.slideshow.onSlide(1); // next slidethis.slideshow.onSlide(-1); // previous slide