Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JayChase/angular2-useful-swiper
Use iDangero.us' great slider, Swiper in Angular 2.
https://github.com/JayChase/angular2-useful-swiper
Last synced: about 1 month ago
JSON representation
Use iDangero.us' great slider, Swiper in Angular 2.
- Host: GitHub
- URL: https://github.com/JayChase/angular2-useful-swiper
- Owner: JayChase
- License: mit
- Created: 2016-09-08T02:33:27.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-05-18T09:20:53.000Z (over 1 year ago)
- Last Synced: 2024-10-27T05:05:28.225Z (about 2 months ago)
- Language: TypeScript
- Homepage:
- Size: 4.78 MB
- Stars: 101
- Watchers: 11
- Forks: 33
- Open Issues: 54
-
Metadata Files:
- Readme: README.md
- License: license.md
Awesome Lists containing this project
- awesome-angular-components - angular2-useful-swiper - Use iDangero.us's great slider Swiper in Angular 2. (Uncategorized / Uncategorized)
README
## ngx-useful-swiper
Use iDangero.us's great slider [Swiper](http://idangero.us/swiper/#.V9C3w4VOLaI) in Angular.
#### Quick links
- [Demo (StackBlitz)](https://stackblitz.com/edit/ngx-useful-swiper)
- [Swiper homepage](http://idangero.us/swiper/#.WTiywWiGNhE)
### Install
```bash
npm install --save ngx-useful-swiper@latest swiper
```
Add the swiper styles to the app styles in **angular.json**.
```json
{
"$schema": "./node_modules/@angular/cli/lib/config/schema.json",
"version": 1,
"newProjectRoot": "projects",
"projects": {
"demo": {
...
"architect": {
"build": {
"builder": "@angular-devkit/build-angular:browser",
"options": {
...
"styles": [
"./node_modules/swiper/swiper-bundle.css",
],
...
```
### Usage
In **app.module.ts** (or in whichever child module you are using the component) import the **NgxUsefulSwiperModule** module.
```typescript
import { NgxUsefulSwiperModule } from 'ngx-useful-swiper';
@NgModule({
declarations: [AppComponent],
imports: [BrowserModule, NgxUsefulSwiperModule],
providers: [],
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](http://idangero.us/swiper/demos/#.V9C73YVOLaI) 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**.
```html
```
Set the config for the swiper in you component and bind it to the component config property as above.
```javascript
import { SwiperOptions } from 'swiper';
export class MyComponent implements OnInit {
config: SwiperOptions = {
pagination: { el: '.swiper-pagination', clickable: true },
navigation: {
nextEl: '.swiper-button-next',
prevEl: '.swiper-button-prev'
},
spaceBetween: 30
};
```
Set the height and width of the component.
```css
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.
```html
![]()
```
**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.
```css
.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.
```html
![]()
```
#### 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](https://angular.io/docs/ts/latest/guide/template-syntax.html#!#ref-vars).
For example add the template reference **#usefulSwiper**
```html
![]()
```
..and then you can use the reference to access the **swiper** property.
```html
loop
```
To access the swiper instance and all of it's properties, methods and events use a viewchild to get the component.swiper property.
```typescript
@ViewChild('usefulSwiper',{static: false S}) usefulSwiper: SwiperComponent;
...
next() {
this.usefulSwiper.swiper.slideNext();
}
```