📝🍸 A configurable rich text editor built with Draft.js
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.githooks Remove unused commit message linter Sep 29, 2018
.github Auto-install the git hooks on npm install Sep 29, 2018
.storybook Add i18n demo with react-intl Nov 9, 2018
docs Finish migrating build from Webpack to Storybook Oct 27, 2018
examples Fix incorrect button types for source modals in examples Dec 7, 2018
lib Reformat whole project to 2-space indent Sep 29, 2018
public Move examples from /examples/ to /storybook/ Nov 18, 2018
tests Move examples from /examples/ to /storybook/ Nov 18, 2018
.babelrc Reformat whole project to 2-space indent Sep 29, 2018
.editorconfig Switch formatting tools to 2-space indent for all files Sep 29, 2018
.eslintignore Switch to rollup for package compilation Jan 11, 2018
.eslintrc.js Reformat whole project to 2-space indent Sep 29, 2018
.gitignore Move examples from /examples/ to /storybook/ Nov 18, 2018
.nvmrc Upgrade to Node 10 Sep 29, 2018
.prettierignore Move examples from /examples/ to /storybook/ Nov 18, 2018
.travis.yml Fix Travis Danger command Oct 26, 2018
CHANGELOG.md Reformat whole project to 2-space indent Sep 29, 2018
LICENSE Process all Markdown through Prettier Nov 28, 2017
README.md README cleanup Nov 22, 2018
dangerfile.js Further migrate to new user guide location Oct 27, 2018
package-lock.json Add HTML import/export demo with draft-convert Nov 14, 2018
package.json Change project tagline Nov 22, 2018
prettier.config.js Switch formatting tools to 2-space indent for all files Sep 29, 2018
rollup.config.js Reformat whole project to 2-space indent Sep 29, 2018
stylelint.config.js Reformat whole project to 2-space indent Sep 29, 2018

README.md

Draftail npm Build Status Coverage Status Wagtail

📝🍸 A configurable rich text editor built with Draft.js. Check out our demos!

Screenshot of Draftail

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. 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

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.