https://github.com/fengyuanchen/vue-carousel

Carousel component for Vue.js.
https://github.com/fengyuanchen/vue-carousel

carousel vue vue-component vuejs

Last synced: about 16 hours ago
JSON representation

Carousel component for Vue.js.

• Host: GitHub
• URL: https://github.com/fengyuanchen/vue-carousel
• Owner: fengyuanchen
• License: mit
• Created: 2018-06-28T14:33:50.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2022-02-19T05:32:02.000Z (over 2 years ago)
• Last Synced: 2024-08-09T06:36:06.972Z (3 months ago)
• Topics: carousel, vue, vue-component, vuejs
• Language: Vue
• Homepage: https://fengyuanchen.github.io/vue-carousel/
• Size: 1.34 MB
• Stars: 188
• Watchers: 3
• Forks: 34
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vue-carousel

[![Coverage Status](https://img.shields.io/codecov/c/github/fengyuanchen/vue-carousel.svg)](https://codecov.io/gh/fengyuanchen/vue-carousel) [![Downloads](https://img.shields.io/npm/dm/@chenfengyuan/vue-carousel.svg)](https://www.npmjs.com/package/@chenfengyuan/vue-carousel) [![Version](https://img.shields.io/npm/v/@chenfengyuan/vue-carousel.svg)](https://www.npmjs.com/package/@chenfengyuan/vue-carousel) [![Gzip Size](https://img.shields.io/bundlephobia/minzip/@chenfengyuan/vue-carousel.svg)](https://unpkg.com/@chenfengyuan/vue-carousel/dist/vue-carousel.js)

> Carousel component for Vue 3. For Vue 2, check out the [`v1`](https://github.com/fengyuanchen/vue-carousel/tree/v1) branch.

- [Docs](src/README.md)

- [Demo](https://fengyuanchen.github.io/vue-carousel)

## Main npm package files

```text

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:

```shell

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

```

Using pnpm:

```shell

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

```

Using Yarn:

```shell

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

```

Using CDN:

```html

```

### Usage

```js

import { createApp } from 'vue';

import VueCarousel from '@chenfengyuan/vue-carousel';

const app = createApp({});

app.component(VueCarousel.name, VueCarousel);

```

```html

```

## Browser support

Same as Vue 3.

## Versioning

Maintained under the [Semantic Versioning guidelines](https://semver.org/).

## License

[MIT](https://opensource.org/licenses/MIT) © [Chen Fengyuan](https://chenfengyuan.com/)