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

code_text_field 封面
插件详情v1.1.0

code_text_field

一个可自定义的代码字段,支持语法高亮、双向滚动和代码修饰符

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
1.6万
喜欢数
171
Pub 分数
150

安装插件

flutter pub add code_text_field

插件介绍

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

一个可自定义的代码文本字段,适用于 Flutter,提供语法高亮、双向滚动以及对代码修饰符的支持。专为需要在应用中实现轻量级但功能强大的代码编辑体验的开发者设计。支持多种平台,包括 Android、iOS、Web、macOS、Windows 和 Linux,非常适合跨平台开发。该包与 Flutter 的小部件系统无缝集成,并允许对代码外观和行为进行细粒度控制。

适合场景

  • 开发者工具中的内联代码编辑
  • 教育类应用程序中的语法高亮代码输入
  • 实时代码协作界面
  • 代码片段的创建和显示
  • Flutter 应用中的自定义 IDE 类组件

主要特点

  • 语法高亮
  • 双向滚动
  • 代码修饰符支持
  • 跨平台兼容性
  • 可自定义样式
  • 轻量级集成

适合对象

  • Flutter 开发人员构建代码编辑器
  • 教授编程的教育类应用程序
  • 开发者工具和IDE扩展
  • 需要实时代码输入的应用程序
  • 需要在跨平台保持一致的代码 UI 的团队

使用建议

  • 需要手动设置以支持高级语法规则
  • 性能可能因非常大的代码文件而有所不同
  • 有限的内置语言支持(可通过配置扩展)
  • 复杂用例可能需要额外的状态管理
  • 不适用于完整的集成开发环境工作流

原始 README

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

CodeField

A customizable code text field supporting syntax highlighting

Pub Website shields.io GitHub license Awesome Flutter

Live demo

A live demo showcasing a few language / theme combinations

Showcase

The experimental VM dlox uses CodeField in its online editor

Features

  • Code highlight for 189 built-in languages with 90 themes thanks to flutter_highlight
  • Easy language highlight customization through the use of theme maps
  • Fully customizable code field style through a TextField like API
  • Handles horizontal/vertical scrolling and vertical expansion
  • Supports code modifiers
  • Works on Android, iOS, Web, MacOS, Windows, and Linux

Code modifiers help manage indents automatically

The editor is wrapped in a horizontal scrollable container to handle long lines

Installing

In the pubspec.yaml of your flutter project, add the following dependency:

dependencies:
  ...
  code_text_field: <latest_version>

latest version

In your library add the following import:

import 'package:code_text_field/code_text_field.dart';

Simple example

A CodeField widget works with a CodeController which dynamically parses the text input according to a language and renders it with a theme map

import 'package:flutter/material.dart';
import 'package:code_text_field/code_text_field.dart';
// Import the language & theme
import 'package:highlight/languages/dart.dart';
import 'package:flutter_highlight/themes/monokai-sublime.dart';

class CodeEditor extends StatefulWidget {
  @override
  _CodeEditorState createState() => _CodeEditorState();
}

class _CodeEditorState extends State<CodeEditor> {
  CodeController? _codeController;

  @override
  void initState() {
    super.initState();
    final source = "void main() {\n    print(\"Hello, world!\");\n}";
    // Instantiate the CodeController
    _codeController = CodeController(
      text: source,
      language: dart,
    );
  }

  @override
  void dispose() {
    _codeController?.dispose();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return CodeTheme(
      data: const CodeThemeData(styles: monokaiSublimeTheme),
      child: CodeField(
        controller: _codeController!,
        textStyle: const TextStyle(fontFamily: 'SourceCode'),
      ),
    );
  }
}

Here, the monospace font Source Code Pro has been added to the assets folder and to the pubspec.yaml file.

Parser options

On top of a language definition, word-wise styling can be specified in the stringMap field

_codeController = CodeController(
  //...
  stringMap: {
    "Hello": TextStyle(fontWeight: FontWeight.bold, color: Colors.red),
    "world": TextStyle(fontStyle: FontStyle.italic, color: Colors.green),
  },
);

More complex regexes may also be used with the patternMap. When a language is used though, its regexes patterns take precedence over patternMap and stringMap.

_codeController = CodeController(
  //...
  patternMap: {
    r"\B#[a-zA-Z0-9]+\b":
        TextStyle(fontWeight: FontWeight.bold, color: Colors.purpleAccent),
  },
);

Both patternMap and stringMap can be used without specifying a language.

_codeController = CodeController(
  text: source,
  patternMap: {
    r'".*"': TextStyle(color: Colors.yellow),
    r'[a-zA-Z0-9]+\(.*\)': TextStyle(color: Colors.green),
  },
  stringMap: {
    "void": TextStyle(fontWeight: FontWeight.bold, color: Colors.red),
    "print": TextStyle(fontWeight: FontWeight.bold, color: Colors.blue),
  },
);

Code Modifiers

Code modifiers can be created to react to special keystrokes. The default modifiers handle tab to space & automatic indentation. Here's the implementation of the default TabModifier

class TabModifier extends CodeModifier {
  const TabModifier() : super('\t');

  @override
  TextEditingValue? updateString(
      String text, TextSelection sel, EditorParams params) {
    final tmp = replace(text, sel.start, sel.end, " " * params.tabSpaces);
    return tmp;
  }
}

API

CodeField
const CodeField({
    Key? key,
    required this.controller,
    this.minLines,
    this.maxLines,
    this.expands = false,
    this.wrap = false,
    this.background,
    this.decoration,
    this.textStyle,
    this.padding = EdgeInsets.zero,
    this.lineNumberStyle = const LineNumberStyle(),
    this.enabled,
    this.onTap,
    this.readOnly = false,
    this.cursorColor,
    this.textSelectionTheme,
    this.lineNumberBuilder,
    this.focusNode,
    this.onChanged,
    this.isDense = false,
    this.smartQuotesType,
    this.keyboardType,
    this.lineNumbers = true,
    this.horizontalScroll = true,
    this.selectionControls,
    this.hintText,
    this.hintStyle,
  })
LineNumberStyle
  const LineNumberStyle({
    this.width = 42.0,
    this.textAlign = TextAlign.right,
    this.margin = 10.0,
    this.textStyle,
    this.background,
  });
CodeController
CodeController({
    String? text,
    Mode? language,
    this.patternMap,
    this.stringMap,
    this.params = const EditorParams(),
    this.modifiers = const [
      IndentModifier(),
      CloseBlockModifier(),
      TabModifier(),
    ],
  }) 

Limitations

Notes

A breaking change to the TextEditingController was introduced in flutter beta, dev & master channels. The branch beta should comply with those changes.

所属分类

依赖

依赖清单 3 项

源码仓库

使用此插件的项目