README.md

ngx-siema

Lightweight and simple carousel with no dependencies.

Demo

Installation

npm install ngx-siema --save

or

yarn add ngx-siema

• ngx-siema require installed siema package for correct work (npm install siema --save).

Sample

Include NgxSiemaModule in your main module:

import { NgxSiemaModule} from 'ngx-siema';

@NgModule({
  // ...
  imports:      [
    NgxSiemaModule
  ],
  // ...
})
export class AppModule { }

Then use in your component:

import { Component, OnInit } from '@angular/core';
import { NgxSiemaOptions } from 'ngx-siema';

@Component({
  selector: 'sample',
  template: `
      <ngx-siema ngxClass="my-siema"
         [options]="options"
         (onPrev)="prev($event)"
         (onNext)="next($event)"
         (onGoTo)="goTo($event)">
    	  <ngx-siema-slide>
    	    <img src="assets/siema--pink.svg">
    	  </ngx-siema-slide>
    	  <ngx-siema-slide>
    	    <img src="assets/siema--yellow.svg">
    	  </ngx-siema-slide>
    	  <ngx-siema-slide>
    	    <img src="assets/siema--pink.svg">
    	  </ngx-siema-slide>
      </ngx-siema>
  `
})
export class Sample implements OnInit {
    options: NgxSiemaOptions;

    ngOnInit() {
        this.options = {
            duration: 200,
            easing: 'ease-out',
            perPage: 1,
            startIndex: 0,
            draggable: true,
            threshold: 20,
            loop: false,
        };
    }
}

Example of usage with the navigation buttons:

import { Component, ViewChild } from '@angular/core';
import { NgxSiemaComponent } from 'ngx-siema';

@Component({
  selector: 'sample',
  template: `
      <ngx-siema>
    	  <ngx-siema-slide>
    	    <img src="assets/siema--pink.svg">
    	  </ngx-siema-slide>
    	  <ngx-siema-slide>
    	    <img src="assets/siema--yellow.svg">
    	  </ngx-siema-slide>
    	  <ngx-siema-slide>
    	    <img src="assets/siema--pink.svg">
    	  </ngx-siema-slide>
      </ngx-siema>
      <button (click)="prev()">Prev</button>
      <button (click)="next()">Next</button>
      <button (click)="goTo(2)">GoTo</button>
  `
})
export class Sample {
    @ViewChild(NgxSiemaComponent) siema;

    prev() {
        this.siema.prev();
    }

    next() {
        this.siema.next();
    }

    goTo(slide: number) {
        this.siema.goto(slide);
    }
}

License

MIT license.