Skip to content

Latest commit

 

History

History
68 lines (50 loc) · 1.6 KB

README.md

File metadata and controls

68 lines (50 loc) · 1.6 KB

Vue 3 Carousel

Modern lightweight Vue 3 carousel component

npm npm Package Quality

Documentation

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

Features

  • Responsive breakpoints
  • Mouse/touch dragging
  • Infinity scroll (wrapping around)
  • Auto play
  • Add classes for active and for visible slides
  • RTL
  • Enrich a11y
  • Vertical Slides

Nuxt Module

If you're using Nuxt and prefer to use it via module, please refer to vue3-carousel-nuxt

Getting started

Installation

First step is to install it using yarn or npm:

npm install vue3-carousel

# or use yarn
yarn add vue3-carousel

Basic Using

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

const config = {
  itemsToShow: 1.5
}
</script>

<template>
  <Carousel v-bind="config">
    <Slide v-for="slide in 10" :key="slide">
      {{ slide }}
    </Slide>

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