使用说明
一个可组合的构建引导图尔斯通过重新锚定一个单一的弹出跨越步骤。
用法
使用自动导入的useTour可组合项,通过单个Popover(其锚在步骤之间移动)来驱动指导教程。可组合项拥有步骤状态,并将每个步骤的target解析为绑定到<UPopover>的reference,同时您可以完全控制内容和导航。
Dashboard
Overview of your workspace.
Profile
Manage your account.
Settings
Configure your preferences.
<script setup lang="ts">
const dashboard = useTemplateRef('dashboard')
const profile = useTemplateRef('profile')
const settings = useTemplateRef('settings')
const tour = useTour([
{
target: () => dashboard.value,
title: 'Welcome aboard',
body: 'The popover re-anchors to each target as you step through the tour.'
},
{
target: () => profile.value,
title: 'Make it yours',
body: 'You own the content and the buttons — no extra theme or locale to maintain.',
side: 'right' as const
},
{
target: () => settings.value,
title: 'You\'re all set',
body: 'Press Finish to close the tour.'
}
])
</script>
<template>
<div class="w-full space-y-4">
<div class="flex justify-end">
<UButton icon="i-lucide-wand-sparkles" @click="tour.start()">
Start tour
</UButton>
</div>
<div class="grid grid-cols-1 sm:grid-cols-3 gap-4">
<div ref="dashboard" class="p-4 rounded-lg border border-default bg-elevated/50">
<p class="font-medium text-highlighted">
Dashboard
</p>
<p class="text-sm text-muted">
Overview of your workspace.
</p>
</div>
<div ref="profile" class="p-4 rounded-lg border border-default bg-elevated/50">
<p class="font-medium text-highlighted">
Profile
</p>
<p class="text-sm text-muted">
Manage your account.
</p>
</div>
<div ref="settings" class="p-4 rounded-lg border border-default bg-elevated/50">
<p class="font-medium text-highlighted">
Settings
</p>
<p class="text-sm text-muted">
Configure your preferences.
</p>
</div>
</div>
<UPopover
:open="tour.open.value"
:reference="tour.reference.value"
:content="{ side: tour.current.value?.side, sideOffset: 8 }"
:dismissible="false"
arrow
>
<template #content>
<div class="p-4 max-w-xs space-y-2">
<div class="flex items-center justify-between gap-4">
<p class="font-semibold text-highlighted">
{{ tour.current.value?.title }}
</p>
<span class="text-xs text-muted tabular-nums">
{{ tour.index.value + 1 }} / {{ tour.total.value }}
</span>
</div>
<p class="text-sm text-muted">
{{ tour.current.value?.body }}
</p>
<div class="flex items-center justify-between pt-2">
<UButton
color="neutral"
variant="outline"
size="sm"
:disabled="!tour.hasPrev.value"
@click="tour.prev()"
>
Back
</UButton>
<UButton size="sm" @click="tour.next()">
{{ tour.hasNext.value ? 'Next' : 'Finish' }}
</UButton>
</div>
</div>
</template>
</UPopover>
</div>
</template>
<script setup lang="ts">
import { useTemplateRef } from 'vue'
const dashboard = useTemplateRef('dashboard')
const profile = useTemplateRef('profile')
const settings = useTemplateRef('settings')
const tour = useTour([
{
target: () => dashboard.value,
title: 'Welcome aboard',
body: 'The popover re-anchors to each target as you step through the tour.'
},
{
target: () => profile.value,
title: 'Make it yours',
body: 'You own the content and the buttons — no extra theme or locale to maintain.',
side: 'right' as const
},
{
target: () => settings.value,
title: 'You\'re all set',
body: 'Press Finish to close the tour.'
}
])
</script>
<template>
<div class="w-full space-y-4">
<div class="flex justify-end">
<UButton icon="i-lucide-wand-sparkles" @click="tour.start()">
Start tour
</UButton>
</div>
<div class="grid grid-cols-1 sm:grid-cols-3 gap-4">
<div ref="dashboard" class="p-4 rounded-lg border border-default bg-elevated/50">
<p class="font-medium text-highlighted">
Dashboard
</p>
<p class="text-sm text-muted">
Overview of your workspace.
</p>
</div>
<div ref="profile" class="p-4 rounded-lg border border-default bg-elevated/50">
<p class="font-medium text-highlighted">
Profile
</p>
<p class="text-sm text-muted">
Manage your account.
</p>
</div>
<div ref="settings" class="p-4 rounded-lg border border-default bg-elevated/50">
<p class="font-medium text-highlighted">
Settings
</p>
<p class="text-sm text-muted">
Configure your preferences.
</p>
</div>
</div>
<UPopover
:open="tour.open.value"
:reference="tour.reference.value"
:content="{ side: tour.current.value?.side, sideOffset: 8 }"
:dismissible="false"
arrow
>
<template #content>
<div class="p-4 max-w-xs space-y-2">
<div class="flex items-center justify-between gap-4">
<p class="font-semibold text-highlighted">
{{ tour.current.value?.title }}
</p>
<span class="text-xs text-muted tabular-nums">
{{ tour.index.value + 1 }} / {{ tour.total.value }}
</span>
</div>
<p class="text-sm text-muted">
{{ tour.current.value?.body }}
</p>
<div class="flex items-center justify-between pt-2">
<UButton
color="neutral"
variant="outline"
size="sm"
:disabled="!tour.hasPrev.value"
@click="tour.prev()"
>
Back
</UButton>
<UButton size="sm" @click="tour.next()">
{{ tour.hasNext.value ? 'Next' : 'Finish' }}
</UButton>
</div>
</div>
</template>
</UPopover>
</div>
</template>
每个步骤都需要一个target,以供弹出窗口锚定。它接受CSS选择器、元素、虚拟元素(任何包含getBoundingClientRect的元素)或返回其中之一的ref/getter。传递null以将步骤锚定到视口的中心。步骤上的任何其他字段(title、body、side...)都将原封不动地传递,并可通过current访问。
<script setup lang="ts">
const card = useTemplateRef('card')
const tour = useTour([
{ target: '#cta', title: 'Get started' },
{ target: () => card.value, title: 'Profile', side: 'right' },
{ target: null, title: 'All set' }
])
</script>
<template>
<UButton @click="tour.start()">Start tour</UButton>
<UPopover :open="tour.open.value" :reference="tour.reference.value" :dismissible="false">
<template #content>
<!-- your content + buttons -->
<UButton :disabled="!tour.hasPrev.value" @click="tour.prev()">Back</UButton>
<UButton @click="tour.next()">{{ tour.hasNext.value ? 'Next' : 'Finish' }}</UButton>
</template>
</UPopover>
</template>
- 基于Popover的反应式
reference道具而构建,因此当活动步骤发生变化时,Popover会平滑地重新定位。 - 当步骤变为活动状态时,活动目标自动滚动到视图中。
- 由于您自己呈现内容,因此无需维护额外的主题或区域设置。
应用程序接口
useTour(steps, options?)的字符串
参数
steps
MaybeRefOrGetter<TourStep[]> required
导览步骤的清单。可以是静态数组、
ref或反应式步骤的getter。target
MaybeRefOrGetter<string | ReferenceElement | null | undefined>
步骤所锚定的元素。接受CSS选择器(
'#id'、'.class'或解析为#id的bare id)、元素、虚拟元素或传回元素的ref/getter。使用null可将步骤置于视见区的中央。[key: string]
any
任何附加字段(
title、body、side、......)都将通过current传递并可用。options
UseTourOptions
教程的配置选项。
initialStep
number
导览开始的步骤索引。
loop
boolean
在最后一个步骤之后,循环回到第一个步骤。
scrollIntoView
boolean | ScrollIntoViewOptions
当步骤变为活动状态时,将目标滚动到视图中。
返回
open
Ref<boolean>
导览目前是否已开启。
index
Ref<number>
当前步长索引,钳制到步长范围。
current
ComputedRef<TourStep | undefined>
当前步骤对象,或者当没有步骤时为
undefined。reference
ComputedRef<ReferenceElement | undefined>
当前步骤的已解析锚点,要传递到
<UPopover :reference>。total
ComputedRef<number>
总步骤数。
hasNext
ComputedRef<boolean>
是否存在下一步。
hasPrev
ComputedRef<boolean>
上一个步骤是否存在。
start
(index?: number) => void
开启导览,选择性地在指定的索引处开启。
next
() => void
转到下一步。根据
loop选项,循环或结束。prev
() => void
转到上一步。
goTo
(index: number) => void
跳转到特定步骤并打开浏览。
finish
() => void
结束参观。