TourItem
@dopt/vue / Exports / TourItem
Interface: TourItem
TourItem generally follows the card interface
specified in @dopt/semantic-data-layer-tour.
However, it exposes Refs where possible
to allow built-in reactivity.
Table of contents
Properties
Properties
id
• id: Ref<string>
Defined in
packages/@dopt/vue/src/tour.ts:20
index
• index: Ref<undefined | null | number>
Defined in
packages/@dopt/vue/src/tour.ts:21
title
• title: Ref<undefined | null | string>
Defined in
packages/@dopt/vue/src/tour.ts:22
body
• body: Ref<undefined | null | Children>
Defined in
packages/@dopt/vue/src/tour.ts:23
nextLabel
• nextLabel: Ref<undefined | null | string>
Defined in
packages/@dopt/vue/src/tour.ts:24
backLabel
• backLabel: Ref<undefined | null | string>
Defined in
packages/@dopt/vue/src/tour.ts:25
active
• active: Ref<boolean>
Defined in
packages/@dopt/vue/src/tour.ts:26
completed
• completed: Ref<boolean>
Defined in
packages/@dopt/vue/src/tour.ts:27
tour
• tour: Ref<() => undefined | Tour>
Defined in
packages/@dopt/vue/src/tour.ts:28
next
• next: () => void
Type declaration
▸ (): void
Returns
void
Defined in
packages/@dopt/vue/src/tour.ts:29
back
• back: () => void
Type declaration
▸ (): void
Returns
void
Defined in
packages/@dopt/vue/src/tour.ts:30
field
• field: Ref<<V>(name: string) => undefined | null | V>
Use this to access custom fields on the tour item.