ui/client/features/workflows/hooks/useWorkflows
Cockpit client (features), v0.9. Source: ui/client/features/workflows/hooks/useWorkflows.tsx.
Functions#
useWorkflows()#
useWorkflows():
object
Defined in: ui/client/features/workflows/hooks/useWorkflows.tsx:13
Top-level browsing state for the Workflows screen — one feature -> one
workflows/ file -> that file's machines, re-extracted from the real
source each time a file is opened (and again via reload).
Returns#
object
cancelEdit
cancelEdit: () =>
void
Returns
void
confirmEdit
confirmEdit: () =>
Promise<void>
Returns
Promise<void>
editBusy
editBusy:
boolean
editError
editError:
string|null
error
error:
string|null
eventName
eventName:
string
feature
feature:
string
features
features:
string[]
file
file:
string
files
files:
string[]
filesLoading
filesLoading:
boolean
hint
hint:
string|null
loaded
loaded:
WorkflowFileMachines|null
machineIndex
machineIndex:
number
narrative
narrative:
NarrativeView|null
openFile
openFile: (
file) =>void
Parameters
file
string
Returns
void
pending
pending:
PendingWorkflowEdit|null
pickMachine
pickMachine: (
index) =>void
Parameters
index
number
Returns
void
proposeEdit
proposeEdit: (
req) =>Promise<void>
Parameters
req
Returns
Promise<void>
reload
reload: () =>
void
Returns
void
selectedEdge
selectedEdge:
SelectedEdge|null
setEventName
setEventName:
Dispatch<SetStateAction<string>>
setFeature
setFeature: (
feature) =>Promise<void>
Parameters
feature
string
Returns
Promise<void>
setHint
setHint:
Dispatch<SetStateAction<string|null>>
setSelectedEdge
setSelectedEdge:
Dispatch<SetStateAction<SelectedEdge|null>>