An open API service indexing awesome lists of open source software.

https://github.com/ismail9k/vue3-carousel

Vue 3 carousel component
https://github.com/ismail9k/vue3-carousel

carousel carousel-slider hacktoberfest hacktoberfest-2023 javascript slider vue vue3

Last synced: 3 months ago
JSON representation

Vue 3 carousel component

Awesome Lists containing this project

README

          


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

```bash
# npm
npm i vue3-carousel

# yarn
yarn add vue3-carousel

# pnpm
pnpm install vue3-carousel
```

## 📖 Basic Usage

```vue

// 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
}








```

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