Skip to content
UI Brok

Loading…

No results

Browse catalog

Flow Diagram

A static SVG flow chart positioning box, pill and diamond nodes on a col/row grid, joined by labelled arrowed edges.

Preview

A dependency-free static SVG flow chart. Pass `:nodes` (each `id`, `label`, 0-based `col`, `row`, and `shape` of `box`, `pill` or `diamond`) and `:edges` (`from`, `to`, optional `label`) to map your own process.

Controls

Theme
Surface
Direction
Viewport

Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.

Installation

terminal
php artisan ui:add flow-diagram

Registry contract

Install confidence

php artisan ui:add flow-diagram writes only the generated targets below. The CLI validates each file hash before writing and prompts before replacing local changes unless --force is used.

Version
1.0.0
License
open
Stability
stable
Contract
v2
Foundation
≥ 1.0.0
Type Generated target
blade resources/views/components/ui/flow-diagram.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Diagram and relationship view

Explain hierarchy, causality, network structure, or flow.

Use when

  • Use when hierarchy, causality, network structure, or process flow is the information itself. Do not use specialized diagrams when a list, table, or short paragraph would be easier to interpret.

Avoid when

  • Avoid using flow-diagram as a default simply because it is available in the library. Choose it only when its interaction cost, visibility, and behavior match the job to be done.
Task length
medium
Interaction cost
high
Interruptiveness
none
Input precision
none
Mobile / touch risk
high
Accessibility risk
high
Needs background context
No
Comparison needed
Yes

Preferred alternatives

  • List, table, or prose explanation

Anti-patterns

  • Using a specialized diagram when linear content is clearer

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
nodes mixed|null null Declared by @props in the registry Blade source.
edges mixed|null null Declared by @props in the registry Blade source.
height int 320 Declared by @props in the registry Blade source.
label string Flow diagram Declared by @props in the registry Blade source.

Slots

Components use the default Blade slot unless a documented subcomponent is installed by the registry item.

Data slots

flow-diagram flow-diagram-edge flow-diagram-node

Capabilities

wcag-2.2-aa-target responsive rtl darkMode localized

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Usage

previews.components.flow-diagram.default.blade.php Blade
<div class="space-y-4">
    <x-ui.flow-diagram :height="320" label="{{ __('Approval workflow') }}" />

    <p class="text-sm text-muted-foreground">
        {{ __('A dependency-free static SVG flow chart. Pass `:nodes` (each `id`, `label`, 0-based `col`, `row`, and `shape` of `box`, `pill` or `diamond`) and `:edges` (`from`, `to`, optional `label`) to map your own process.') }}
    </p>
</div>

Accessibility & localization

WCAG 2.2 AA RTL-ready data-slot Keyboard focus-visible Localized labels
  • Accessibility target: wcag-2.2-aa-target.
  • Uses semantic HTML and a stable data-slot attribute for styling/scripting hooks.
  • Focus-visible rings use the ring token so keyboard focus is always visible.
  • Disabled and invalid states are conveyed to assistive tech, not by color alone.
  • Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces above.
  • Labels go through __() and the component uses logical properties (ms-*, text-start, start-*) so it mirrors correctly — flip the preview to RTL to confirm.

Source

The exact, editable file ui:add writes into your app — copy it or own the whole thing. Previews render this same code; there are no preview-only components.

Changelog

Current version: v1.0.0. See the site changelog for the full release history.