Editor libraries
The editor splits its larger surfaces into role libraries. Import only the ones you use.
document_editor_workspace.dart
Application chrome around the editor (about 330 names).
| Group | Main types |
|---|---|
| Theme and scaffold | DocumentEditorTheme, DocumentEditorWorkspaceScaffold, DocumentEditorWorkspaceSession |
| Ribbon and toolbars | DocumentEditorWorkspaceRibbon, DocumentEditorRibbon, DocumentWorkspaceToolbar, DocumentMenuBar, DocumentCommandPalette, RibbonMenuButton, RibbonToolButton, RibbonChoicePanel |
| Properties | DocumentPropertiesWorkspace, DocumentPropertiesWorkspaceController, DocumentPropertiesPanel, DocumentPropertiesRegistry, standardDocumentPropertiesRegistry() |
| Inspector access | DocumentInspectorConfiguration, DocumentInspectorAccess, DocumentInspectorAddress |
| Dialogs and menus | LinkUrlDialog, DocumentExportMenu, DocumentInsertMenu, PageSetupMenu, DocumentFormFieldDialog, showKeyboardShortcutsDialog |
| Rulers | DocumentRulerFrame, DocumentRulerUnit |
| Review and navigation | DocumentReviewWorkspacePanel, DocumentNavigationOutline, DocumentPageThumbnailOutline |
| Slash commands | SlashCommandPalette, SlashInsertItem |
Guides: Components, Property inspector, tutorial step 8.
document_editor_extensions.dart
Extension classes and authoring contracts.
| Group | Main types |
|---|---|
| Starter extensions | ParagraphDocumentExtension, TextEditingDocumentExtension, TableDocumentExtension, ImageDocumentExtension(assetResolver:), ListDocumentExtension, FieldDocumentExtension, CodeDocumentExtension, BlockQuoteDocumentExtension, ChecklistDocumentExtension, DividerDocumentExtension, ShapeDocumentExtension, TextBoxDocumentExtension, TableOfContentsDocumentExtension |
| Registry | ElementRegistry, EditorAction, InputRule, ElementActivationContribution, ElementPropertiesContribution |
| Views | BlockQuoteView, ChecklistView, CodeBlockView, buildParagraphView |
| Placement | EditorImagePlacement, generated-graphic and floating-block placement helpers |
Guide: Build an extension.
document_editor_rendering.dart
Re-exports layout.dart plus Flutter rendering: DocumentPreview (read-only view of a controller), PaginatedDocumentView, FlutterDocumentMeasurementPort, caret and selection painters, block views, scrollbars, watermark and line-number layers.
document_editor_integration.dart
Host services: waitForCurrentExportLayout, waitForCurrentExportResources, DocumentExportLayoutSuperseded, import pipelines (DocumentImporter), clipboard adapters and platform bindings.
document_code_editor.dart
DocumentSourceCodeEditor, DocumentCodePropertyEditor and code diagnostics/syntax contracts for element source editing (Mermaid, KaTeX, code blocks).
diagnostics.dart
Paint audit and frame probes for performance work. Not needed by apps.