Component reference
A note can use DocumentEditor alone. A document application can compose shared ribbon, Properties, navigation, review, search, and export controls around the same controller.
Editor surface
| Component | Purpose | Library |
|---|---|---|
DocumentEditor | Editable document area with keyboard, touch, pointer, and optional toolbar support. | vyuh_document_editor.dart |
DocumentToolbarConfiguration | Toolbar rows, placement, collapse, action IDs, and groups. | vyuh_document_editor.dart |
DocumentPreview | Render and navigate the same controller without accepting edits or changing the controller's editing mode. | document_editor_rendering.dart |
Workspace composition
These components are exported by document_editor_workspace.dart:
| Component | Purpose |
|---|---|
DocumentEditorWorkspaceScaffold | Compose the main editor with optional host header, status, inspector, and footer; omitted chrome reserves no space. |
DocumentEditorWorkspaceRibbon | Full ribbon composition with host toolbar contributions. |
DocumentPropertiesWorkspace | Contextual Properties projected from the controller; host supplies navigation, page callbacks, and placement. |
DocumentPropertiesPanel | Underlying Properties panel for a host with its own registry, navigator, context, and adapter. |
LinkUrlDialog | Shared Web/Bookmark destination and editable text dialog. |
DocumentExportMenu | Export controls with host effects and current-layout availability; does not encode or save files. |
The compact toolbar is configured through DocumentEditorConfiguration.toolbar. There is no standalone DocumentToolbar facade or single DocumentWorkspace constructor in the current API.
See headers, footers, and workspace chrome for a minimal composition and authored page stories.
Host responsibilities
The controller remains the source of selection and commands. Workspace placement and visibility belong to the host. Dialogs, resource transport, file selection, saving, and downloads are explicit host effects.
For concrete constructors and required callbacks, see the workspace source and Properties source.