ngx-slick-carousel


1. Support Angular 17 (not compatible with <= 16, if you want, use 15.0.0 release)
2. Support Server side rendering
3. Support Re-initialize case
4. Fastest slick init/unslick implementation in Angular

Installation

To install this library, run:

``bash
$ npm install jquery @types/jquery --save
$ npm install slick-carousel @types/slick-carousel --save
$ npm install ngx-slick-carousel --save
`

Consuming your library

Once you have published your library to npm, you can import your library in any Angular application by running:

`bash
$ npm install ngx-slick-carousel --save
`

and then from your Angular standalone component:

`typescript
import { Component } from '@angular/core';

// Import your library
import { SlickCarouselModule } from 'ngx-slick-carousel';

@Component({
...,
standalone: true,
imports: [
SlickCarouselModule, // Put in here
],
})
export class ExampleComponent {
...
}
`

- Include slick css in "styles" at your angular.json file :
`
"styles": [
...
"node_modules/slick-carousel/slick/slick.scss",
"node_modules/slick-carousel/slick/slick-theme.scss",
...
]
`

- Include jquery and slick js in "scripts" at your angular.json file :
`
"scripts": [
...
"node_modules/jquery/dist/jquery.min.js",
"node_modules/slick-carousel/slick/slick.min.js",
...
]
`

Once your library is imported, you can use its components, directives and pipes in your Angular application:
`html

#slickModal="slick-carousel"
[config]="slideConfig"
(init)="slickInit($event)"
(breakpoint)="breakpoint($event)"
(afterChange)="afterChange($event)"
(beforeChange)="beforeChange($event)">
@for (slide of slides; track slide.img) {



}


Add
Remove
slickGoto 2
unslick
`

`typescript
@Component({
...,
standalone: true,
imports: [
SlickCarouselModule,
],
})
class ExampleComponent {
slides = [
{img: "http://placehold.it/350x150/000000"},
{img: "http://placehold.it/350x150/111111"},
{img: "http://placehold.it/350x150/333333"},
{img: "http://placehold.it/350x150/666666"}
];
slideConfig = {"slidesToShow": 4, "slidesToScroll": 4};

addSlide() {
this.slides.push({img: "http://placehold.it/350x150/777777"})
}

removeSlide() {
this.slides.length = this.slides.length - 1;
}

slickInit(e) {
console.log('slick initialized');
}

breakpoint(e) {
console.log('breakpoint');
}

afterChange(e) {
console.log('afterChange');
}

beforeChange(e) {
console.log('beforeChange');
}
}
`

(IMPORTANT) If slides variable will be changed dynamically, use trackBy in *ngFor syntax. It will minimize ngxSlickItem directive recreation.

Development

To generate all .js, .d.ts and *.metadata.json files:

`bash
$ npm run build
`

To lint all *.ts files:

`bash
$ npm run lint
``

License

MIT © leo6104