Classeur ContentEditable engine
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo
dist
scripts
.gitignore
.travis.yml
LICENSE
README.md
gulpfile.js
package.json

README.md

cledit

Build Status NPM version

Classeur ContentEditable engine

This library is the module powering Classeur's file editor. It's based on StackEdit's editor module, which is itself based on the editor implemented in Dabblet.

The main purpose is to have a lightweight layer on top of a built-in contenteditable text field, to provide the following features:

  • Syntax highlighting
  • Selection getter, setter, change listener, cursor coordinates...
  • Custom undo/redo behaviors
  • Custom keystrokes

The benefits over ACE/CodeMirror are:

  • Pluggable syntax highlighting (works beautifully with Prism.js)
  • Browser built-in spellchecking
  • Mobile device support

cledit relies on browsers built-in MutationObserver API. IE11+ is required.
cledit uses Google's DiffMatchPatch library as a dependency.

Install

npm install cledit --save

Use

A usage example can be found in the demo folder.

License

Apache