vueperslides/README.md

A touch ready and responsive slideshow for Vue 3 and 2.

# Vueper Slides

[![Latest Version on NPM](https://img.shields.io/npm/v/vueperslides.svg)](https://npmjs.com/package/vueperslides)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE.md)
[![npm](https://img.shields.io/npm/dt/vueperslides.svg)](https://www.npmjs.com/package/vueperslides)
[![npm](https://img.shields.io/npm/dw/vueperslides.svg)](https://www.npmjs.com/package/vueperslides)

> A touch ready and responsive slideshow / carousel for Vue 3 and 2.

## Installation

**Vue 3**
```
npm install vueperslides
```

**Vue 2**

```
npm install vueperslides@legacy
```

___


## Demo & Documentation
> [https://antoniandre.github.io/vueper-slides](https://antoniandre.github.io/vueper-slides)

## Try it yourself
> [https://codepen.io/antoniandre/pen/jevjoQ](https://codepen.io/antoniandre/pen/jevjoQ)

___


## Browser Support
![Chrome](https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) | ![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) | ![Safari](https://raw.github.com/alrra/browser-logos/master/src/safari/safari_48x48.png) | ![Opera](https://raw.github.com/alrra/browser-logos/master/src/opera/opera_48x48.png) | ![Edge](https://raw.github.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | ![IE](https://raw.github.com/alrra/browser-logos/master/src/archive/internet-explorer_9-11/internet-explorer_9-11_48x48.png) |
--- | --- | --- | --- | --- | --- |
Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | 11+ ✔ |


___


## Donation

If you want to support the project, you can buy me a beer or [become a sponsor](https://github.com/sponsors/antoniandre)!

[![paypal](https://www.paypalobjects.com/en_AU/i/btn/btn_donateCC_LG.gif)](https://www.paypal.me/antoniandre1)
Thank you!

If you are using this library for profit business, please consider [backing me](https://github.com/sponsors/antoniandre)!
It ensures that the project your products rely on keeps being actively maintained. :)

___


## Contributing

If you have any idea, feel free to fork Vueper Slides and submit your changes back to me or discuss it in an issue.


___


## Release Notes

- __Version 3.6__ Supports ES modules and default to it.
- __Version 3.0__ Supports Vue 3. This version is not compatible with Vue 2.x.
- __Version 2.8__ Added lazy loading feature
- __Version 2.7__ Added `duration` option on `<vueper-slide>` tag
- __Version 2.6__ Added `progress` option
- __Version 2.5__ Added `parallaxFixedContent` option
- __Version 2.4__ Added the `bullets` & `bullet` slots
- __Version 2.3__ Added `gap` option
- __Version 2.2__ Allow syncing 2 slideshows + added `previous` & `next` emitted events
- __Version 2.1__ Added `fractions` option
- __Version 2.0__ Allow new Vue slot syntax & other improvements
- __Version 1.21.0__ Allow external autoplay pause / resume
- __Version 1.20.0__ Option to prevent Y-axis scroll while dragging
- __Version 1.19.0__ Allow slide link on the entire slide
- __Version 1.18.0__ Emit mouseenter mouseleave events on slides
- __Version 1.16.0__ Change build system and external css file
- __Version 1.15.0__ Added `3D` Rotation feature
- __Version 1.14.0__ Allow fade transition with multiple items per slide
- __Version 1.13.0__ Allow multiple items per slide
- __Version 1.12.0__ Added a `no-shadow` class to remove default inner shadow
- __Version 1.11.0__ Allow slide background inside slide container
- __Version 1.10.0__ Allow fixed height
- __Version 1.9.4__ Added a method to refresh parallax
- __Version 1.9.1__ Add onload parallax translation calculation
- __Version 1.9.0__ Add `previous()` & `next()` methods for external controls
- __Version 1.8.0__ Add animated class while slideshow is animated
- __Version 1.7.0__ Improve slide data reactivity & allow to refresh clones on drag
- __Version 1.6.0__ Externalize CSS & add accessibility attributes
- __Version 1.5.0__ Add transition speed param & slide content outside above or under slideshow
- __Version 1.4.0__ Allow complex slide title & content
- __Version 1.3.2__ Add option to place arrows outside. The config is now VueJS-reactive
- __Version 1.3.0__ Add parallax feature
- __Version 1.2.0__ Add dragging distance feature
- __Version 1.1.0__ Add breakpoints feature
- __Version 1.0.0__ First public release