# before-after-slider

> BeforeAfterSlider is a lightweight Javascript library without any dependencies, to compare images in before/after view.轻量级JS库，轻松简单实现图片Before/After效果。

Latest version **1.0.1** (published 2019-08-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install before-after-slider
pnpm add before-after-slider
yarn add before-after-slider
bun add before-after-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.0.1 |
| Published | 2019-08-30 |
| First published | 2019-08-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 56.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 43 |
| Author | vincentfong |
| Maintainers | vincentfong |
| Keywords | javascript, before, after, slider, before, after, imgages, simple, no, dependencies |

## Links

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

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2019-08-30
- 1.0.0 — 2019-08-30

## README

# BeforeAfterSlider

![](https://img.shields.io/badge/language-ES6-yellow.svg) [![NPM Version](https://img.shields.io/npm/v/before-after-slider.svg)](https://www.npmjs.com/package/before-after-slider) [![LICENSE](https://img.shields.io/npm/l/@eteplus/typeof.svg)](https://github.com/VincentTV/before-after-slider/blob/master/LICENSE) [![](https://img.shields.io/badge/Blog-vincef0ng.cn-brightgreen.svg)](https://vincef0ng.cn)

###### [中文 README](README-zh_CN.md)

BeforeAfterSlider is a lightweight Javascript library without any dependencies, to compare images in before/after view.

- Support mousemove & touchmove.
- Lightweight, only 9KB.
- Adaptive width.
- Custom image, size & slider etc.
- Adaptive centering without any CSS.
- API simple and easy to use.

![](https://cdn.jsdelivr.net/gh/VincentTV/CDN@master/post/before-after-slider/slider.gif)

## Demo
Online demo is available on the [Github page](https://vincenttv.github.io/before-after-slider/example).

***

## Getting Started

* Support:
    * Direct `<script>` include.
    * NPM install.
    * Compatible ES6(ES2015) ,CommonJS & AMD modules.

### Direct `<script>` include

CDN:
```html
<script src="https://cdn.jsdelivr.net/npm/before-after-slider@1.0.0/dist/slider.bundle.js"></script>
```

If you use ES Modules, you can include by this：
```html
<script type="module">
  import SliderBar from "https://cdn.jsdelivr.net/npm/before-after-slider@1.0.0/dist/slider.bundle.js";
</script>
```

Using:
```html
<div id="mySlider"></div>

<script>
  new SliderBar({
    el: '#mySlider',            // The container, required
    beforeImg: './before.jpg',  // before image, required
    afterImg: './after.jpg',    // after image, required
    width: "90%",               // slide-wrap width, default 100%
    height: "400px",            // slide-wrap height, default image-height
    line: false,                 // Dividing line, default true
    lineColor: "rgba(0,0,0,0.5)" // Dividing line color, default rgba(0,0,0,0.5)
  });
</script>
```


### NPM install

```shell
npm install before-after-slider --save
```

**Vue for example**

```html
<template>
  <div id="app">
    <!-- container -->
    <div id="mySlider"></div>
  </div>
</template>

<script>
import SliderBar from 'before-after-slider'; // import
export default {
  name: 'app',
  mounted() {
    // new SliderBar({options});
    new SliderBar({
      el: '#mySlider',
      beforeImg: './before.jpg',
      afterImg: './after.jpg'
    });
  }
}
</script>
```

## Options

| Option        | Type     | defalut             | Description                     |
| :------------ | :------- | :------------------ | :------------------------------ |
| el            | String   | required            | The container, "#sliderId"      |
| beforeImg     | String   | required            | before-image URL                |
| afterImg      | String   | required            | after-image URL                 |
| width         | String   | '100%'              | slide-wrap width,(%,px,em,rem)  |
| height        | String   | none                | slide-wrap height               |
| line          | Boolean  | true                | Dividing line                   |
| lineColor     | String   | 'rgba(0, 0, 0, .5)' | Dividing line color             |

## By the way

**Make sure the two images are the same size.**

**🤪AND Welcome to visit my blog.🤪 [https://vincef0ng.cn](https://vincef0ng.cn/)**

## How to Contribute

Anyone and everyone is welcome to contribute to this project. The best way to start is by checking our [open issues](https://github.com/VincentTV/before-after-slider/issues),[submit a new issues](https://github.com/VincentTV/before-after-slider/issues/new?labels=bug) or [feature request](https://github.com/VincentTV/before-after-slider/issues/new?labels=enhancement), participate in discussions, upvote or downvote the issues you like or dislike.

## License

[**The MIT License**](http://opensource.org/licenses/MIT).

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