ui/client/features/wizard/hooks/useWizard

Cockpit client (features), v0.8. Source: ui/client/features/wizard/hooks/useWizard.tsx.

Functions#

useWizard()#

useWizard(): object

Defined in: ui/client/features/wizard/hooks/useWizard.tsx:30

Connects to ui/server's /ws/wizard endpoint and drives the whole chat/ connection flow through the pure wizardReducer.

Returns#

object

awaitingAnswer

awaitingAnswer: boolean = state.awaitingAnswer

input

input: string

messages

messages: ChatMessageData[] = state.messages

seedRoute

seedRoute: string

setInput

setInput: Dispatch<SetStateAction<string>>

setSeedRoute

setSeedRoute: Dispatch<SetStateAction<string>>

start

start: () => void

Returns

void

status

status: WizardStatus = state.status

submitAnswer

submitAnswer: (e) => void

Parameters

e

FormEvent

Returns

void