code_field

Codefield

Un campo de texto de código personalizable que admite la sintaxis resaltando

Demostración en vivo

Una demostración en vivo que muestra algunas combinaciones de idioma / tema

Escaparate

La VM Dlox experimental usa Codefield en su editor en línea

Características

• Código destacado para 189 idiomas incorporados con 90 temas gracias a Flutter_highlight
• El lenguaje fácil resalta la personalización a través del uso de mapas de temas
• Estilo de campo de código totalmente personalizable a través de un campo de texto como API
• Maneja el desplazamiento horizontal/vertical y la expansión vertical
• Admite modificadores de código
• Funciona en Android, iOS, Web, MacOS, Windows y Linux

Los modificadores de código ayudan a administrar las sangrías automáticamente

El editor está envuelto en un contenedor desplazable horizontal para manejar largas colas

Instalación

En el pubspec.yaml de su proyecto Flutter, agregue la siguiente dependencia:

 dependencies :
  ...
  code_text_field : <latest_version>

última versión

En su biblioteca, agregue la siguiente importación:

 import 'package:code_text_field/code_text_field.dart' ;

Ejemplo simple

Un widget de CodeField funciona con un código de código que analiza dinámicamente la entrada de texto de acuerdo con un idioma y lo convierte con un mapa de tema

 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' ),
      ),
    );
  }
}

Aquí, el código fuente de fuente monoSospace se ha agregado a la carpeta de activos y al archivo pubspec.yaml.

Opciones de analizador

Además de una definición de idioma, el estilo de palabras se puede especificar en el campo StringMap

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

También se pueden usar regexas más complejos con PatternMap . Sin embargo, cuando se usa un lenguaje, sus patrones regexos tienen prioridad sobre Pattern MAP y StringMap .

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

Tanto PatternMap como StringMap se pueden usar sin especificar un idioma.

_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),
  },
);

Modificadores de código

Se pueden crear modificadores de código para reaccionar a las teclas especiales. La pestaña de manejo de modificadores predeterminados para el espacio y la sangría automática. Aquí está la implementación del TabModifier predeterminado

 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,
  })

Estilo lino

  const LineNumberStyle ({
    this .width = 42.0 ,
    this .textAlign = TextAlign .right,
    this .margin = 10.0 ,
    this .textStyle,
    this .background,
  });

Codecontrolador

 CodeController ({
    String ? text,
    Mode ? language,
    this .patternMap,
    this .stringMap,
    this .params = const EditorParams (),
    this .modifiers = const [
      IndentModifier (),
      CloseBlockModifier (),
      TabModifier (),
    ],
  }) 

Limitaciones

• La discapacidad de autocompletar en Android aún no funciona

Notas

Se introdujo un cambio de ruptura en TextEditingController en los canales Beta, Dev y Master de Flutter. La rama beta debe cumplir con esos cambios.