# jquery-slideshow

> Simple jquery slideshow library. Lightweight, responsive, easy to implement & configure.

Latest version **1.0.5** (published 2017-02-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install jquery-slideshow
pnpm add jquery-slideshow
yarn add jquery-slideshow
bun add jquery-slideshow
```

## 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.0.5 |
| Published | 2017-02-19 |
| First published | 2017-02-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Stephen O'Loughlin |
| Maintainers | sjoloughlin |
| Keywords | javascript, jquery, slideshow, slider, carousel, jquery slider |

## Links

- npm: https://www.npmjs.com/package/jquery-slideshow
- Repository: https://github.com/sjoloughlin/jquery-slideshow
- Homepage: https://github.com/sjoloughlin/jquery-slideshow#readme
- Issues: https://github.com/sjoloughlin/jquery-slideshow/issues
- npm.io page: https://npm.io/package/jquery-slideshow

## 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.5 (latest) — 2017-02-19
- 1.0.4 — 2017-02-10
- 1.0.3 — 2017-02-10
- 1.0.2 — 2017-02-09
- 1.0.1 — 2017-02-08
- 1.0.0 — 2017-02-08

## README

# jQuery Slideshow

Simple jQuery slideshow library. Lightweight, responsive, easy to implement & configure.

<a href="http://standardjs.com"><img src="https://camo.githubusercontent.com/58fbab8bb63d069c1e4fb3fa37c2899c38ffcd18/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64655f7374796c652d7374616e646172642d627269676874677265656e2e737667" alt="Standard - JavaScript Style Guide" data-canonical-src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" style="max-width:100%;"></a> [![npm version](https://badge.fury.io/js/jquery-slideshow.svg)](https://badge.fury.io/js/jquery-slideshow)

## Demo

[http://www.sjoloughlin.com/jquery-slideshow](http://www.sjoloughlin.com/jquery-slideshow)

## Installation

#### Download

Get the latest release from the [releases](https://github.com/sjoloughlin/jquery-slideshow/releases) page and add the files to your project.

Link the stylesheet inside your ```<head>``` tag:
```html
<link rel="stylesheet" type="text/css" href="slider.min.css" />
```
Then, before your closing ```<body>``` tag add:

```html
<script type="text/javascript" src="slider.min.js"></script>
```

#### NPM

```sh
npm install jquery-slideshow
```

## Usage

Add the following HTML for the slider:

```html
<ul class="slider">
  <li>
    <img src="img/slide1.jpg" alt="slide1"/>
  </li>
  <li>
    <img src="img/slide2.jpg" alt="slide2"/>
  </li>
  <li>
    <img src="img/slide3.jpg" alt="slide3"/>
  </li>
</ul>
```

Then, before your closing ```<body>``` call ```.slider()``` on the slider element:

```html
<script type="text/javascript">
  $(window).on("load", function() {
    $(".slider").slider();
  });
</script>
```

## Configuration

The slider is configurable by passing in a configuration object when calling ```.slider()``` on the slider element:
```html
<script type="text/javascript">
  $(window).on("load", function() {
    $(".slider").slider({
      width  : '1024px', // Width of the slider
      height : '500px',  // Height of the slider
      speed  : 2000,     // How long the slide animation transition lasts for in millisecond
      delay  : 5000      // How long the slide will be displayed for in milliseconds
    });
  });
</script>
```

#### Options

| Config | Type | Default |  Description |
|--------|------|---------|--------------|
|`speed`|`int`|`1000`|How long the slide animation transition lasts for in milliseconds *e.g. 1000 = 1 second*|
|`delay`|`int`|`3000`|How long the slide will be displayed for in milliseconds *e.g. 3000 = 3 seconds*|
|`autoplay`|`boolean`|`true`|Whether to start the slideshow automatically|
|`navigation`|`boolean`|`true`|Whether to display left/right navigation buttons|
|`pagination`|`boolean`|`true`|Whether to display clickable slide indicators|
|`width`|`string`|`100%`|Width of the slider|
|`height`|`string`|`auto`|Height of the slider|
|`direction`|`string`|`right`|The direction that the slider will slide|
|`responsive`|`boolean`|`true`|Whether to make the size of the slider responsive|

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

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