Vyuh Document

Behavior and configuration ​

A host makes three separate choices: extensions install capabilities, the schema restricts content, and configuration chooses behavior and presentation.

The document configuration gates everything ​

The elements and marks you configure become a schema policy. Every surface asks it before offering anything.

How a document configuration gates the editor A DocumentConfiguration lists elements and marks. The editor derives a restricted DocumentSchemaPolicy of block, inline and mark types from it, plus a set of disabled actions, such as the heading actions when Heading is not configured. The toolbar, menus, shortcuts, paste and the command palette all consult them. DOCUMENT CONFIGURATION elements Paragraph · Heading ListItem · Table · … marks Bold · Italic · Underline · … a table's rows and cells come along derives DocumentSchemaPolicy block types inline types mark types Disabled actions headings, when no Heading gates EVERY SURFACE ASKS Toolbar Menus Shortcuts Paste degrades what is refused Command palette
From configuration to schema policy

Hiding a button is presentation only. The schema rejects content it does not admit, and document protection guards protected edits.

Editor configuration ​

The parts of DocumentEditorConfiguration DocumentEditorConfiguration groups its parts three ways. What users see: toolbar, the show flags (formatting marks, scrollbar), theme, inspector, context menu and review. What users can do: schema, policy, shortcuts, protection and form fields. What you supply: registry contributions and resources. Interaction mode, focus and zoom stay live inputs of DocumentEditor. DocumentEditorConfiguration WHAT USERS SEE toolbarvisible actions show…marks, scrollbar themeall editor colours inspectorProperties access contextMenumenu actions reviewcomments shown WHAT USERS CAN DO schemaadmitted content policydisabled actions shortcutskey overrides protectionroles formFieldsfield activation WHAT YOU SUPPLY registryyour actions resourcesfont loader Mode, focus and zoom stay live DocumentEditor inputs.
The parts of DocumentEditorConfiguration
dart
import 'package:vyuh_document_editor/vyuh_document_editor.dart';

final configuration = DocumentEditorConfiguration(
  toolbar: DocumentToolbarConfiguration(
    rows: DocumentWorkspaceToolbarRows.singleRow,
    actionIds: {
      HistoryActionId.undo,
      HistoryActionId.redo,
      MarkActionId.bold,
      MarkActionId.italic,
      MarkActionId.underline,
      TextInsertActionId.link,
    },
  ),
  policy: DocumentEditorPolicy(
    allowInputRules: false,
    disabledActionIds: {MarkActionId.strike},
  ),
  showFormattingMarks: false,
);

// Toolbar filtering is presentation. Use a restricted schema to reject
// content, action policy to restrict registered actions, and engine protection
// for authorization. Direct commands still obey their canonical validation.

Use DocumentEditorConfiguration.copyWith for product variants. The controller's layoutMode chooses paged or pageless editing; the configuration's optional layoutMode only checks it.

Embedded surface ​

A pageless editor draws a white surface with a 42-pixel inset, room for table controls and element handles. Change it on the theme:

dart
final configuration = DocumentEditorConfiguration.richText(
  theme: DocumentEditorTheme.light().copyWith(
    continuousCanvasColor: const Color(0xFFF7F8FA),
    continuousContentPadding: const EdgeInsets.symmetric(
      horizontal: 16,
      vertical: 12,
    ),
  ),
);

Use EdgeInsets.zero when the surrounding widget supplies that space. When two toolbar rows would not fit, a docked toolbar shows one scrollable row instead.

Theming ​

One DocumentEditorTheme styles the editor in light and dark. See Theming.

Action contributions ​

configuration.registry adds your own EditorActions. One typed action ID (an enum implementing EditorActionId) reaches the toolbar, shortcuts, shortcut help and insert menus. A later contribution with the same ID replaces the earlier one.

For field-level inspector settings, see Properties inspector.

Next ​