# ngx-simple-slick

> Angular Slick carousel plugin without any dependencies and jQuery

Latest version **2.0.0** (published 2023-02-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install ngx-simple-slick
pnpm add ngx-simple-slick
yarn add ngx-simple-slick
bun add ngx-simple-slick
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2023-02-24 |
| First published | 2023-02-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 86.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | RAJESH KUMARAVEL |
| Maintainers | rajeshkumaravel |
| Keywords | ng slick, ng slick carousel, slick carousel, angular slick carousel, ngx slick carousel |

## Links

- npm: https://www.npmjs.com/package/ngx-simple-slick
- npm.io page: https://npm.io/package/ngx-simple-slick

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^2.3.0

## Alternatives

- [adhdev](https://npm.io/package/adhdev.md) — 11.1K weekly downloads
- [react-slide-button](https://npm.io/package/react-slide-button.md) — 310 weekly downloads
- [better](https://npm.io/package/better.md) — 42 weekly downloads
- [react-native-swipe-image](https://npm.io/package/react-native-swipe-image.md) — 22 weekly downloads
- [nl.fokkezb.pulltorefresh](https://npm.io/package/nl.fokkezb.pulltorefresh.md) — 11 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2023-02-24
- 1.0.0 — 2023-02-24
- 0.0.6 — 2023-02-24
- 0.0.4 — 2023-02-24
- 0.0.3 — 2023-02-24
- 0.0.2 — 2023-02-24
- 0.0.1 — 2023-02-24

## README

# Ngx Slick

![NPM](https://img.shields.io/npm/l/ngx-simple-slick)
![npm](https://img.shields.io/npm/v/ngx-simple-slick?style=flat-square)
<p>
  <img alt="github actions" src="https://img.shields.io/badge/-Github_Actions-2088FF?style=flat-square&logo=github-actions&logoColor=white" height=25 />
  <img alt="angular" src="https://img.shields.io/badge/-Angular-DD0031?style=flat-square&logo=angular&logoColor=white" height=25 />
  <img alt="TypeScript" src="https://img.shields.io/badge/-TypeScript-007ACC?style=flat-square&logo=typescript&logoColor=white" height=25 />
</p>

`ngxslick` is a lightweight and very complete Angular library for rendering simple slideshow of elements without any 3rd party dependencies
- Supports dots and arrow navigation
- Custom styling
- Multi row support

[Demo](https://ngx-carousel-slick-demo.vercel.app)
---
## Using library locally
Run the below command and use npm link under `dist/ngxslick` folder in your application

```console
npm run watch
```

## License

This project is licensed under the MIT License. See LICENSE for more information.
## Table of contents

- [Installation](#installation)
- [Import in Angular](#import-in-angular)
- [Options](#options)
- [Example](#example)
- [Custom Styling](#custom-styling)
---

### Installation

```
$ npm i ngx-simple-slick --save
```

### Import in Angular

```console
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { NgxSlickModule } from 'ngx-simple-slick';

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

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    NgxSlickModule
  ],
  providers: [ ],
  bootstrap: [ AppComponent ]
})
export class AppModule { }
```

```console
<ngxslick [dots]=true [loadStatus]="'done'">
  <ng-container>
  // Content goes here
  </ng-container>
</ngxslick>
```

### Options
ngxslick comes with some parameters / options in order to make it fit your needs. The following parameters / options have to be used like this:

```console
<ngxslick [parameter-or-option-name]="value"></ngxslick>
```

| Option        	| Type              	| Required     	| Values          	| Description                                                          	|
|---------------	|-------------------	|--------------	|-----------------	|----------------------------------------------------------------------	|
| loadStatus    	| @Input String     	| **Optional** 	| done / fetching 	| Status whether data loading is complete or fetching                  	|
| dots          	| @Input Boolean    	| **Optional** 	| true / false    	| Dots navigation enabled if true; default arrow navigation is enabled 	|
| left          	| @Input String     	| **Optional** 	|                 	| Custom class for left navigation arrow                               	|
| right         	| @Input String     	| **Optional** 	|                 	| Custom class for right navigation arrow                              	|

### Example

#### import and usage

```console
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { NgxSlickModule } from 'ngx-simple-slick';

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

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    NgxSlickModule
  ],
  providers: [ ],
  bootstrap: [ AppComponent ]
})
export class AppModule { }
```

```console
// demo.component.ts
export class DemoComponent implements OnInit {
  dataObj = new Array(21);
  constructor() { }

  ngOnInit(): void {
  }

}
```

```console
// demo.component.html
<ngxslick [dots]=true [loadStatus]="'done'">
   <ngxslick [dots]=true [loadStatus]="'done'">
      <ng-container *ngFor="let card of dataObj; let i = index">
        <div class="card">
          <figure>
            <img src="https://via.placeholder.com/150x150?text=NG%20Slick" />
            <figcaption>Card {{ i + 1 }}</figcaption>
          </figure>
        </div>
      </ng-container>
    </ngxslick>
</ngxslick>
```

### Custom Styling

```console

// demo.component.html
<ngxslick [dots]=true [left]="'leftArrow'" [right]="'rightArrow'" [loadStatus]="'done'">
</ngxslick>


// demo.component.css
// styling dots

:host::ng-deep .pagination {
    padding: 5px !important;
}

:host::ng-deep .leftArrow {
  .prev-arrow {
    right: -50px !important;
  }
}
:host::ng-deep .rightArrow {
  .next-arrow {
    right: -50px !important;
  }
}

```

---
_Source: https://npm.io/package/ngx-simple-slick · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
