Reference for the workflow MDX component, including usage notes and examples.
Workflow communicates end-to-end process stages in a structured visual block.
When to use
- Cross-team delivery flows
- Spec-to-model release pipelines
- Approval and governance checkpoints
Supported props
| Prop | Type | Required | Default | Purpose |
|---|---|---|---|---|
model_key | string | yes* | current route model | Model context for workflow lookup |
workflow_id | string | yes | none | Workflow id (<id>.wf) to render |
attachment_key | string | no | workflow_id | Workflow attachment tab key |
* In specs pages there is no model route context, so set model_key explicitly.
Important
<Stage /> children are not supported by this component. Workflow renders
an existing workflow by workflow_id.
Example
These examples render two workflows from this project’s deployment model.
User sign-in
<Workflow model_key="deployment" workflow_id="sign-in" />Release upgrade
<Workflow model_key="deployment" workflow_id="release-upgrade" />If the workflow exists, this renders the workflow diagram preview panel.
If workflow_id is missing or cannot be loaded, it shows an inline error placeholder.
Common pitfalls
- Treating
Workflowas a manual layout component with nested stages - Omitting
model_keyin docs pages that are outside model routes - Using a
workflow_idthat does not exist in the model workflows
Last updated on