v-slick-carousel
v0.5.0
Published
Vue Slick Carousel for Vue 3
Downloads
786
Maintainers
Readme
A Carousel component with TypeScript support and numerous features made for Vue 3.
Features
V Slick Carousel is a carousel component with TypeScript support and features including the following:
- Vue 3 suppoort (Vue 2 is not supported)
- Multiple slides per group
- Responsiveness
- Lazy loading
- Vertical mode
- Auto play
- Pagination
- Accessibility via keyboard navigation
- Right-to-left support
- SSR support
- Typescript support
See Why V Slick Carousel for more details.
Installation
npm install v-slick-carousel
See Installation for more details.
Quick Start
<template>
<div class="carousel">
<VSlickCarousel v-bind="settings">
<div>Slide 1</div>
<div>Slide 2</div>
<div>Slide 3</div>
</VSlickCarousel>
</div>
</template>
<script setup lang="ts">
import 'v-slick-carousel/style.css'
import { VSlickCarousel } from 'v-slick-carousel'
import type { Settings } from 'v-slick-carousel'
const settings: Settings = {
slidesToShow: 1
// ...
}
</script>
<style scoped>
.carousel {
padding: 28px;
}
</style>
Settings
See Settings.
Documentation
Check the docs website or the docs folder.
Contributing
We are grateful to the community for contributing bug fixes and improvements to V Slick Carousel. Read below to learn how you can take part in improving the project.
License
V Slick Carousel is open source and released under the MIT License.