Draftail Versions Save

Documentation: draftail.org/docs/getting-started

Fixed

• Fix plugin keyBindingFns not being called. #246, #445

Documentation: draftail.org/docs/getting-started

Added

• Make it possible to hide buttons with default labels by setting their label to null. #442

Changed

• Improve the editor props’ JSDoc annotations. #441

Fixed

• Fix empty buttons appearing when providing custom formats without a defined label or icon. #442
• Clear save timeout handler when unmounting the editor. #208, #443

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

🎉 blog post for this release: Draftail v1.3.0: community improvements, beyond Wagtail.

Added

• Add ability to disable the editor on demand with the readOnly prop, matching behavior of Draft.js. #201, #206, thanks to @SpearThruster.
• Add ability to use the editor as a controlled component, like vanilla Draft.js editors, with editorState and onChange props. Have a look at the controlled component documentation for further details. #180, #207.

Fixed

• Fix undo/redo button icons not being customisable (#195, #196).

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

Fixed

• Fix regression introduced in v1.2.0 where Draft.js-defined keyboard shortcuts were available unconditionally (#189).

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

🎉 blog post for this release: Draftail v1.2.0: supporting modern experiences.

Added

• Add plugins API to support extensions of the editor using the draft-js-plugins architecture (#83, #171).

This new API makes it possible to build much more advanced extensions to the editor than ever before, such as autocompletes, linkify, custom blocks, custom toolbars, and more. Read the release blog post to learn more about the motivation for those new APIs.

• Add data reset parameter to DraftUtils.resetBlockWithType().
• Add ability to disable or customise the editor toolbar with topToolbar.
• Add ability to add a toolbar below the editor with bottomToolbar.
• Add support for Markdown shortcuts for inline styles, e.g. ** for bold, _ for italic, etc (#134, #187). View the full list of keyboard shortcuts.

Changed

• Enable list continuation on Enter for custom *-list-item blocks. All that’s required is for the block type to end with -list-item.

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

Added

• Implement list depth normalisation on copy/paste.
• Add title attributes on buttons to display keyboard shortcuts. Fix #37.
• Override default code-block element. Fix #41.

Changed

• Update project to use [email protected] API
• Move draftjs-utils peerDependency to be a dependency.
• Move immutable peerDependency to be a dependency.
• Copy/paste of rich text is now configurable via the stripPastedStyles option.
• Copy/paste of rich text is now disabled by default. This will be enabled by default once it is better supported.

Fixed

• Fix image block not unlocking editor on cancel.

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.

Added

• Allow customisation of block style function & block render map.