# vue3-carousel

> A simple carousel component for Vue 3

Latest version **0.19.0** (published 2026-10-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue3-carousel
pnpm add vue3-carousel
yarn add vue3-carousel
bun add vue3-carousel
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.19.0 |
| Published | 2026-10-03 |
| First published | 2020-04-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Abdelrahman Ismail |
| Maintainers | abdelrahman3d, ismail9k |
| Keywords | vue, vue3, carousel, slider, vue3-carousel, vue3-slider |

## Links

- npm: https://www.npmjs.com/package/vue3-carousel
- Repository: https://github.com/ismail9k/vue3-carousel
- Homepage: https://github.com/ismail9k/vue3-carousel#readme
- Issues: https://github.com/ismail9k/vue3-carousel/issues
- npm.io page: https://npm.io/package/vue3-carousel

## 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

- 0.19.0 (latest) — 2026-10-03
- 0.17.0 — 2025-10-26
- 0.16.0 — 2025-06-11
- 0.15.1 — 2025-05-03
- 0.15.0 — 2025-03-14
- 0.14.0 — 2025-02-09
- 0.13.0 — 2025-01-15
- 0.12.0 — 2024-12-26
- 0.11.0 — 2024-12-23
- 0.10.0 — 2024-12-16
- 0.9.0 — 2024-12-09
- 0.8.1 — 2024-11-26
- 0.8.0 — 2024-11-24
- 0.7.1 — 2024-11-17
- 0.7.0 — 2024-11-17
- … 68 more at https://npm.io/package/vue3-carousel/versions

## README

<p align="center">
  <img src="docs/public/vue3-carousel-logo-light.svg" width="200" alt="Vue 3 Carousel Logo">
</p>

<h1 align="center">Vue 3 Carousel</h1>

<p align="center">
Modern lightweight Vue 3 carousel component
</p>

<p align="center">
  <a href="https://npm-stat.com/charts.html?package=vue3-carousel"><img src="https://img.shields.io/npm/dm/vue3-carousel.svg" alt="npm"/></a>
  <a href="https://www.npmjs.com/package/vue3-carousel"><img src="https://img.shields.io/npm/v/vue3-carousel.svg" alt="npm"/></a>
  <a href="https://packagequality.com/#?package=vue3-carousel"><img src="https://packagequality.com/shield/vue3-carousel.svg" alt="Package Quality"/></a>
</p>

## ✨ Features

- 📱 **Responsive** - Breakpoints support
- 🔄 **Infinite Scroll** - Wrap around sliding
- 🖱️ **Mouse/Touch** - Dragging support
- 🖲️ **Mouse Wheel** - Scroll navigation support
- ⚡ **Auto Play** - Automatic sliding
- 🎯 **Slide Classes** - Active & visible states
- 🌐 **RTL** - Right-to-left support
- ♿ **A11y** - Keyboard navigation & ARIA labels
- 📊 **Vertical** - Vertical sliding mode

## 🚀 Installation

```bash
# npm
npm i vue3-carousel

# yarn
yarn add vue3-carousel

# pnpm
pnpm install vue3-carousel
```

## 📖 Basic Usage

```vue
<script setup>
// If you are using PurgeCSS, make sure to whitelist the carousel CSS classes
import 'vue3-carousel/carousel.css'
import { Carousel, Slide, Pagination, Navigation } from 'vue3-carousel'

const carouselConfig = {
  itemsToShow: 2.5,
  wrapAround: true
}
</script>

<template>
  <Carousel v-bind="carouselConfig">
    <Slide v-for="slide in 10" :key="slide">
      <div class="carousel__item">{{ slide }}</div>
    </Slide>

    <template #addons>
      <Navigation />
      <Pagination />
    </template>
  </Carousel>
</template>
```

## 📚 Documentation

Visit our [documentation website](https://vue3-carousel.ismail9k.com/) for detailed usage and examples:

- [Getting Started](https://vue3-carousel.ismail9k.com/getting-started)
- [Carousel Configuration](https://vue3-carousel.ismail9k.com/config)
- [Carousel Component](https://vue3-carousel.ismail9k.com/components/carousel)
- [Slide Component](https://vue3-carousel.ismail9k.com/components/slide)
- [Navigation Component](https://vue3-carousel.ismail9k.com/components/navigation)
- [Pagination Component](https://vue3-carousel.ismail9k.com/components/pagination)

## 💚 Nuxt Module

For Nuxt users, check out [vue3-carousel-nuxt](https://github.com/gaetansenn/vue3-carousel-nuxt) module.

## 🤖 For AI agents

The documentation is also published as Markdown: [`llms.txt`](https://vue3-carousel.ismail9k.com/llms.txt) indexes every page (each also served at its `.md` URL), and [`llms-full.txt`](https://vue3-carousel.ismail9k.com/llms-full.txt) holds all of it in one file.

## 🌟 Star History

<picture>
  <source
    media="(prefers-color-scheme: dark)"
    srcset="
      https://api.star-history.com/svg?repos=ismail9k/vue3-carousel&type=Date&theme=dark
    "
  />
  <source
    media="(prefers-color-scheme: light)"
    srcset="
      https://api.star-history.com/svg?repos=ismail9k/vue3-carousel&type=Date
    "
  />
  <img
    alt="Star History Chart"
    src="https://api.star-history.com/svg?repos=ismail9k/vue3-carousel&type=Date"
  />
</picture>

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