Tour
Interface: Tour
Tour 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:44
active
• active: Ref<boolean>
Defined in
packages/@dopt/vue/src/tour.ts:45
completed
• completed: Ref<boolean>
Defined in
packages/@dopt/vue/src/tour.ts:46
dismissed
• dismissed: Ref<boolean>
Defined in
packages/@dopt/vue/src/tour.ts:47
size
• size: Ref<number>
Defined in
packages/@dopt/vue/src/tour.ts:48
complete
• complete: () => void
Type declaration
▸ (): void
Returns
void
Defined in
packages/@dopt/vue/src/tour.ts:49
dismiss
• dismiss: () => void
Type declaration
▸ (): void
Returns
void
Defined in
packages/@dopt/vue/src/tour.ts:50
items
• items: Ref<() => TourItem[]>
Defined in
packages/@dopt/vue/src/tour.ts:51
filter
• filter: Ref<(on: FilterableField) => TourItem[]>
Defined in
packages/@dopt/vue/src/tour.ts:52
count
• count: Ref<(where: FilterableField) => number>
Defined in
packages/@dopt/vue/src/tour.ts:53
field
• field: Ref<<V>(name: string) => undefined | null | V>
Use this to access custom fields on the tour.