draftail

Draftail

:memo::cocktail: A configurable rich text editor built with Draft.js. Check out our demos!

Features

Draftail aims for a mouse-free, keyboard-centric experience. Most formatting can be done by using common keyboard shortcuts, inspired by Google Docs and Markdown.

Here are important features worth highlighting:

• Support for keyboard shortcuts. Lots of them!
• Paste from Word. Or any other editor.
• Autolists – start a line with - , * , 1. to create a list item.
• Shortcuts for heading levels ##, code blocks ```, and more.
• Undo / redo – until the end of times.
• Common text types: headings, paragraphs, quotes, lists.
• Common text styles: Bold, italic, and many more.
• API to build custom controls for links, images, and more.

This project adheres to Semantic Versioning, and measures performance and code coverage. It uses Flow types. We also try to follow accessibility best practices (tested with aXe) – please get in touch if you can help us do better in this area.

Documentation

• Getting started
• API reference
• User guide
• Getting started with extensions

Contributing

See anything you like in here? Anything missing? We welcome all support, whether on bug reports, feature requests, code, design, reviews, tests, documentation, and more. Please have a look at our contribution guidelines.

If you just want to set up the project on your own computer, the contribution guidelines also contain all of the setup commands.

Credits

Draftail is made possible by the work of Springload. View the full list of contributors. MIT licensed.

Changelog

[v1.1.0]

Documentation: draftail.org/docs/1.1.0/getting-started

🎉 blog post for this release: Draftail v1.1.0: a quality of life release.

Added

• Add onFocus and onBlur props to use callbacks on those events. This can be useful for form validation. #170, #174, thanks to @TheSpicyMeatball.

Fixed

• Stop unnecessarily calling onSave in the editor’s onBlur (#173).
• Prevent crash when filtering pasted content whose last block is to be removed (e.g. unsupported image) (#179).
• Prevent crash in DraftUtils.getEntitySelection, when the provided entity key isn't valid (undefined, missing) (#168).
• Fix entity removal and editing not doing anything when the selection is backwards (right to left) (#168).

Changed

• Update draftjs-filters dependency (#179).
• Update draftjs-conductor dependency.

Removed

• Remove all PropTypes. The project is now typed with Flow (#127, #178).
• Remove peerDependency on prop-types (#127, #178).