Line

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

ui/client/features/workflows/hooks/useWorkflowNarrative

Cockpit client (features), next. Source: ui/client/features/workflows/hooks/useWorkflowNarrative.tsx.

Functions#

useWorkflowNarrative()#

useWorkflowNarrative(feature, file, loaded): NarrativeView | null

Defined in: ui/client/features/workflows/hooks/useWorkflowNarrative.tsx:12

The plain-English narrative for the open workflow file. Re-fetched whenever loaded changes identity — first load, "Re-read from source" and every confirmed visual edit all produce a fresh loaded, so the English can never lag behind the diagram. Nothing is cached or stored.

Parameters#

feature

string

file

string

loaded

WorkflowFileMachines | null

Returns#

NarrativeView | null