You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[x] Add classes for active and for visible slides
22
-
-[x] RTL
23
-
-[x] Enrich a11y
24
-
-[x] Vertical Slides
25
-
26
-
## Nuxt Module
27
-
28
-
If you're using Nuxt and prefer to use it via module, please refer to [vue3-carousel-nuxt](https://github.com/gaetansenn/vue3-carousel-nuxt?tab=readme-ov-file)
17
+
## ✨ Features
29
18
30
-
## Getting started
19
+
- 📱 **Responsive** - Breakpoints support
20
+
- 🔄 **Infinite Scroll** - Wrap around sliding
21
+
- 🖱️ **Mouse/Touch** - Dragging support
22
+
- ⚡ **Auto Play** - Automatic sliding
23
+
- 🎯 **Slide Classes** - Active & visible states
24
+
- 🌐 **RTL** - Right-to-left support
25
+
- ♿ **A11y** - Keyboard navigation & ARIA labels
26
+
- 📊 **Vertical** - Vertical sliding mode
31
27
32
-
### Installation
33
-
34
-
First step is to install it using `yarn` or `npm`:
28
+
## 🚀 Installation
35
29
36
30
```bash
37
-
npm install vue3-carousel
31
+
# npm
32
+
npm i vue3-carousel
38
33
39
-
#or use yarn
34
+
# yarn
40
35
yarn add vue3-carousel
36
+
37
+
# pnpm
38
+
pnpm install vue3-carousel
41
39
```
42
40
43
-
### Basic Using
41
+
##📖 Basic Usage
44
42
45
43
```vue
46
44
<script setup>
47
45
// If you are using PurgeCSS, make sure to whitelist the carousel CSS classes
48
-
import 'vue3-carousel/dist/carousel.css'
46
+
import 'vue3-carousel/carousel.css'
49
47
import { Carousel, Slide, Pagination, Navigation } from 'vue3-carousel'
50
48
51
-
const config = {
52
-
itemsToShow: 1.5
49
+
const carouselConfig = {
50
+
itemsToShow: 2.5,
51
+
wrapAround: true
53
52
}
54
53
</script>
55
54
56
55
<template>
57
-
<Carousel v-bind="config">
56
+
<Carousel v-bind="carouselConfig">
58
57
<Slide v-for="slide in 10" :key="slide">
59
-
{{ slide }}
58
+
<div class="carousel__item">{{ slide }}</div>
60
59
</Slide>
61
60
62
61
<template #addons>
@@ -66,3 +65,17 @@ const config = {
66
65
</Carousel>
67
66
</template>
68
67
```
68
+
69
+
## 📚 Documentation
70
+
71
+
Visit our [documentation website](https://vue3-carousel.ismail9k.com/) for detailed usage and examples:
0 commit comments