Skip to content

Commit bce2407

Browse files
committed
Update documentation.
1 parent d2a7f3e commit bce2407

File tree

1 file changed

+30
-17
lines changed

1 file changed

+30
-17
lines changed

src/documentation/index.vue

+30-17
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,8 @@
156156
:pause-on-hover="pauseOnHover"
157157
@autoplay-pause="internalAutoPlaying = false"
158158
@autoplay-resume="internalAutoPlaying = true")
159-
v-icon(slot="pause-icon" large color="white") pause_circle_outline
159+
template(v-slot:pause-icon)
160+
v-icon(large color="white") pause_circle_outline
160161
vueper-slide(v-for="(slide, i) in slides1" :key="slide.id" :title="slide.title" :content="slide.content" :style="'background-color: ' + colors[i % 4]")
161162

162163
.subtitle-1.mt-6 Basic autoplay (with pause on mouseover) source code:
@@ -167,7 +168,9 @@
167168
:title="slide.title"
168169
:content="slide.content"
169170
:style="'background-color: ' + colors[i % 4]"></vueper-slide>
170-
<i slot="pause-icon" class="icon pause_circle_outline"></i>
171+
<template v-slot:pause-icon>
172+
<i class="icon pause_circle_outline"></i>
173+
</template>
171174
</vueper-slides>
172175

