vue3-carousel-demo
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

Vue 3 Carousel

Modern lightweight Vue 3 carousel component

npm npm

Documentation

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

TODO

  • [x] Responsive breakpoints
  • [x] Mouse/touch dragging
  • [x] Infinity scroll (wrapping around)
  • [x] Auto play
  • [x] Add classes for active and for visible slides
  • [ ] RTL
  • [ ] Vertical scroll
  • [ ] Sync multiple carousel
  • [ ] Enrich a11y

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

<template>
  <carousel :items-to-show="1.5">
    <slide v-for="slide in 10" :key="slide">
      {{ slide }}
    </slide>

    <template #addons>
      <navigation />
      <pagination />
    </template>
  </carousel>
</template>

<script>
// 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';

export default {
  name: 'App',
  components: {
    Carousel,
    Slide,
    Pagination,
    Navigation,
  },
};
</script>

Readme

Keywords

none

Package Sidebar

Install

npm i vue3-carousel-demo

Weekly Downloads

4

Version

1.0.3

License

MIT

Unpacked Size

58.5 kB

Total Files

21

Last publish

Collaborators

  • saulet