hcenggel / ngx-useful-swiper

Use iDangero.us' great slider, Swiper in Angular.

ngx-useful-swiper

this is not quite ready yet but feel free to have a look

Use iDangero.us's great slider version 4+ Swiper in Angular.

Note this package does not yet support Swiper version 4 so be sure to user v3.4.2.

Quick links

Plunker template, Swiper homepage

Install

npm install --save ngx-useful-swiper@latest

Setup

Add Swiper 4 to your single page

  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/Swiper/4.x.x/css/swiper.min.css">
  <script src="https://cdnjs.cloudflare.com/ajax/libs/Swiper/4.x.x/js/swiper.min.js"></script>

..or with angular-cli you can add the package

npm install --save swiper@latest

then add the js and css to angular-cli.json

    "styles": [
        "styles.css",
        "../node_modules/swiper/dist/css/swiper.css"        
    ],
    "scripts": [
        "../node_modules/swiper/dist/js/swiper.js"                
    ],

SystemJS

In the SystemJs config file (systemjs.config.js) add a mapping for the package

var map = {
    ...
    'ngx-useful-swiper': 'node_modules/ngx-useful-swiper/lib'
};

and add the package to the list of packages.

var packages = {
   ...
   'ngx-useful-swiper': { main: 'swiper.module.js', defaultExtension: 'js' }
};

or for angular-cli

Just install the package and then import the module as below.

How to use it

Import the SwiperModule at the appropiate level in your app.

For example in app.module.ts

import { NgModule }       from '@angular/core';
import { BrowserModule }  from '@angular/platform-browser';

import { MatButtonModule, MatCardModule } from '@angular/material';

import { SwiperModule } from 'ngx-useful-swiper';

import { AppComponent }   from './app.component';
import { DemoComponent }   from './demo.component';

@NgModule({
    imports: [
        BrowserModule,
        MatButtonModule,
        MatCardModule
        SwiperModule
    ],
    declarations: [
        AppComponent,
        DemoComponent
    ],
    bootstrap: [AppComponent]
})
export class AppModule { }

Add the swiper component to your component to create a slider and add the content as you normally would to set up a slider (see the official demos for more information). Note, you don't need to include the swiper-container div just the content, but the slides should be contained in a swiper-wrapper div and have the class swiper-slide.

 <my-component>
       <swiper [config]="config">
        <div class="swiper-wrapper">
            <div class="swiper-slide">Slide 1</div>
                <div class="swiper-slide">Slide 2</div>
                <div class="swiper-slide">Slide 3</div>
                <div class="swiper-slide">Slide 4</div>
                <div class="swiper-slide">Slide 5</div>
                <div class="swiper-slide">Slide 6</div>
                <div class="swiper-slide">Slide 7</div>
                <div class="swiper-slide">Slide 8</div>
                <div class="swiper-slide">Slide 9</div>
                <div class="swiper-slide">Slide 10</div>
            </div>
            <!-- Add Pagination -->
            <div class="swiper-pagination"></div>
            <!-- Add Arrows -->
            <div class="swiper-button-next"></div>
            <div class="swiper-button-prev"></div>
        </swiper>
 </my-component>

Set the config for the swiper in you component and bind it to the component config property as above.

export class MyComponent implements OnInit {

    config: any = {
        pagination: {
        el: '.swiper-pagination',
        },
        paginationClickable: true,
        navigation: {
        nextEl: '.swiper-button-next',
        prevEl: '.swiper-button-prev',
        },
        spaceBetween: 30
    };

}

Set the height and width of the component. It can be targeted by its name ##swiper##

swiper{
    height: 300px;
    width: 400px;
}

The component also checks for the contents of swiper-wrapper being changed and calls update on the swiper when they are. This allows for dynamic slide lists as you can see from the demo in this repo.

<swiper [config]="config">
    <div class="swiper-wrapper">
        <img class="swiper-slide" *ngFor="let image of images" [src]="image">
    </div>
    <div class="swiper-pagination"></div>
    <div class="swiper-button-next"></div>
    <div class="swiper-button-prev"></div>
</swiper>

note for Bootstrap users

To ensure the swiper works will with a column layout you may need to set the box-sizing to border-box on the swiper-wrapper.

.swiper-wrapper {
    box-sizing: border-box;
}

Manually initializing the Swiper

By default the Swiper will be created in the AfterViewChecked event of the component. If the swiper is not going to have been rendered at this time (if it is on a hidden tab for example), it is best to handle the initialization manually. To do this use the component's initialize property and only set it's value to true when ready. This will then initialize the Swiper the next time the next AfterViewChecked event is fired to ensure the DOM is ready.

<mat-card>
  <mat-card-title>Demo</mat-card-title>
  <mat-card-content>
      <swiper class="swiper" [config]="config">
          <div class="swiper-wrapper">
              <img class="swiper-slide" *ngFor="let image of images" [src]="image">
          </div>
          <div class="swiper-pagination"></div>
          <div class="swiper-button-next"></div>
          <div class="swiper-button-prev"></div>
      </swiper>
  </mat-card-content>
  <mat-card-actions>
      <button mat-raised-button color="primary" (click)="loadImages()">load images</button>
  </mat-card-actions>
</mat-card>

Accessing the Swiper instance

When a new instance of Swiper is created it is set as a property on the component. You can then access this by using a template reference. For example add the template reference #usefulSwiper

<swiper [config]="config" #usefulSwiper>
    <div class="swiper-wrapper">
        <img class="swiper-slide" *ngFor="let image of images" [src]="image">
    </div>
    <div class="swiper-pagination"></div>
    <div class="swiper-button-next"></div>
    <div class="swiper-button-prev"></div>
</swiper>

..and then you can use the reference to access the swiper property.

<button (click)="usefulSwiper.swiper.createLoop()">loop</button>

To access the swiper instance and all of it's properties, methods and events use a viewchild to get the component.swiper property.

 @ViewChild('usefulSwiper') usefulSwiper: SwiperComponent;

 ...

  next() {
    this.usefulSwiper.swiper.slideNext();
  }