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

ES6 polyfills for Draft.js are also required.

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 vx.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.4.0]

Added

• Make hr availability configurable with enableHorizontalRule. #25.
• Add br support, availability configurable with enableLineBreak.
• Prevent soft line breaks from keyboard shortcut if disabled.
• Add editor CSS to published package. #17
• Add common keyboard shortcuts (inspired by Google Docs, see documentation for the full list).
• Add support for "autolist" behavior (lines starting with -, *, 1. are automatically converted to list items).

Changed

• Max nested list level is now 1.
• Max nested list level is now configurable via a prop.
• Save interval is now configurable via a prop.
• Change hr representation to use atomic block and entity instead of custom block type. #1
• mediaControls, dialogControls and modelPickerOptions are now a single entityTypes array. #26
• sources and decorators are now declared directly in the entityTypes array items.
• INLINE_STYLES property is now inlineStyles.
• BLOCK_TYPES property is now blockTypes.
• Inline styles and block types now use the type attribute instead of style.
• imageFormats are now assigned directly on the IMAGE entity type. #33
• All options are now direct props of DraftailEditor instead of attributes of the options prop. #21

Fixed

• Fix erratic behavior of list nesting changes with tab and shift+tab shortcuts. #34
• Fix keyboard shortcuts giving access to unallowed formatting. #32
• Fix tooltip not opening when clicking decorator icon. #5

Removed

• draftail no longer depends on jQuery.
• draftail no longer depends on the Wagtail font icon.