搜索插件、代码仓与 APP 分类

re_editor 封面
插件详情v0.10.0

re_editor

Re-Editor 是一个功能强大且轻量级的文本和代码编辑器小部件。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
5.4万
喜欢数
140
Pub 分数
130

安装插件

flutter pub add re_editor

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

Re-Editor 是一个轻量级、功能强大的文本和代码编辑器小部件,专为在多个平台间无缝集成而设计。它支持语法高亮、可自定义的主题以及实时编辑和高效的渲染。该组件以性能为核心构建,为简单的文本输入和复杂的代码编辑任务提供流畅的体验。该包非常适合希望在 Flutter 应用中构建类似 IDE 的功能或丰富文本界面的开发者。

适合场景

  • 开发者工具中的代码编辑
  • 实时协作文本编辑
  • 语法高亮的笔记应用
  • 文档中的嵌入代码片段
  • 构建自定义 IDE 或编辑器

主要特点

  • 语法高亮
  • 跨平台支持
  • 可自定义的主题
  • 高效渲染
  • 轻量级占用
  • 实时编辑

适合对象

  • Flutter 开发人员构建代码编辑器
  • 需要富文本输入的应用程序
  • 带有代码示例的教育工具
  • 文档和教程应用

使用建议

  • 可能需要额外配置才能使用高级功能
  • 性能取决于内容大小
  • 有限的内置协作功能
  • 未针对非常大的文件进行优化

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

Re-Editor

latest version

中文版本

Re-Editor is a powerful lightweight text and code editor widget and a module in the Reqable project. It can be used as a simple text area or to develop a code editor with complex functions. Unlike Flutter's default TextField, Re-Editor is specifically tailored for the display and input of multi-line text and offers the following features:

  • Two-way horizontal and vertical scrolling.
  • Text syntax highlighting.
  • Content collapsing and expanding.
  • Input hints and auto-completion.
  • Search and replace.
  • Custom context menu builder.
  • Shortcut keys.
  • Large text display and editing.
  • Line numbers and focus line builder.
  • Smart input.

Re-Editor is not a secondary encapsulation based on TextField, but independently implements the layout, drawing, event processing, etc. It is specifically optimized for large texts, providing extremely high performance and fixed some issues of TextField.

Re-Editor offers a high degree of freedom. For example, developers can control whether to enable horizontal scrolling (word wrap), enable read-only mode, display line numbers, display content folding, define custom shortcut keys, and specify text syntax highlighting.

You can run the example project to experience it.

Getting Started

Add the followings in pubspec.yaml.

dependencies:
  re_editor: ^0.10.0

Like TextField, Re-Editor uses CodeLineEditingController as the controller. The following sample code creates the simplest multi-line input area, which is not much different from TextField.

Widget build(BuildContext context) {
  return CodeEditor(
    controller: CodeLineEditingController.fromText('Hello Reqable'),
  );
}
Text Syntax Highlighting

The text highlighting of Re-Editor is based on Re-Highlight and supports nearly a hundred languages ​​and theme styles. Developers can freely choose and configure the code Highlight. The following code specifies the JSON syntax highlighting rules and applies the Atom One Light code coloring.

CodeEditor(
  style: CodeEditorStyle(
    codeTheme: CodeHighlightTheme(
      languages: {
        'json': CodeHighlightThemeMode(
          mode: langJson
        )
      },
      theme: atomOneLightTheme
    ),
  ),
);
Line Numbers and Fold/Unfold Markers

Re-Editor supports configuring whether to display code line numbers and code folding marks, and developers can also implement display styles and layouts by themselves. The example code below shows the default style, built with indicatorBuilder.

CodeEditor(
  indicatorBuilder: (context, editingController, chunkController, notifier) {
    return Row(
      children: [
        DefaultCodeLineNumber(
          controller: editingController,
          notifier: notifier,
        ),
        DefaultCodeChunkIndicator(
          width: 20,
          controller: chunkController,
          notifier: notifier
        )
      ],
    );
  },
);
Code Folding and Unfolding Detection

