npm package: @signalchain/looped
Description: A 3kb Vanilla JS Carousel that scales with the browser.
Author: Todo
Latest version: 0.0.1

[![Maintenance Status][status-image]][status-url]
[![NPM][npm-img]][npm-url]
[![JavaScript Style Guide][jssg-img]][jssg-url]

# "Looped" Carousel

The _"bring your own styles"_, responsive/dynamic carousel for JavaScript. See examples in the [github](https://github.com/jameygleason/looped/tree/master/examples).

Exposes handy methods like `.next()` and `.prev()` on elements that can be easily wired to event handlers in the `onInit` method. 

An easy to configure object syntax allows you to override defaults setting with one line of code. (See defaults in the table below or in the [examples](https://github.com/jameygleason/looped/tree/master/examples).)


[![looped demo](docs/assets/demo.gif)](https://www.youtube.com/watch?v=vvPyo-rluss)

## Installation

`npm install looped`

or

`yarn add looped`



```html
<div class="carousel">
  <div>slide 1</div>
  <div>slide 2</div>
  <div>slide 3</div>
  <div>slide 4</div>
</div>
```

```js
import Carousel from 'looped';

// Will initialize with default settings
new Carousel({
  selector: '.carousel'
});
```

### Default settings

```js
new Carousel({
  selector: '.carousel',
  transitionDuration: 450,
  easing: 'ease-out',
  perPage: 1,
  gap: 0,
  startIndex: 0,
  draggable: true,
  multipleDrag: true,
  threshold: 20,
  loop: true,
  animate: true,
  intervalDuration: 4250,
  rtl: false,
  onInit: () => {},
  onChange: () => {},
  destroy: () => {},
});
```

### Responsive slide count

Pass an object to `perPage` and prefix window width with `w`. Since the default is 1, the properties are applied from narrowest window width to widest window width.

```js
const selector = '.carousel';
const carousel = document.querySelector(selector);
const config = {
  ...
  perPage: {
    // Falls back to the default of 1 below 750px
    w750: 3,
    w1200: 5,
    w1400: 6,
  },
  ...
}

const initCarousel = carousel &&
  new Carousel({
    selector,
    ...config,
  })

// Grab your buttons from the DOM
const prev = document.querySelector('.prev')
const next = document.querySelector('.next')

prev.addEventListener('click', () => {
  initCarousel.prev()
})

next.addEventListener('click', () => {
  initCarousel.next()
})

initCarousel()
```

## Available properties

Prop                 | Data Type  | Default   | Required  | Description
-------------------  | ---------- | --------- | -------   | -----------
selector           | String     | N/A       | true    | Enable selector
transitionDuration | Number     | 450     | false   | The time (in ms) between when the slide chip starts it's transition, to when it finishes moving.
easin             | String     | ease-out| false   | The "ease" value on the transition property.
perPage           | Number or Object | 1  | false   | The number of slides to be shown per page. See example for responsive carousel.
gap               | Number      | 0    | false   | The space between slides.
startIndex        | Number      | 0    | false   | The index of the starting index
draggable         | Boolean     | true | false   | Use dragging and touch swiping
multipleDrag      | Boolean     | true | false   | Allow dragging to move multiple slides.
threshold         | Number      | 20   | false   | How far you have to swipe/drag (in px) to go to the next slide.
loop              | Boolean     | true   | false | Enable slides to loop.
animate           | Boolean     | true   | false | Auto-play slides on load.
intervalDuration  | number      | 4250   | false | The amount of time between next slide call.
rtl               | Boolean     | false  | false   | Enables layout for languages written from right to left.
onInit             | Function   |          | false   | Runs immediately after initialization.
onChange           | Function   |          | false   | Runs after slide change.
destroy            | Function   |          | false   | Runs when carousel is unmounted.


## Common Gotchas

Gap throws off my image spacing. What gives?

Solution: Add this to your CSS

```css
html {
  box-sizing: border-box;
}

*, *:before, *:after {
  box-sizing: inherit;
  margin: 0;
  padding: 0;
}
```


## How to contribute

If you have unanswered questions, would like help with enhancing or debugging the plugin, reach out @ [jameygleason.com](https://jameygleason.com/).

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Credits

This carousel would not be possible without the fine work done on Siema.

* [pawelgrzybek/siema](https://github.com/pawelgrzybek/siema)

## NPM

https://www.npmjs.com/package/looped

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

[status-image]: https://img.shields.io/badge/status-maintained-brightgreen.svg
[status-url]: https://github.com/tleunen/looped.svg
[npm-img]: https://img.shields.io/npm/v/looped.svg
[npm-url]: https://www.npmjs.com/package/looped
[jssg-img]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[jssg-url]: https://standardjs.com