Search packages, repositories and app categories

Package detailsv0.7.14+5.65.18

codemirror

A Dart wrapper around the CodeMirror text editor.

Web
30-day downloads
1.3K
Likes
20
Pub points
120

Install package

flutter pub add codemirror

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

A Dart wrapper for the CodeMirror text editor, enabling rich code editing capabilities in Flutter web applications. It provides syntax highlighting, line numbering, and customizable themes, leveraging the powerful CodeMirror library directly in the browser. This package is ideal for building interactive code editors, IDE-like features, or any application requiring advanced text editing with language-specific syntax support. The integration is seamless for web-only Flutter projects, ensuring a familiar and performant editing experience.

Use cases

  • Web-based code editors
  • Interactive coding tutorials
  • IDE-like web applications
  • Real-time code collaboration
  • Syntax-highlighted input fields

Key features

  • Syntax highlighting
  • Line numbering
  • Customizable themes
  • Browser-based rendering
  • Extensible via CodeMirror plugins

Suitable for

  • Flutter web developers
  • Educational platforms
  • Code sharing tools
  • Developer tooling
  • Web-based IDEs

Considerations

  • Web-only platform support
  • Requires JavaScript interop
  • Limited to browser environments
  • Dependent on external CodeMirror library
  • May increase bundle size

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

codemirror.dart

Build Status pub package

What is it?

A Dart wrapper around the CodeMirror text editor. From codemirror.net:

CodeMirror is a versatile text editor implemented in JavaScript for the browser. It is specialized for editing code, and comes with a number of language modes and addons that implement more advanced editing functionality.

Note: This is NOT a Flutter package, it is a Dart package for writing web applications like DartPad.

An example

final options = <String, String>{
  'mode': 'javascript',
  'theme': 'monokai'
};

final editor = CodeMirror.fromElement(
    document.querySelector('#textContainer')!, options: options);
editor.doc.setValue('foo.bar(1, 2, 3);');

See also our example/ directory.

How do I use it?

In your main html file, link to the style sheet:

<link href="packages/codemirror/codemirror.css" rel="stylesheet">

reference the CodeMirror JavaScript code:

<script src="packages/codemirror/codemirror.js"></script>

and, in your Dart code, import the library:

import 'package:codemirror/codemirror.dart';

What about modes? Addons?

This Dart package ships with several language modes built in. CodeMirror itself supports over 100 modes; the modes built into the Dart package include the usual suspects for web development - css, html, dart and javascript as well as a few others. In order to add additional modes, you'll need to reference the mode file from your html entry point. So,

<script src="packages/codemirror/mode/lua.js"></script>

will bring in support for Lua.

Similarly with addons, we've included a few common ones, and have made the others available to import on a case-by-case basis. In order to use the active-line addon, import:

<script src="packages/codemirror/addon/selection/active-line.js"></script>

Be aware that many addons need additional configuration in order to enable then. This is generally done by passing values into the options of the CodeMirror constructor.

Some addons are exposed through the main Dart interface. Some are exposed via side-car Dart libraries available in the main package, and some have yet to be exposed. Pull requests welcome :)

Themes

By importing the codemirror.css file:

<link href="packages/codemirror/codemirror.css" rel="stylesheet">

You get access to all the CodeMirror themes. If you only want a few, or don't want to pay the network roundtrip cost to load all the themes, you can import only the ones you're interested in:

<link href="packages/codemirror/theme/monokai.css" rel="stylesheet">
<link href="packages/codemirror/theme/zenburn.css" rel="stylesheet">

Disclaimer

This is not an official Google product.

Categories

Dependencies

Dependency list 1 items

Source repository

Projects using this package

No data available yet.