Skip to content

Commit 5a71821

Browse files
committed
docs: update getting-started guide for improved usage example and configuration
1 parent 4a9201d commit 5a71821

File tree

1 file changed

+18
-23
lines changed

1 file changed

+18
-23
lines changed

docs/getting-started.md

Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -26,32 +26,27 @@ yarn add vue3-carousel
2626
## Basic Using
2727

2828
```vue
29-
<template>
30-
<carousel :items-to-show="1.5">
31-
<slide v-for="slide in 10" :key="slide">
32-
{{ slide }}
33-
</slide>
34-
35-
<template #addons>
36-
<navigation />
37-
<pagination />
38-
</template>
39-
</carousel>
40-
</template>
41-
42-
<script>
29+
<script setup>
4330
// If you are using PurgeCSS, make sure to whitelist the carousel CSS classes
44-
import 'vue3-carousel/dist/carousel.css'
31+
import 'vue3-carousel/carousel.css'
4532
import { Carousel, Slide, Pagination, Navigation } from 'vue3-carousel'
4633
47-
export default {
48-
name: 'App',
49-
components: {
50-
Carousel,
51-
Slide,
52-
Pagination,
53-
Navigation,
54-
},
34+
const carouselConfig = {
35+
itemsToShow: 2.5,
36+
wrapAround: true
5537
}
5638
</script>
39+
40+
<template>
41+
<Carousel v-bind="carouselConfig">
42+
<Slide v-for="slide in 10" :key="slide">
43+
<div class="carousel__item">{{ slide }}</div>
44+
</Slide>
45+
46+
<template #addons>
47+
<Navigation />
48+
<Pagination />
49+
</template>
50+
</Carousel>
51+
</template>
5752
```

0 commit comments

Comments
 (0)