By default, Re-Editor will automatically detect the folding areas of {} and []. Developers can control whether to detect or write their own detection rules. DefaultCodeChunkAnalyzer is the default detector. If you wish to disable detection, you can use NonCodeChunkAnalyzer.

CodeEditor(
  chunkAnalyzer: DefaultCodeChunkAnalyzer(),
);

If you want to customize it, just implement the CodeChunkAnalyzer interface.

abstract class CodeChunkAnalyzer {

  List<CodeChunk> run(CodeLines codeLines);

}
Scroll Control

Re-Editor supports two-way scrolling, so two ScrollController are used, and developers can use CodeScrollController to construct.

CodeEditor(
  scrollController: CodeScrollController(
    verticalScroller: ScrollController(),
    horizontalScroller: ScrollController(),
  )
);
Find and Replace

Re-Editor implements search and replace control logic, but does not provide a default UI. Developers need to write the UI of the search panel according to the actual situation of their own projects, and use the findBuilder attribute to set up their own search and replace UI.

CodeEditor(
  findBuilder: (context, controller, readOnly) => CodeFindPanelView(controller: controller, readOnly: readOnly),
);

The CodeFindPanelView in the above example is implemented by the developer himself. For the detailed implementation process, please refer to the code in example.

Context Menu

Re-Editor implements the control logic of the desktop context menu and the mobile long-press selection menu, but does not provide a default UI. Developers need to implement the SelectionToolbarController interface and setup it through toolbarController.

CodeEditor(
  toolbarController: _MyToolbarController(),
);
Shortcuts

Re-Editor has the built-in default shortcut hotkeys, and developers can also use shortcutsActivatorsBuilder to set custom shortcut hotkeys. Of course, the shortcut keys only work on the desktop.

The shortcut keys supported by Re-Editor are as follows:

  • Select all (Control/Command + A)
  • Cut selected/current line (Control/Command + V)
  • Copy selected/current line (Control/Command + C)
  • Paste (Control/Command + V)
  • Undo (Control/Command + Z)
  • Redo (Shift + Control/Command + Z)
  • Select the current line (Control/Command + L)
  • Delete current line (Control/Command + D)
  • Move current line (Alt + ↑/↓)
  • Continuous selection (Shift + ↑/↓/←/→)
  • Move cursor (↑/↓/←/→)
  • Move cursor between word boundaries (Alt + ←/→)
  • Move to top/bottom of page (Control/Command + ↑/↓)
  • Indent (Tab)
  • Unindent (Shift + Tab)
  • Comment/uncomment a single line (Control/Command + /)
  • Comment/uncomment multiple lines (Shift + Control/Command + /)
  • Character transpose (Control/Command + T)
  • Search (Control/Command + F)
  • Replace (Alt + Control/Command + F)
  • Save (Control/Command + S)
Code Hints and Auto-Completion

Re-Editor supports using the CodeAutocomplete widget to implement code input prompts and automatic completion. Re-Editor implements basic control logic, but the code prompt content, auto-completion rules and display UI need to be defined by the developer.

CodeAutocomplete(
  viewBuilder: (context, notifier, onSelected) {
    // build the code prompts view
  },
  promptsBuilder: DefaultCodeAutocompletePromptsBuilder(
    language: langDart,
  ),
  child: CodeEditor()
);

Note that Re-Editor is only a lightweight editor and does not have the IDE dynamic syntax analysis, so the code prompts and completion have many limitations. You can refer to the code in example to implement a simple code prompt and completion.

Used By

Re-Editor has been extensively practiced in the Reqable project. You are welcome to download Reqable to experience it.

License

MIT License

Sponsor

If you would like to sponsor this project, you can support us by purchasing a Reqable license.

所属分类

依赖

依赖清单 2 项

源码仓库

使用此插件的项目