draftail

draftail

A batteries-excluded rich text editor based on Draft.js. :memo::cocktail:

This is a work in progress. It is intended to be integrated into Wagtail. Try a demo now.

npm install --save draftail
# Draftail's peerDependencies:
npm install --save draft-js@^0.9.x draftjs-utils@^0.3.2 immutable@^3.x.x react@^15.x.x react-dom@^15.x.x

There are other, not so explicit dependencies at the moment:

• jQuery 2, separately loaded onto the page.
• Specific styles from Wagtail, including its icon font.
• ES6 polyfill (like for Draft.js)

Development

Install

Clone the project on your computer, and install Node. This project also uses nvm.

nvm install
# Then, install all project dependencies.
npm install
# Optionally, install the git hooks.
./.githooks/deploy

Working on the project

Everything mentioned in the installation process should already be done.

# Make sure you use the right node version.
nvm use
# Start the server and the development tools.
npm run start
# Runs linting.
npm run lint
# Runs tests.
npm run test
# View other available commands with:
npm run

Publish

git release x.y.z
npm run dist
# Use irish-pub to check the package content. Install w/ npm install -g first.
irish-pub
npm publish

Changelog

[v0.3.0]

This release contains breaking changes.

Added

• Keyboard shortcuts documentation

Changed

• Expose onSave hook instead of auto field saving (https://github.com/springload/draftail/issues/23)

Fixed

• https://github.com/springload/draftail/issues/2
• https://github.com/springload/draftail/issues/3
• https://github.com/springload/draftail/issues/28