173176
.subtitle-1 This example full source code:
@@ -190,7 +193,9 @@
190193
:title="slide.title"
191194
:content="slide.content"
192195
:style="'background-color: ' + colors[i % 4]"></vueper-slide>
193-
<i slot="pause-icon" class="icon pause_circle_outline"></i>
196+
<template v-slot:pause-icon>
197+
<i class="icon pause_circle_outline"></i>
198+
</template>
194199
</vueper-slides>
195200
ssh-pre(language="js" label="Vue JS component").
196201
data: () => ({
@@ -215,13 +220,19 @@
215220
The bullets are showing slide indexes which is disabled by default.#[br]
216221
You can also disable arrows and/or bullets. E.g. #[span.code :arrows="false"], #[span.code :bullets="false"]
217222
vueper-slides.ex--arrows-and-bullets(:infinite="false" :bullets-outside="true")
218-
v-icon(slot="arrow-left" color="white" x-large) undo
219-
v-icon(slot="arrow-right" color="white" x-large) redo
223+
template(v-slot:arrow-left)
224+
v-icon(color="white" x-large) undo
225+
template(v-slot:arrow-right)
226+
v-icon(color="white" x-large) redo
220227
vueper-slide(v-for="(slide, i) in slides1" :key="slide.id" :title="slide.title" :content="slide.content" :style="'background-color: ' + colors[(i + 1) % 4]")
221228
ssh-pre(language="html-vue" label="HTML Vue Template").
222229
<vueper-slides :infinite="false" :bullets-outside="true">
223-
<v-icon slot="arrow-left" color="white" large>arrow_left</v-icon>
224-
<v-icon slot="arrow-right" color="white" large>arrow_right</v-icon>
230+
<template v-slot:arrow-left>
231+
<i class="icon icon-arrow-left"></i>
232+
</template>
233+
<template v-slot:arrow-right>
234+
<i class="icon icon-arrow-right"></i>
235+
</template>
225236
<vueper-slide
226237
v-for="(slide, i) in slides"
227238
:key="slide.id"
@@ -344,15 +355,15 @@
344355
:key="i"
345356
:style="'background-color: ' + ['#ff5252', '#42b983'][i % 2]">
346357
<template v-slot:slide-content>
347-
<v-icon color="white">check</v-icon>
358+
<i class="icon icon-check"></i>
348359
Complex content with Vue.js {{ "\{\{ 1 === 1 ? 'interpreted' : 'non-interpreted' \}\}" }} compilable content & <span v-pre>{{ '\{\{ mustaches \}\}' }}</span>.
349360
</template>
350361
</vueper-slide>
351362
</vueper-slides>
352363
highlight(type="info")
353364
ul.my-0
354-
li if both #[span.code :title="..."] and #[span.code slot="slide-title"] are provided, the title slot will be displayed.
355-
li if both #[span.code :content="..."] and #[span.code slot="slide-content"] are provided, the content slot will be displayed.
365+
li if both #[span.code :title="..."] and #[span.code v-slot:slide-title] are provided, the title slot will be displayed.
366+
li if both #[span.code :content="..."] and #[span.code v-slot:slide-content] are provided, the content slot will be displayed.
356367

357368
h3
358369
a(href="#ex--updating-content") Updating Content Inside/Outside
@@ -380,9 +391,9 @@
380391
vueper-slides.ex--updating-content(
381392
:slide-ratio="1/4"
382393
autoplay
394+
always-refresh-clones
383395
:slide-content-outside="contentPosition === 'false' ? false : contentPosition"
384-
slide-content-outside-class="text-center py-4"
385-
:refresh-clones-on-drag="true")
396+
slide-content-outside-class="text-center py-4")
386397
vueper-slide(v-for="(slide, i) in slides4" :key="i" :style="'background-color: ' + ['#42b983', '#ff5252'][i % 2]")
387398
template(v-slot:slide-content)
388399
v-layout(align-center justify-center)
@@ -399,15 +410,15 @@
399410
:title="slide.title"
400411
:content="slide.content"
401412
:style="'background-color: ' + ['#42b983', '#ff5252'][i % 2]">
402-
<div slot="slide-content">
413+
<template slot:slide-content>
403414
<v-layout">
404415
<v-icon>access_time</v-icon>
405416
<div>
406417
<div>{{ '\{\{ slide.title \}\}' }}</div>
407418
<div>{{ '\{\{ slide.content \}\}' }}</div>
408419
</div>
409420
</v-layout>
410-
</div>
421+
</template>
411422
</vueper-slide>
412423
</vueper-slides>
413424

@@ -898,7 +909,7 @@
898909
transitionSpeed: [Number, String], default: 600
899910
pauseOnHover: [Boolean], default: true
900911
infinite: [Boolean], default: true
901-
refreshClonesOnDrag: [Boolean], default: false
912+
alwaysRefreshClones: [Boolean], default: false
902913
parallax: [Boolean, Number], default: false
903914
touchable: [Boolean], default: true
904915
preventYScroll: [Boolean], default: false
@@ -1036,12 +1047,12 @@
10361047
as a fade transition slideshow does not need such effect.
10371048

10381049
li
1039-
| #[code refreshClonesOnDrag], #[strong.mr-1 Type:] #[span.code.mr-1 [Boolean]], #[strong.mr-1 Default:] #[span.code false]
1050+
| #[code alwaysRefreshClones], #[strong.mr-1 Type:] #[span.code.mr-1 [Boolean]], #[strong.mr-1 Default:] #[span.code false]
10401051
p.
10411052
With #[span.code infinite] mode on and sliding transitions, the clones
10421053
(#[a(href="#what-are-clones" @click="onWhatAreClonesClick") What are clones?]) are created with a copy of content at
10431054
the time it's created.#[br]Your content can get outdated if you have a fast #[span.code setInterval]
1044-
operating on content (E.g. a clock).#[br]Set #[span.code refreshClonesOnDrag] to
1055+
operating on content (E.g. a clock).#[br]Set #[span.code alwaysRefreshClones] to
10451056
#[span.code true] if you want to keep updating clones before you see them while you drag.
10461057
highlight(type="success").
10471058
By default this parameter is disabled to save up operations. In most cases you should
@@ -1393,8 +1404,10 @@
13931404
li If both slide-title slot and title attribute are provided now use the slot.
13941405
li If both slide-content slot and content attribute are provided now use the slot.
13951406
li Improved autoplay pause & resume - manual slide does not resume if paused.
1407+
li Removed #[span.code refreshClonesOnDrag] option and introduced #[span.code alwaysRefreshClones].
13961408
li TODO: update clones on content/title slots update
13971409
li TODO: update all examples with new slots syntax
1410+
li TODO: document alwaysRefreshClones
13981411

13991412
li.mt-6
14001413
strong Version 1.16.0

0 commit comments

Comments
 (0)