Line

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

ui/client/features/component-docs/hooks/useComponentWorkflow

Cockpit client (features), next. Source: ui/client/features/component-docs/hooks/useComponentWorkflow.tsx.

Functions#

useComponentWorkflow()#

useComponentWorkflow(path): object

Defined in: ui/client/features/component-docs/hooks/useComponentWorkflow.tsx:9

"State switcher": the machine driving this component (same-name-file convention), or machines: [] when it has none -- that is the common case, not a failure. null while loading or with nothing selected.

Parameters#

path

string | null

Returns#

object

loading

loading: boolean

workflow

workflow: ComponentWorkflowResponse | null