novident_editor 1.0.0

A highly customizable rich-text editor for Flutter, part of the Novident suite. Fork of AppFlowy Editor (AppFlowy-IO), used under the Mozilla Public License 2.0.

Novident Editor

A high-performance rich-text editor for Flutter — part of the Novident suite.

Fork of AppFlowy Editor, used under the Mozilla Public License 2.0. See NOTICE for attribution.

---

What is Novident Editor?

Novident Editor is a drop-in rich-text editor for Flutter apps. It renders a document tree built from composable block components — paragraphs, headings, lists, quotes, images, tables, code blocks and more — and ships with:

• vim emulation (normal / insert / visual, remappable keybindings, pending operator dd)
• zen mode (typewriter centering, unfocused-block dimming, color neutralization without touching the document)
• aggressive caching throughout the document model, selection pipeline and text rendering

Planned

1. Improve perfomance on Zen Mode.
2. Improve VIM mode movement, and character positioning.
3. Full customization of every default block.
4. First line indent.
5. Improve clipboard copy+paste content (now it copies pure plain text)
6. Translations

---

Quick start

import 'package:novident_editor/novident_editor.dart';
import 'package:flutter_localizations/flutter_localizations.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      localizationsDelegates: const [
        NovidentEditorLocalizations.delegate,
        GlobalMaterialLocalizations.delegate,
        GlobalWidgetsLocalizations.delegate,
        GlobalCupertinoLocalizations.delegate,
      ],
      home: Scaffold(
        body: NovidentEditor(
          editorState: EditorState.blank(withInitialText: true),
        ),
      ),
    );
  }
}

Or hydrate the editor from JSON / Markdown / Quill Delta — see Importing content.

---

Vim mode

Vim emulation is built into the package — no extra dependency. Every keybinding is remappable at runtime, and changing bindings does not rebuild the editor:

final vimController = VimModeController();

NovidentEditor(
  editorState: editorState,
  commandShortcutEvents: [
    ...vimController.commandShortcutEvents,
    ...standardCommandShortcutEvents,
  ],
);

// After the editor is mounted:
vimController.attach(editorState);

// Remap any key at runtime:
vimController.configuration =
    vimController.configuration.rebind(VimCommand.moveLeft, 'a');

A VimModeChip widget is available in the example for status bars. Modes, the pending dd operator and the block-cursor style are all observable via vimController.

You can also define your own VimCommand instances to extend the built-in set — indent / outdent, custom insertions, or any editor operation. See the full guide at Vim Commands.

---

Zen mode

Zen mode dims every top-level block that is not focused (animatable opacity), ignores text / highlight / block-background colors (they stay in the document — disable zen and they come back), and keeps the focused block vertically centered (typewriter scrolling):

final zenController = ZenModeController();

NovidentEditor(
  editorState: editorState,
  editorScrollController: editorScrollController,
  blockWrapper: zenController.blockWrapper,
  editorStyle: EditorStyle.desktop(
    textSpanDecorator: zenController.textSpanDecorator(),
  ),
);

All colours (font_color, bg_color, block bgColor) are ignored without ever mutating the delta or the node attributes — the visual pipeline neutralises them while the blockWrapper dims the unfocused blocks. This means zen mode can be toggled on and off with zero document churn.

---

Word & character counter

Each EditorState can be connected to a WordCountService that debounces on transactions and exposes documentCounters / selectionCounters through a ChangeNotifier. Use a ListenableBuilder to build a live counter chip:

final counter = WordCountService(editorState: editorState)..register();

ListenableBuilder(
  listenable: counter,
  builder: (context, _) => Text(
    '${counter.documentCounters.wordCount} words  '
    '${counter.documentCounters.charCount} chars',
  ),
);

---

Customising block components

Overriding a built-in block or adding a new one is done via blockComponentBuilders — the standardBlockComponentBuilderMap is a convenient base that you can spread and override:

NovidentEditor(
  editorState: editorState,
  blockComponentBuilders: {
    ...standardBlockComponentBuilderMap,
    'my_custom_type': MyCustomBlockBuilder(),
  },
);

See documentation/customizing.md for a detailed walkthrough.

---

License

Novident Editor is a fork of AppFlowy Editor (AppFlowy-IO/appflowy-editor). Upstream is dual-licensed under the GNU Affero General Public License v3 and the Mozilla Public License 2.0.

This fork is used and distributed under the Mozilla Public License 2.0. See LICENSE and NOTICE for full details.