# carousel-slider

> [![Known Vulnerabilities](https://snyk.io/test/github/brentoncozby/carousel-slider/badge.svg?targetFile=package.json)](https://snyk.io/test/github/brentoncozby/carousel-slider?targetFile=package.json)

Latest version **1.1.5** (published 2018-01-20) · MIT license · 0 weekly downloads

## Install

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

## 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.1.5 |
| Published | 2018-01-20 |
| First published | 2017-05-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Brenton Cozby |
| Maintainers | brenton-cozby |

## Links

- npm: https://www.npmjs.com/package/carousel-slider
- Repository: https://github.com/BrentonCozby/carousel-slider
- Homepage: https://github.com/BrentonCozby/carousel-slider#readme
- Issues: https://github.com/BrentonCozby/carousel-slider/issues
- npm.io page: https://npm.io/package/carousel-slider

## Recent versions

- 1.1.5 (latest) — 2018-01-20
- 1.1.4 — 2017-10-12
- 1.1.3 — 2017-10-12
- 1.1.2 — 2017-08-10
- 1.1.1 — 2017-08-10
- 1.1.0 — 2017-06-27
- 1.0.10 — 2017-06-26
- 1.0.9 — 2017-06-26
- 1.0.8 — 2017-06-26
- 1.0.7 — 2017-06-16
- 1.0.6 — 2017-06-16
- 1.0.5 — 2017-05-27
- 1.0.4 — 2017-05-27
- 1.0.3 — 2017-05-26
- 1.0.2 — 2017-05-26
- … 2 more at https://npm.io/package/carousel-slider/versions

## README

# carousel-slider
[![Known Vulnerabilities](https://snyk.io/test/github/brentoncozby/carousel-slider/badge.svg?targetFile=package.json)](https://snyk.io/test/github/brentoncozby/carousel-slider?targetFile=package.json)

### Supported Features
- Multiple carousels on the same page
- AutoSlide, with ability to change the time interval
- Looks good on all screen sizes
  * Option to break slides out of carousel-slider and stack them on top of each other (useful for small screens)

### Get Started
```
npm install --save carousel-slider
```
```html
<!-- CDN. The CSS and JS files are both required. -->

<link rel="stylesheet" href="https://cdn.rawgit.com/BrentonCozby/carousel-slider/4052c74e/dist/carousel.min.css">

<script src="https://cdn.rawgit.com/BrentonCozby/carousel-slider/4052c74e/dist/carousel.js"></script>
```

### Requirements
- jQuery

### Easy setup
1. Link ```carousel.min.css``` in the Head
2. Place ```carousel.js``` in a script tag at the bottom of the body
3. Copy the HTML code below and insert your content in the carousel-items

### Usage
Copy following HTML and insert your content into each carousel-item.
```html
<div class="carousel">
    <div id="left-btn" class="left-btn">‹</div>
    <div id="right-btn" class="right-btn">›</div>
    <div class="dots"></div>
    <div class="carousel-item">
        <!-- Your content goes here -->
    </div>
    <div class="carousel-item">
        <!-- Your content goes here -->
    </div>
    <div class="carousel-item">
        <!-- Your content goes here -->
    </div>
    <div class="carousel-item">
        <!-- Your content goes here -->
    </div>
</div>
```

### Example: background image with content
```html
<!-- Add your background image in the style tag -->
<div class="carousel-item" style="background-image: url('some-image.jpg')">
    <h1>Click this button</h1>
    <button>Button</button>
</div>
```
```css
#myCarousel {
    padding-bottom: 40%: /* sets carousel height */
}
```

### JavaScript Options
Each carousel automatically slides to its next carousl-item every 5 seconds. To change this time, use the ```waitTime()``` function and pass it a number in milliseconds.
```javascript
$('#myCarousel')[0].waitTime(5000)
```
To stop a carousel from automatically sliding:
```javascript
$('#myCarousel')[0].stopAutoSlide()
```
Stack each slide on top of each other (good for phone screens):
```javascript
if($(window).width() < 768) {
    $('#myCarousel')[0].stackSlides()
}
```

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