Flow

A flow diagram represents an ordered list of labeled items. The view field determines how the flow is interpreted and rendered.

Fields

FieldRequiredTypeDescription
kindyes"flow"Must be exactly "flow"
viewnostringRendering intent. Default: process
titlenostringTitle rendered above the diagram
itemsyesarray of ItemAt least one item required

Item fields

FieldRequiredTypeDescription
labelyesstringText displayed in the item
emphasisnostring"primary" or "secondary". See schema.
statusnostring"success", "normal", "warning", or "critical" — health/severity signal, orthogonal to emphasis. See schema.

View values

valueMeaningMin itemsMax items
processLinear left-to-right steps (default)1—
cycleClosed loop — last item connects to first2—
funnelTapering stages (conversion/filtering)210
swimlaneSteps grouped into horizontal actor lanes, top→down2—

When view is omitted, the engine uses process.

For ranked/layered visuals (pyramid), use kind = "tier" instead.

Long labels

In the process and swimlane views a label that does not fit on one line — even shrunk to 85% of the label size — is wrapped onto as many lines as the box holds (at most three) — at spaces, and between characters for Chinese and Japanese text without spaces. The label shrinks toward the theme's minimum label size only when wrapping alone is not enough, and only a label that still overflows at that size is truncated with … on its last line. Hangul, CJK and other fullwidth characters are measured one em wide.

Swimlane item fields

When view = "swimlane", each item gains one additional required field:

FieldRequiredTypeDescription
actoryesstringLane owner of this step

actor is ignored by all other views. At least 2 distinct actor values are required.

Swimlane example

Order Processing Swimlane: Place Order (Customer) → Check Inventory (System) → Process Payment (Payment Gateway) → Confirm Order (System) → Receive Confirmation (Customer). Order Processing Customer System Payment Gateway Place Order Check Inventory Process Payment Confirm Order Receive Confirmation

Example

PDCA Cycle: Plan → Do → Check → Act → Plan. PDCA Plan Do Check Act

Status example

status adds a traffic-light health signal per step. It is orthogonal to emphasis, so a step can be both the most important (primary) and in trouble (critical).

Release Pipeline Health Process: Build → Test → Deploy → Monitor. Release Pipeline Health Build Test Deploy Monitor

Label capacity

How long a label can be before the engine sets it smaller, wraps it, or cuts it short with "…". Each number is measured by rendering a small reference declaration with a growing label and reading the diagnostics render_detailed returns, so the table always agrees with them. Lengths are in characters written without spaces: Hangul syllables are one em wide, Latin lowercase letters about half that. unchanged is the longest label shown at the usual size on one line; whole is the longest shown without "…". A slot's width depends on its siblings, so read a number as a guide for the reference declaration named in the second column and use declart validate --strict for the declaration itself.

A dash means the engine reports nothing for the slot up to 120 characters. That is not a promise that any length fits: a slot the engine does not fit at all draws a long label past the picture without a warning.

process

SlotMeasured inHangul (unchanged / whole)Latin (unchanged / whole)
items[].label3 items20 / 4239 / 81

cycle

SlotMeasured inHangul (unchanged / whole)Latin (unchanged / whole)
items[].label3 items9 / 915 / 15

funnel

SlotMeasured inHangul (unchanged / whole)Latin (unchanged / whole)
items[].label3 items22 / 2249 / 49

swimlane

SlotMeasured inHangul (unchanged / whole)Latin (unchanged / whole)
items[].label3 items18 / 3634 / 72

Schema

What a declaration of this kind may contain, as declart schema and schema() report it. The value lists and counts are the ones the parser checks, and a test holds every field, count and rule to the parser in both directions, so a declaration written to this page parses. The prose above is the explanation; this is the reference.

process

Fields

FieldTypeRequiredValues / meaning
kindenumyesflow
viewenumnoprocess, cycle, funnel, swimlane
titlestringno

items — 1 or more elements

FieldTypeRequiredValues / meaning
labelstringyes
emphasisenumnoprimary, secondary
statusenumnosuccess, normal, warning, critical

cycle

Fields

FieldTypeRequiredValues / meaning
kindenumyesflow
viewenumnoprocess, cycle, funnel, swimlane
titlestringno

items — 2 or more elements

FieldTypeRequiredValues / meaning
labelstringyes
emphasisenumnoprimary, secondary
statusenumnosuccess, normal, warning, critical

funnel

Fields

FieldTypeRequiredValues / meaning
kindenumyesflow
viewenumnoprocess, cycle, funnel, swimlane
titlestringno

items — 2 to 10 elements

FieldTypeRequiredValues / meaning
labelstringyes
emphasisenumnoprimary, secondary
statusenumnosuccess, normal, warning, critical

swimlane

Fields

FieldTypeRequiredValues / meaning
kindenumyesflow
viewenumnoprocess, cycle, funnel, swimlane
titlestringno

items — 2 or more elements

FieldTypeRequiredValues / meaning
labelstringyes
emphasisenumnoprimary, secondary
statusenumnosuccess, normal, warning, critical
actorstringyesthe lane the step belongs to

Rules

  • actor must not be empty on any item
  • the items name at least 2 distinct actors