Core

Getting started
Packages
Hello world
Vocabulary
Shape anatomy
Shape behavior
Plain Text and Rich Text
Guides
- Common tasks
  Verbs and shortcuts
  Create a shape
  Live data
  Theming
Elements
- Overview and capabilities
  Standard element catalog
  Appearance and painting
  Text and regions
  Frames and groups
API reference
- Overview
  Diagram and controller
  Controller reference
  Verbs
  Extensions and options
  Extension registration
  Shapes and content
  - Shape definitions
    Plain Text
    Widgets inside shapes
    Shape behavior
  Connections and layout
  - Connectors
  Viewport and canvas
  - Canvas and viewer
    Navigation and motion
    Animation & effects
    Grids and snapping
  Editing and integration
  - Undo and redo
    Verbs and shortcuts
    Rules and changes
    Sessions and collaboration
    Domain diagnostics
  Data and output
  - Persistence and imports
    JSON format
    Export
    Headless text
Agents
- LLM documentation
  Package skill
  llms.txt
  llms-full.txt

Examples

Example catalog
Core
- Getting started
  - Your first drawing Core
    Transform modifiers Core
    Multi-selection and arrangement Core
    Locks and capabilities Core
  Elements and structure
  - Images Core
    Drawing and erasing Core
    Frames and ownership Core
    Departmental swimlanes Core
  Text
  - Plain Text Core
  Canvas and navigation
  - Custom tools Core
    Grid snapping Core
    Fitted and infinite canvas Core
    View-only diagrams Core
  Animation & effects
  - Navigation and animation Core
    Connector effects Core
    Shape effects Core
    Element motion Core
    Custom effect Core
    Live energy flow Core
  Embedded controls
  - Controls inside a node Core
    Portable widget fallback Core
    Widget clipping and layering Core
    Custom properties Core
  Documents and editing
  - Events and permissions Core
    Save and load Core
    SVG and PNG Core
    Transactions and undo Core
    Copy, paste and duplicate Core
    Controller lifetime Core
  Use cases
  - Connected building topology Core
    Regional transport network Core
    Construction site coordination Core
    Warehouse execution flow Core
    Workplace floor planning Core
    MES production routing Core
Extensions
- Connectors
  - Crowded network Extensions
    Connected cards Extensions
    Connector labels Extensions
    Explicit ports Extensions
    Connection admission Extensions
    Anchors and contour routing Extensions
    Connected creation Extensions
  Rich text
  - Rich Text Extensions
    Paragraphs, lists and checklists Extensions
    Fonts and inheritance Extensions
    Single-line and multiline regions Extensions
    Range and whole-story formatting Extensions
  Tables
  - Basic tables Extensions
    Embedded tables Extensions
    Table styling Extensions
  Canvas assistance
  - Editor composition Extensions
    Snap guides Extensions
    Snap guide policy Extensions
    Minimap policies Extensions
    Layout Extensions
    Mermaid import Extensions

Extensions

Overview
Editor tutorial
- Build a flowchart editor
  1. Set up the canvas
  2. Register and create shapes
  3. Create the toolbar
  4. Connect reactive state to your UI
  5. Show properties and connections
  6. Save and load the drawing
  7. Add a custom review node
  8. Share verbs and shortcuts
  9. Control the canvas and grid
Guides
- Package Access
  SDK licensing
  Build a library
  Custom shape tutorial
  Properties and the inspector
  Canvas and grids
API reference
- Shapes and content
  - Rich Text
    Tables
    Shapes library
  Connections and layout
  - Routing extensions
    Arrowheads
    Graph layout
    Layout algorithms
  Viewport and canvas
  - Property inspector
  Table elements
Recipes
- Overview
  Layout
  Application compositions

On this page

Agent documentation

Use the LLM documentation resources.

Pager

Next pageGetting started

Vyuh DiagramBuilt for Flutter

A little room for your ideas.

Product

Legal

Terms and Conditions Refund Policy Privacy Policy

Shapes and content

Connections and layout

Viewport and canvas

Editing and integration

Data and output

Getting started

Elements and structure

Text

Canvas and navigation

Animation & effects

Embedded controls

Documents and editing

Use cases

Connectors

Rich text

Tables

Canvas assistance

Shapes and content

Connections and layout

Viewport and canvas

Agent documentation ​

Agent documentation