Skip to main content

HintsItem

@dopt/vue / Exports / HintsItem

Interface: HintsItem

HintsItem generally follows the card interface specified in @dopt/semantic-data-layer-hints. 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/hints.ts:23


index

index: Ref<undefined | null | number>

Defined in

packages/@dopt/vue/src/hints.ts:24


title

title: Ref<undefined | null | string>

Defined in

packages/@dopt/vue/src/hints.ts:25


body

body: Ref<undefined | null | Children>

Defined in

packages/@dopt/vue/src/hints.ts:26


completeLabel

completeLabel: Ref<undefined | null | string>

Defined in

packages/@dopt/vue/src/hints.ts:27


dismissAllLabel

dismissAllLabel: Ref<undefined | null | string>

Defined in

packages/@dopt/vue/src/hints.ts:28


active

active: Ref<boolean>

Defined in

packages/@dopt/vue/src/hints.ts:29


completed

completed: Ref<boolean>

Defined in

packages/@dopt/vue/src/hints.ts:30


dismissed

dismissed: Ref<boolean>

Defined in

packages/@dopt/vue/src/hints.ts:31


hints

hints: Ref<() => undefined | Hints>

Defined in

packages/@dopt/vue/src/hints.ts:32


complete

complete: () => void

Type declaration

▸ (): void

Returns

void

Defined in

packages/@dopt/vue/src/hints.ts:33


dismiss

dismiss: () => void

Type declaration

▸ (): void

Returns

void

Defined in

packages/@dopt/vue/src/hints.ts:34


field

field: Ref<<V>(name: string) => undefined | null | V>

Use this to access custom fields on the hints item.

Defined in

packages/@dopt/vue/src/hints.ts:38