# kslider

> Ultra light jquery slider

Latest version **1.1.0** (published 2024-01-24) · ISC license · 0 weekly downloads

## Install

```sh
npm install kslider
pnpm add kslider
yarn add kslider
bun add kslider
```

## 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.0 |
| Published | 2024-01-24 |
| First published | 2019-01-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Steve Lebleu |
| Maintainers | konfer-be |
| Keywords | vanilla, javascript, jquery, slider, plugin |

## Links

- npm: https://www.npmjs.com/package/kslider
- Repository: https://github.com/steve-lebleu/kslider
- Homepage: https://github.com/steve-lebleu/kslider#readme
- Issues: https://github.com/steve-lebleu/kslider/issues
- npm.io page: https://npm.io/package/kslider

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2024-01-24
- 1.0.6 — 2021-04-01
- 1.0.5 — 2021-04-01
- 1.0.4 — 2019-08-27
- 1.0.3 — 2019-08-26
- 1.0.2 — 2019-08-26
- 1.0.1 — 2019-01-10

## README

# jQuery slider plugin

![Github action workflow status](https://github.com/steve-lebleu/kslider/actions/workflows/build.yml/badge.svg?branch=master)
[![CodeFactor](https://www.codefactor.io/repository/github/steve-lebleu/kslider/badge)](https://www.codefactor.io/repository/github/steve-lebleu/kslider)
![GitHub Release](https://img.shields.io/github/v/release/steve-lebleu/kslider?logo=Github)
[![GPL Licence](https://badges.frapsoft.com/os/gpl/gpl.svg?v=103)](https://opensource.org/licenses/gpl-license.php)

Simple jQuery > 3.1.1. slider plugin.
        
## > Demo

https://fabrik.konfer.be/kslider/

## > Page

Github page: https://steve-lebleu.github.io/kslider/

## > Install

``` bash 
> $ npm i kslider --save
```
## > How to use ?

In your HTML page, between <head> tags, retrieve styles:

``` html 
<link href="path_to_kslider_css" rel="stylesheet" type="text/css" />
```

In your HTML page, between <head> tags, retrieve jQuery and kslider :

``` html 
<script src="directory_of_your_jquery/jquery.js"></script>
<script src="directory_of_your_completer/jquery.kslider.js"></script>
```

Into your HTML code, place the following code and replace/add your own images :

``` html 
<div id="kslider-wrapper" class="kslider-wrapper">
  <ul class="kslider">
    <li class="active"><img src="img/item-1.jpg" alt="Damned, pirates are in the square" /></li>
    <li><img src="img/item-2.jpg" alt="Light rays penetrating the forest" /></li>
    <li><img src="img/item-3.jpg" alt="Mountains on the horizon" /></li>
    <li><img src="img/item-4.jpg" alt="Sunset on a lake" /></li>
  </ul>
</div>
```
 
Invoke the plugin :

``` javascript
$('.kslider').kslider({});
```

## > Options

Following options are available:

* **animationSpeed**: int, speed of the animation (ms)
* **pause**: int, duration of one slide transition (ms)
* **navigation**: boolean, using navigation
* **description**: boolean, display alt attribute as description
* **beforeDisplay**: function(e, hiddenElement), function, callback fired before display of image
* **afterDisplay**: function(e, visibleElement), function, callback fired after display of image
                
## > Licence

[GPL](https://opensource.org/licenses/gpl-license.php())

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