Skip to content

ismail9k/vue3-carousel

Folders and files

NameName
Last commit message
Last commit date
Dec 11, 2024
Dec 18, 2024
Mar 15, 2025
Mar 14, 2025
Nov 29, 2024
Mar 14, 2025
Mar 14, 2025
Dec 11, 2024
Nov 4, 2024
Oct 1, 2022
Jan 23, 2022
Mar 14, 2025
Apr 28, 2023
Mar 14, 2025
Feb 18, 2025
Mar 14, 2025
Feb 9, 2025
Feb 18, 2025
Nov 29, 2024
Dec 11, 2024
Nov 4, 2024

Repository files navigation

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.