Line

You are reading the unreleased docs (next). See latest (v0.9)

ui/client/features/wizard/workflows/Wizard

Cockpit client (features), next. Source: ui/client/features/wizard/workflows/Wizard.tsx.

Type Aliases#

WizardAction#

WizardAction = { type: "CONNECTED"; } | { type: "DISCONNECTED"; } | { type: "SOCKET_ERROR"; } | { event: ServerWizardEvent; type: "SERVER_EVENT"; } | { type: "START"; } | { text: string; type: "ANSWER_SENT"; } | { type: "CANCEL_SENT"; } | { type: "REVIEW_SENT"; }

Defined in: ui/client/features/wizard/workflows/Wizard.tsx:23


WizardState#

WizardState = object

Defined in: ui/client/features/wizard/workflows/Wizard.tsx:8

Properties#

awaitingAnswer

awaitingAnswer: boolean

Defined in: ui/client/features/wizard/workflows/Wizard.tsx:11

cancelling

cancelling: boolean

Defined in: ui/client/features/wizard/workflows/Wizard.tsx:17

expects?

optional expects?: PathExpectation

Defined in: ui/client/features/wizard/workflows/Wizard.tsx:13

Set while the open question wants a project path, so the UI can offer the picker.

messages

messages: ChatMessageData[]

Defined in: ui/client/features/wizard/workflows/Wizard.tsx:9

nextId

nextId: number

Defined in: ui/client/features/wizard/workflows/Wizard.tsx:14

reviewable

reviewable: boolean

Defined in: ui/client/features/wizard/workflows/Wizard.tsx:19

True once the wizard has written at least one file: a review can be asked for.

reviewing

reviewing: boolean

Defined in: ui/client/features/wizard/workflows/Wizard.tsx:20

status

status: WizardStatus

Defined in: ui/client/features/wizard/workflows/Wizard.tsx:10

steps

steps: WizardStep[]

Defined in: ui/client/features/wizard/workflows/Wizard.tsx:16

The framework's blocks in run order, one active at a time.

Variables#

initialWizardState#

const initialWizardState: WizardState

Defined in: ui/client/features/wizard/workflows/Wizard.tsx:33

Functions#

wizardReducer()#

wizardReducer(state, action): WizardState

Defined in: ui/client/features/wizard/workflows/Wizard.tsx:84

Parameters#

state

WizardState

action

WizardAction

Returns#

WizardState