README.md

December 6, 2025 ยท View on GitHub

Vue 3 Carousel Logo

Vue 3 Carousel

Modern lightweight Vue 3 carousel component

npm npm Package Quality

โœจ 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

# npm
npm i vue3-carousel

# yarn
yarn add vue3-carousel

# pnpm
pnpm install vue3-carousel

๐Ÿ“– Basic Usage

<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 for detailed usage and examples:

๐Ÿ’š Nuxt Module

For Nuxt users, check out vue3-carousel-nuxt module.

๐ŸŒŸ Star History

Star History Chart