# ngx-nexus-slider

> [![pipeline status](https://gitlab.com/lorenzocalamandrei/ngx-nexus-slider/badges/master/pipeline.svg)](https://gitlab.com/lorenzocalamandrei/ngx-nexus-slider/commits/master) [![coverage report](https://gitlab.com/lorenzocalamandrei/ngx-nexus-slider/badge

Latest version **1.0.1** (published 2019-11-14) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install ngx-nexus-slider
pnpm add ngx-nexus-slider
yarn add ngx-nexus-slider
bun add ngx-nexus-slider
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-11-14 |
| First published | 2019-11-12 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 158.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | lorenzo.calamandrei |
| Keywords | nexus, slider, angular |

## Links

- npm: https://www.npmjs.com/package/ngx-nexus-slider
- Repository: https://gitlab.com/lorenzocalamandrei/ngx-nexus-slider
- Homepage: https://gitlab.com/lorenzocalamandrei/ngx-nexus-slider#readme
- Issues: https://gitlab.com/lorenzocalamandrei/ngx-nexus-slider/issues
- npm.io page: https://npm.io/package/ngx-nexus-slider

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^1.9.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

- 1.0.1 (latest) — 2019-11-14
- 1.0.0 — 2019-11-14
- 0.0.2 — 2019-11-12
- 0.0.1 — 2019-11-12

## README

# NexusSlider (ngx-nexus-slider)

[![pipeline status](https://gitlab.com/lorenzocalamandrei/ngx-nexus-slider/badges/master/pipeline.svg)](https://gitlab.com/lorenzocalamandrei/ngx-nexus-slider/commits/master)
[![coverage report](https://gitlab.com/lorenzocalamandrei/ngx-nexus-slider/badges/master/coverage.svg)](https://gitlab.com/lorenzocalamandrei/ngx-nexus-slider/commits/master)

This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.2.0.

## Installing

Run `yarn add ngx-nexus-slider` to install this package.

![Demo GIF](https://gitlab.com/lorenzocalamandrei/ngx-nexus-slider/raw/master/projects/nexus-slider/.readme/demo.gif)

## Usage example

```html
<nexus-slider>
    <nexus-slide>Slide 1</nexus-slide>
    <nexus-slide>Slide 2</nexus-slide>
  </nexus-slider>
```

### Possible @Input

```typescript
export class NexusSliderComponent {
    @Input() pauseOnHover = true;
    @Input() isInPause = false;
    @Input() slideActiveIndex = 0;
    @Input() slideDelay = 2000;
    
    @Input() showNavigation = true;
    @Input() showPrevNext = false;
    
    @Output() slideChange = new EventEmitter();
    @Output() goInPause = new EventEmitter();
    @Output() goInStart = new EventEmitter();
    @Output() mouseIsHover = new EventEmitter();
}
```

- `pauseOnHover`: When the user mouse is hover the slider it will be paused.
- `isInPause`: The slider will start as paused, and after the mouse pass hover the slider it will start automatic slide
- `slideActiveIndex`: Index of the slide at start point.
- `slideDelay`: Time between automatic slide.

- `showNavigation`: Show the button under the slider
- `showPrevNext`: Show the lateral arrows to go to the next or the prev.

- `slideChange`: Emit when the active slide change.
- `goInPause`: Emit when the slider is paused.
- `goInStart`: Emit when the slider is resumed.
- `mouseIsHover`: Emit when the user mouse is hover the slider.

## Code scaffolding

Run `ng generate component component-name --project nexus-slider` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project nexus-slider`.
> Note: Don't forget to add `--project nexus-slider` or else it will be added to the default project in your `angular.json` file. 

## Build

Run `yarn build:nexus-slider` to build the project. The build artifacts will be stored in the `dist/` directory.

## Publishing

After building your library with `yarn build:nexus-slider`, go to the dist folder `cd dist/nexus-slider` and run `npm publish`.

## Running unit tests

Run `ng test nexus-slider` to execute the unit tests via [Karma](https://karma-runner.github.io).

## Further help

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).

## Author

* Lorenzo Calamandrei <nexcal.dev@gmail.com>

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