# brg-slider

> Slider micro-library using only vanilly javascript

Latest version **1.1.4** (published 2019-02-12) · ISC license · 0 weekly downloads

## Install

```sh
npm install brg-slider
pnpm add brg-slider
yarn add brg-slider
bun add brg-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.4 |
| Published | 2019-02-12 |
| First published | 2018-08-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ben Greene |
| Maintainers | benrgreene |
| Keywords | slider, vanilla, js |

## Links

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

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.1.4 (latest) — 2019-02-12
- 1.1.3 — 2019-02-11
- 1.1.2 — 2018-12-12
- 1.1.1 — 2018-09-11
- 1.1.0 — 2018-09-11
- 1.0.1 — 2018-08-19
- 1.0.0 — 2018-08-19

## README

# Slider Micro Library

## Installing

```
npm install brg-slider
```

## Use

First, you'll need to require the slider:

```
const sliderLibrary = require('brg-slider')
```

Then to use, simple use the command:

```
sliderLibrary.newSlider({
  ... options ...
});
```

Slides can have whatever in them, images, HTML, anything. All direct children of the slider should have the class "slide". If your slider selector is `#my-slider`, then the HTML structure of the slider should be:

```
<div id="my-slider">
  <div class="slide"> ... </div>
  ...
  <div class="slide"> ... </div>
</div>
```  

## Options

* slider: selector of the slider container (required)
* hasDots: whether to add dots to the slider container (default: true)
* dotColor: color of the dot representing the active slide (optional)
* hasArrows: whether or not to add arrows to the slider container (default: true)
* variableHeight: whether the slider height adapts to the visible child. If this is set to false, then you'll need to set the height yourself. (default: true). 
* timer: amount of time on a slide before moving along. Not passing a time means there is no timer. (optional)
* leftArrowContent: the HTML content for the left arrow (optional, defaults to arrow)
* rightArrowContent: the HTML content for the right arrow (optional, defaults to arrow)

## Custom Events

This slider mirco library introduces a new event, `slideMoved`. It is added to the document, and is fired when a slide is moved. Here's an example:

```
document.addEventListener("slideMoved", (event) => {
  console.log('The slider switched slides!');
});
```

It's also possible to use the event objects `detail` property to get the following information about the event:

* slide (the slide element moved to)
* direction (the direction moved to get to the slide)
* index (index of the new slide in its slider)

Here's an example of using the detail property to print out the current slide:

```
document.addEventListener("slideMoved", (event) => {
  console.log(`new index: ${event.detail.index}.`);
});
```

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