Vyuh Document

Vyuh Document Docs ​

Vyuh Document is a document platform for Flutter and Dart: an immutable document model, an editing engine, page layout, a Flutter editor, and codecs for JSON, Markdown, HTML, DOCX and PDF. Start with a rich-text field and grow to a full paged editor on the same model.

How the pieces fit Your app mounts the editor widget and holds a controller. The controller sends commands to the engine, which keeps one immutable state snapshot, applies transactions and records history. Each revision is laid out into resolved pages, which the editor paints and the PDF and print paths reuse. Codecs for JSON, DOCX, Markdown and HTML read and write the canonical document beside the engine. Your app VIEW AND CONTROL Editor widget DocumentEditor keys · IME · pointer · chrome Controller DocumentController DocumentEditorController commands ENGINE DocumentEngineSession State one snapshot Transactions validated edits History undo · redo each revision Layout ResolvedDocumentLayout pages · lines · carets · hit regions for one revision Paint editor canvas PDF same pages Print same pages CODECS JSONDocument.fromJson · toJson DOCXDocxCodec MarkdownMarkdownCodec HTMLHtmlCodec read and write the canonical Document
How the pieces fit
dart
DocumentEditor(
  controller: DocumentController(DocumentConfiguration.richText),
  surface: const DocumentSurface.field(minLines: 3, maxLines: 8),
  chrome: EditorChrome.floating,
);

Start here ​

GuideWhat you will build or learn
InstallationRegistry token, pubspec.yaml, and the imports you need.
PackagesEvery package, its layer, and when you need it.
TutorialA rich-text field that grows, step by step, into a full document editor.
Typed Document APIDocuments, controllers, commands and results in pure Dart.
Live examplesOpen each surface in the playground.

By task ​

I want toRead
Put a rich-text field in my appTutorial step 1, Editor widget
Choose which content users can addChoose extensions, Configuration
Edit documents from code, a server or an agentCommands, Addressing, Agents
Let people and agents edit togetherCollaboration
Save and load documentsLoading and saving
Open and save Word, Markdown, HTML or PDFTutorial step 6, Formats
Show my own images and fontsFonts and images
Build a full workspace with PropertiesTutorial step 8, Components
Add my own elementDeclare an element, Build an extension
Look up a typeAPI reference

Two levels of API ​

Typed APIEditor runtime
ControllerDocumentController (vyuh_document)DocumentEditorController (vyuh_document_editor)
WidgetDocumentEditor(controller:, surface:, chrome:) from document_editor.dartDocumentEditor(controller:, configuration:) from vyuh_document_editor.dart
ContentDocumentConfiguration of elementsInstalled DocumentExtensions and a schema policy
EditsTyped commands returning ResultFlat methods (insertTable, setLink, ...) and transactions
Runs onFlutter, servers, agentsFlutter

Both share one engine and one model. Start with the typed API; reach for the runtime for host bindings such as images, fonts, links, review and export.

Package source · Try the editor