API reference

Use this section to look up a type: what it is for, its key members, and which library exports it. Guides explain how to combine them; these pages are the map.

Page	Package	Libraries
Typed Document API		vyuh_document.dart, elements.dart, editor_binding.dart
Elements	and element packages	vyuh_document_elements.dart, <package>/element.dart
Element authoring		element.dart, vyuh_document_generator
Document model		types.dart
Engine		engine.dart, engine_sessions.dart, engine_integration.dart, paragraph_extension.dart, performance_probe.dart
Layout		layout.dart, layout_integration.dart
Editor		document_editor.dart, vyuh_document_editor.dart
Editor libraries		document_editor_workspace.dart, document_editor_extensions.dart, document_editor_rendering.dart, document_editor_integration.dart, document_code_editor.dart, diagnostics.dart
Element runtime APIs	vyuh_document_extension_* and _editor packages	<package>.dart and format libraries
UI kit		vyuh_document_ui.dart, integration.dart
Codecs	DOCX, PDF, HTML, Markdown	vyuh_document_codec_docx, _pdf, _html, vyuh_document_md_codec

How the API is layered

Layer	Start with	Use it for
Typed API	DocumentController, Document, Command	Building, editing and checking documents, in Flutter or pure Dart
Editor	DocumentEditor (typed) or DocumentEditorController (runtime)	Showing and editing a document in Flutter
Runtime model and engine	types.dart, engine.dart	Host integrations, custom extensions, headless workflows over the canonical model
Layout	layout.dart	Custom painters, export targets, geometry queries

Libraries marked integration

Libraries named integration.dart, engine_integration.dart and layout_integration.dart are public so sibling packages can compose them. They are not part of the application-facing API and change more often.

The complete, symbol-level documentation lives in the source dartdoc comments; the package source is the final authority.