ui/client/features/tests/hooks/useStepEditor

Cockpit client (features), next. Source: ui/client/features/tests/hooks/useStepEditor.tsx.

Functions#

useStepEditor()#

useStepEditor(feature): object

Defined in: ui/client/features/tests/hooks/useStepEditor.tsx:13

The step editor for one feature's tests: open a test as a step document, edit its steps, review the diff, save. Every rule about what may be written lives on the server (and in core); the client only drafts and asks.

Parameters#

feature

string

Returns#

object

add

add: (kind) => void

Parameters

kind

"state" | "event" | "check-text"

Returns

void

back

back: () => void

Returns

void

close

close: () => void

Returns

void

confirm

confirm: () => Promise<void>

Returns

Promise<void>

discard

discard: () => void

Returns

void

move

move: (key, dir) => void

Parameters

key

number

dir

-1 | 1

Returns

void

open

open: (name) => Promise<void>

Parameters

name

string

Returns

Promise<void>

patch

patch: (key, patch) => void

Parameters

key

number

patch

Partial<StepFields>

Returns

void

remove

remove: (key) => void

Parameters

key

number

Returns

void

reopen

reopen: () => Promise<void>

Returns

Promise<void>

restore

restore: (key) => void

Parameters

key

number

Returns

void

review

review: () => Promise<void>

Returns

Promise<void>

select

select: (key) => void

Parameters

key

number

Returns

void

state

state: StepEditorState

view

view: { changes: number; problems: string[]; rows: StepRowView[]; } | null