# alipes-carousel

> Alipes carousel interactives

Latest version **1.3.14** (published 2018-10-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install alipes-carousel
pnpm add alipes-carousel
yarn add alipes-carousel
bun add alipes-carousel
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.14 |
| Published | 2018-10-18 |
| First published | 2018-02-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 220.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Sonya Chen |
| Maintainers | alipes |
| Keywords | alipes, carousel |

## Links

- npm: https://www.npmjs.com/package/alipes-carousel
- npm.io page: https://npm.io/package/alipes-carousel

## Dependencies (7)

- [jquery](https://npm.io/package/jquery.md) ^3.3.1
- [webpack](https://npm.io/package/webpack.md) ^2.2.1
- [hammerjs](https://npm.io/package/hammerjs.md) ^2.0.8
- [css-loader](https://npm.io/package/css-loader.md) ^0.27.3
- [sass-loader](https://npm.io/package/sass-loader.md) ^6.0.3
- [style-loader](https://npm.io/package/style-loader.md) ^0.16.1
- [foundation-sites](https://npm.io/package/foundation-sites.md) ^6.3.1

## 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.3.14 (latest) — 2018-10-18
- 1.3.13 — 2018-03-21
- 1.3.12 — 2018-03-19
- 1.3.11 — 2018-02-13
- 1.3.10 — 2018-02-13
- 1.3.9 — 2018-02-12
- 1.3.8 — 2018-02-12
- 1.3.7 — 2018-02-12
- 1.3.6 — 2018-02-12
- 1.3.5 — 2018-02-12
- 1.3.4 — 2018-02-12
- 1.3.3 — 2018-02-12
- 1.3.2 — 2018-02-12
- 1.3.1 — 2018-02-12

## README

# AlipesCarousel 1.3.14

AlipesCarousel was created to provide custom carousel solutions designed by Alipes. It currently contains 3 different types of custom carousels.

## How to use
* npm install alipes-carousel
* require('alipes-carousel/js/alipesCarousel') for the javascript
* import '~alipes-carousel/scss/alipesCarousel.scss' for the scss

There are currently settings you can override:

###Default:
```js
$('#my-carousel').alipesCarousel({
    type: 'sonyacel',
    navPrev: true,
    navPrevClass: 'prev',
    navPrevContent: '<',
    navNext: true,
    navNextClass: 'next',
    navNextContent: '>',
    indicators: true,
    transtionTextColor: true,
    carouselHeightBasedOnImage: false,
    defaultCarouselHeight: 500
});
```

### Settings
Option | Description
------ | -----------
type | Avaliable: 'sonyacel', 'singleSlide', and 'sudensel'
navPrev | bool value. Show previous arrow navigation
navPrevClass | Add custom class to the previous arrow navigation
navPrevContent | Change the arrows to your own custom version
navNext | bool value. Show next arrow navigation
navNextClass | Add custom class to the next arrow navigation
navNextContent | Change the arrows to your own custom version
indicators | true/false value. Add dot indicators
transtionTextColor | true/false value. Transition the background color for the text slider
carouselHeightBasedOnImage | bool value. Allows the carousel to size based on the images used. Only used in sonyacel
defaultCarouselHeight | int value. Only used when carouselHeightBasedOnImage is TRUE. Only used in sonyacel

### Methods
$('#my-carousel').alipesCarousel().destroy();

Removes all the event listeners in the carousel


## SingleSlider
In order to use this feature, you must install hammerjs for mobile support (touch guestures)
Uses 2.0.8 as of 10/17/2017


## Standalone Installation
1. npm install
2. npm run build or webpack
3. php -S localhost:8000
4. navigate to localhost:8000 in browser
5. profit

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