vue carousel

Carousel component for Vue.js.

188
34
Vue

vue-carousel

Coverage Status Downloads Version Gzip Size

Carousel component for Vue 3. For Vue 2, check out the v1 branch.

Main npm package files

dist/
├── vue-carousel.js         (UMD, default)
├── vue-carousel.min.js     (UMD, compressed)
├── vue-carousel.esm.js     (ECMAScript Module)
├── vue-carousel.esm.min.js (ECMAScript Module, compressed)
└── vue-carousel.d.ts       (TypeScript Declaration File)

Getting started

Installation

Using npm:

npm install vue@3 @chenfengyuan/vue-carousel@2

Using pnpm:

pnpm add vue@3 @chenfengyuan/vue-carousel@2

Using Yarn:

yarn add vue@3 @chenfengyuan/vue-carousel@2

Using CDN:

<script src="https://unpkg.com/vue@3"></script><!-- Vue.js is required -->
<script src="https://unpkg.com/@chenfengyuan/vue-carousel@2"></script>

Usage

import { createApp } from 'vue';
import VueCarousel from '@chenfengyuan/vue-carousel';

const app = createApp({});

app.component(VueCarousel.name, VueCarousel);
<vue-carousel :data="['Slide 1', 'Slide 2', 'Slide 3']"></vue-carousel>

Browser support

Same as Vue 3.

Versioning

Maintained under the Semantic Versioning guidelines.

License

MIT © Chen Fengyuan