editor.js/docs/CHANGELOG.md

Changelog

2.26.0

• New — UI — Block Tunes became vertical just like the Toolbox 🤩
• New — Block Tunes API — Now render() method of a Block Tune can return config with just icon, label and callback instead of custom HTML. This improvement is a key to the new straightforward way of configuring tune's appearance in Block Tunes menu.
• New — Tools API — As well as render() in Tunes API, Tool's renderSettings() now also supports new configuration format.
• New — UI — Meet the new icons from CodeX Icons pack 🛍 💝
• New — BlocksAPI — the blocks.insert() method now also have the optional id param. If passed, this id will be used instead of the generated one.
• Deprecated — Styles API — CSS classes .cdx-settings-button and .cdx-settings-button--active are not recommended to use. Consider configuring your block settings with new JSON API instead.
• Fix — Wrong element not highlighted anymore when popover opened.
• Fix — When Tunes Menu open keydown events can not be handled inside plugins.
• Fix — If a Tool specifies some tags to substitute on paste, all attributes of that tags will be removed before passing them to the tool. Possible XSS vulnerability fixed.
• Fix — Pasting from Microsoft Word to Chrome (Mac OS) fixed. Now if there are no image-tools connected, regular text content will be pasted.
• Fix — Workaround for the HTMLJanitor bug with Tables (https://github.com/guardian/html-janitor/issues/3) added
• Fix — Toolbox shortcuts appearance and execution fixed #2112
• Improvement — Tools API — pasteConfig().tags now support sanitizing configuration. It allows you to leave some explicitly specified attributes for pasted content.
• Improvement — CodeStyle — CodeX ESLint Config has bee updated. All ESLint/Spelling issues resolved
• Improvement — ToolsAPI — The icon property of the toolbox getter became optional.

2.25.0

• New — Tools API — Introducing new feature — toolbox now can have multiple entries for one tool!
  Due to that API changes: tool's toolbox getter now can return either a single config item or an array of config items
• New — Blocks API — composeBlockData() method was added.

2.24.4

• Fix — Keyboard selection by word #2045

2.24.3

• Fix — Issue with toolbox preventing text selection fixed

2.24.2

• Fix — Scrolling issue when opening toolbox on mobile fixed
• Fix — Typo in toolbox empty placeholder fixed
• Fix — The issue with scroll jumping on block hovering have fixed 2036
• Improvement — Dev Example Page - Add popup example page
• Improvement — UI - The Toolbox will restore the internal scroll on every opening

2.24.1

— Fix — The I18n of Tools` titles at the Toolbox now works correctly #2030

2.24.0

• New — UI — The Toolbox became vertical 🥳
• Improvement — UI — the Plus button will always be shown (previously, it appears only for empty blocks)
• Improvement — Dev Example Page - Server added to allow opening example page on other devices in network.
• Fix — UI — the Toolbar won't move on hover at mobile viewports. Resolves #1972
• Fix — OnChange event invocation after block insertion. #1997
• Fix — ReadOnly — the readonly.isEnabled API getter now works correctly after readonly.toggle() calling. Resolves #1822
• Fix — Paste — the inline HTML tags now will be preserved on pasting. #1686

2.23.2

— Fix — Crash on initialization in the read-only mode #1968

2.23.1

— Fix — Incorrect release tag fixed

2.23.0

• Improvement — EditorConfig — The onChange callback now accepts two arguments: EditorJS API and the CustomEvent with type and detail allowing to determine what happened with a Block
• New — Block API — The new dispatchChange() method allows to manually trigger the 'onChange' callback. Useful when Tool made a state mutation that is invisible for editor core.
• Improvement — UI — Block Tunes toggler moved to the left
• Improvement — UI — Block Actions (BT toggler + Plus Button) will appear on block hovering instead of click
• Improvement — UI — Block Tunes toggler icon and Plus button icon updated
• Improvement — Dev Example Page — The menu with helpful buttons added to the bottom of the screen
• Improvement — Dev Example Page — The 'dark' theme added. Now we can code at night more comfortably.
• Improvement — Rectangle Selection — paint optimized
• Fix — Rectangle Selection — the first click after RS was not clear selection state. Now does.
• Improvement — Blocks API — toolbar moving logic removed from blocks.move() and blocks.swap() methods. Instead, you should use Toolbar API (it was used by MoveUp and MoveDown tunes, they were updated).
• New — Blocks API — The getBlockIndex() method added
• New — Blocks API — the insert() method now has the replace: boolean parameter
• New — Blocks API — the insert() method now returns the inserted Block API
• New — Listeners API — the on() method now returns the listener id.
• New — Listeners API — the new offById() method added
• New — API — The new UiApi section was added. It allows accessing some editor UI nodes and methods.
• Refactoring — Toolbox became a standalone class instead of a Module. It can be accessed only through the Toolbar module.
• Refactoring — CI flow optimized.
• Fix - Recognize async onPaste handlers in tools #1803.
• Fix — Fire onChange event for native inputs #1750

2.22.3

• Fix — Tool config is passed to prepare method editor-js/embed#68

2.22.2

• Improvement — Inline Toolbar might be used for any contenteditable element inside Editor.js zone
• Improvement Tunes API - Tunes now can provide sanitize configuration
• Fix Tunes API - Tune config now passed to constructor under config property
• Fix Types - Add common type for internal and external Tools configuration
• Fix — Block's destroy method is called on block deletion
• Fix - Fix jump to the button of editor zone on CBS

2.22.1

• Fix — I18n for internal Block Tunes #1661

2.22.0

• New - onChange callback now receive Block API object of affected block
• New - API method blocks.update(id, data) added.

2.21.0

• New - Blocks now have unique ids #873

2.20.2

• Fix — Append default Tunes if user tunes are provided for Block Tool #1640
• Fix - Prevent the leak of codex-tooltip when Editor.js is destroyed #1475.
• Refactoring - Notifier module now is a util.

2.20.1

• Fix - Create a new block when clicked at the bottom #1588.
• Fix — Fix sanitization problem with Inline Tools #1631
• Fix — Fix copy in FireFox 1625
• Refactoring - The Sanitizer module is util now.
• Refactoring - Tooltip module is util now.
• Refactoring — Refactoring based on LGTM #1577.
• Refactoring — Refactoring based on ESLint #1636.

2.20.0

• New — Block Tunes API added

2.19.3

• Fix — Ignore error raised by Shortcut module

2.19.2

• New - toolbar.toggleBlockSettings() API method added #1442.
• Improvements - A generic type for Tool config added #1516
• Improvements - Remove unused force option in Caret.navigateNext() and Caret.navigatePrevious() #857.
• Improvements - Remove bundles from the repo #1541.
• Improvements - Document will be scrolled when blocks are selected with SHIFT+UP or SHIFT+DOWN #1447
• Improvements - The caret will be set on editor copy/paste #1470
• Improvements - Added generic types to OutputBlockData #1551.
• Fix - Fix BlockManager.setCurrentBlockByChildNode() with multiple Editor.js instances #1503.
• Fix - Fix an unstable block cut process #1489.
• Fix - Type definition of the Sanitizer config: the sanitize function now contains param definition #1491.
• Fix - Fix unexpected behavior on an empty link pasting #1348.
• Fix - Fix SanitizerConfig type definition #1513
• Refactoring - The Listeners module now is a util.
• Refactoring - The Events module now is a util.
• Fix - Editor Config now immutable #1552.
• Refactoring - Shortcuts module is util now.
• Fix - Fix bubbling on BlockManagers' listener #1433.

2.19.1

• Improvements - The Cypress was integrated as the end-to-end testing framework
• Improvements - Native typeofreplaced with custom utils methods
• Improvements - Bind shortcuts listeners on the editor wrapper instead of document #1391
• Fix - The problem with destroy() method #1380.
• Fix - add getter keyword to block.mergeable method #1415.
• Fix — Fix problem with entering to Editor.js by Tab key #1393
• Fix - Sanitize pasted block data #1396.
• Fix - Unnecessary block creation after arrow navigation at last non-default block#1414

2.19

• New - Read-only mode 🥳 #837
• New - RTL mode added #670
• New - Allows users to provide common inlineToolbar property which will be used for all tools whose inlineToolbar property is set to true. It can be overridden by the tool's own inlineToolbar property. Also, inline tools will be ordered according to the order of the inline tools in array provided in the inlineToolbar property. #1056
• New - Tool's reset static method added to the API to clean up any data added by Tool on initialization
• Improvements - The initialBlock property of Editor config is deprecated. Use the defaultBlock instead. #993
• Improvements - BlockAPI call() method now returns the result of calling method, thus allowing it to expose arbitrary data as needed #1205
• Improvements - Useless log about missed i18n section has been removed #1269
• Improvements - Allowed to set false as toolbox config in order to hide Toolbox button #1221
• Fix — Fix problem with types usage #1183
• Fix - Fixed issue with Spam clicking the "Click to tune" button duplicates the icons on FireFox. #1273
• Fix - Fixed issue with editor.blocks.delete(index) method which throws an error when Editor.js is not focused, even after providing a valid index. #1182
• Fix - Fixed the issue of toolbar not disappearing on entering input in Chinese, Hindi and some other languages. #1196
• Fix - Do not stop events propagation if not needed (essential for React synthetic events) #1051 #946
• Fix - Tool's destroy method is not invoked when editor.destroy() is called. #1047
• Fix - Fixed issue with enter key in inputs and textareas #920
• Fix - blocks.getBlockByIndex() API method now returns void for indexes out of range #1270
• Fix - Fixed the Tab key behavior when the caret is not set inside contenteditable element, but the block is selected #1302.
• Fix - Fixed the onChange callback issue. This method didn't be called for native inputs before some contenteditable element changed #843
• Fix - Fixed the onChange callback issue. This method didn't be called after the callback throws an exception #1339
• Fix - The internal shortcut getter of Tools classes will work now.
• Deprecated — The Inline Tool clear() method is deprecated because the new instance of Inline Tools will be created on every showing of the Inline Toolbar

2.18

• New I18n API — Ability to provide internalization for Editor.js core and tools. #751
• New — Block API that allows you to access certain Block properties and methods
• Improvements - TSLint (deprecated) replaced with ESLint, old config changed to CodeX ESLint Config.
• Improvements - Fix many code-style issues, add missed annotations.
• Improvements - Adjusted GitHub action for ESLint.
• Improvements - Blocks API: if blocks.delete method is called, but no Block is selected, show warning instead of throwing an error #1102
• Improvements - Blocks API: allow deletion of blocks by specifying block index via blocks.delete(index).
• Improvements - UX: Navigate next Block from the last non-initial one creates new initial Block now #1103
• Improvements - Improve performance of DOM traversing at the isEmpty() method #1095
• Improvements - CODE OF CONDUCT added
• Improvements - Disabled useCapture flag for a block keydown handling. That will allow plugins to override keydown and stop event propagation, for example, to make own Tab behavior.
• Improvements - All modules now might have destroy method called on Editor.js destroy
• Improvements - Block settings can contain text inputs, focus will be restored after settings closed #1090
• Fix - Editor's styles won't be appended to the <head> when another instance have already do that #1079
• Fix - Fixed wrong toolbar icon centering in Firefox #1120
• Fix - Toolbox: Tool's order in Toolbox now saved in accordance with tools object keys order #1073
• Fix - Setting autofocus config property to true cause adding .ce-block--focused for the autofocused block #1073
• Fix - Public getter shortcut now works for Inline Tools #1132
• Fix - CMD+A handler removed after Editor.js destroy #1133

Breaking changes blocks.getBlockByIndex method now returns BlockAPI object. To access old value, use BlockAPI.holder property

2.17

• Improvements - Editor's onchange callback now accepts an API as a parameter
• Fix - Some mistakes are fixed in installation.md
• Fix - Fixed multiple paste callback triggering in a case when several editors are instantiated #1011
• Fix - Fixed inline toolbar flipper activation on closing conversion toolbar #995
• Improvements - New window tab is opened by clicking on anchor with ctrl #1057
• Fix - Fix block-tune buttons alignment in some CSS-resetors that forces box-sizing: border-box rule #1003
• Improvements - New style of a Block Settings button. Focused block background removed.
• New — Add in-house copy-paste support through application/x-editor-js mime-type
• New Block lifecycle hook moved
• Deprecated — blocks.swap(fromIndex, toIndex) method is deprecated. Use blocks.move(toIndex, fromIndex) instead.
• Fix — Improve plain text paste #1012
• Fix — Fix multiline paste #1015

2.16.1

• Fix — Fix Firefox bug with incorrect height and cursor position of empty content editable elements #947 #876 #608 #876
• Fix — Set initial hidden Inline Toolbar position #979
• Fix — Fix issue with CodeX.Tooltips TypeScript definitions #978
• Fix — Fix some issues with Inline and Tunes toolbars.
• Fix - Fix minHeight option with zero-value issue #724
• Improvements — Disable Conversion Toolbar if there are no Tools to convert #984

2.16

• Improvements — Inline Toolbar design improved
• Improvements — Conversion Toolbar now included in the Inline Toolbar #853
• Improvements — All buttons now have beautiful Tooltips provided by CodeX Tooltips
• New — new Tooltips API for displaying tooltips near your custom elements
• New API — Block lifecycle hooks
• New Inline Tools API — Ability to specify Tool's title via title static getter.
• Fix — On selection from end to start backspace is working as expected now #869
• Fix — Fix flipper with empty dom iterator #926
• Fix — Normalize node before walking through children at isEmpty method #943
• Fix — Fixed Grammarly conflict #779
• Improvements — Module Listeners now correctly removes events with options #904
• Improvements — Styles API: .cdx-block default vertical margins decreased from 0.7 to 0.4 ems.
• Fix — Fixed getRangeCount call if range count is 0 #938
• New — Log levels now available to suppress Editor.js console messages #962
• Fix — Fixed wrong navigation on block deletion

2.15.1

• Refactoring — Constants of tools settings separated by internal and external to correspond API
• Refactoring — Created universal Flipper class that responses for navigation by keyboard inside of any Toolbars
• Fix — First CMD+A on block with now uses default behaviour. Fixed problem with second CMD+A after selection clearing #827
• Improvements — Style of inline selection and selected blocks improved
• Fix - Fixed problem when property 'observer' in modificationObserver is not defined

2.15

• New — New blocks.insert() API method #715.
• New Conversion Toolbar — Ability to convert one block to another #704
• New Cross-block selection — Ability to select multiple blocks by mouse and with SHIFT+ARROWS #703
• Deprecated — blocks.insertNewBlock() method is deprecated. Use blocks.insert() instead.
• Improvements — Inline Toolbar now works on mobile devices #706
• Improvements — Toolbar looks better on mobile devices #706
• Improvements — Now pasteConfig can return false to disable paste handling on your Tool #801
• Fix — EditorConfig's onChange callback now fires when native inputs` content has been changed #794
• Fix — Resolve bug with deleting leading new lines #726
• Fix — Fix inline link Tool to support different link types like mailto and tel #809
• Fix — Added typeof util method to check exact object type #805
• Fix — Remove internal enableLineBreaks option from external Tool settings type description #825

2.14

• Fix Config — User config now has higher priority than internal settings #771
• New — Ability to work with Block Actions and Inline Toolbar from the keyboard by Tab. #705
• Fix — Fix error thrown by click on the empty editor after blocks.clear() method calling #761
• Fix — Fix placeholder property appearance. Now you can assign it via placeholder property of EditorConfig. #714
• Fix — Add API shorthands to TS types #788

2.13

• Improvements BlockSelection — Block Selection allows to select single editable element via CMD+A
• New API — Added API methods to open and close inline toolbar #665
• New Config - Added new property in EditorConfig holder, use this property for append Editor instead holderId. holder property now support reference on dom element. #696
• Deprecated Config - holderId property now is deprecated and will removed in next major release. Use holder instead.
• Fix Types — Fixed error with codex-notifier package #713
• Improvements — Close inline toolbar after creating a new link.
• New Config — Option minHeight for customizing Editor's bottom zone height added.

2.12.4

• Improvements — CodeX.Shortcuts version updated to the v1.1 #684
• Fix — Do not start multi-block selection on Toolbox and Inline Toolbar #646
• Fix — Minor fixes of caret behaviour #663
• Fix — Fix inline-link icon position in Firefox #674

2.12.3

• Fix — Make Toolbox tooltip position font-size independent

2.12.2

• New Inline Tools — pass tool settings from configuration to Tool constructor

2.12.1

• Fix — Fix processing color-mod function in styles

2.12.0

• New API - new blocks API method renderFromHTML

2.11.11

• New — Add ability to pass configuration for internal Tools

2.11.10

• Fix - Fix editor view on mobile devices

2.11.9

• Fix - Fix inline toolbar buttons margin. Update dependencies list. Update tools for example page.

2.11.8

• Fix — Block tunes margins now better works with more than 3 buttons

2.11.7

• Fix Paste — Fix pasting into non-initial Blocks

2.11.6

• Fix Paste — Polyfill for Microsoft Edge

2.11.5

• Fix RectangleSelection — Redesign of the scrolling zones

2.11.4

• Fix - Clear focus when click is outside the Editor instance

2.11.3

• Fix — Fix CMD+A Selection on multiple Editor instances

2.11.2

• Improvements — Docs updated and common enhancements

2.11.1

• Fix RectangleSelection — Selection is available only for the main mouse button

2.11.0

• New — Add API methods shorthands

2.10.0

• New — Rename from CodeX Editor to Editor.js

2.9.5

• New — Toolbox now have beautiful helpers with Tool names and shortcuts

2.9.4

• Improvements — Prevent navigating back on Firefox when Block is removing by backspace

2.9.3

• Fix — Handle paste only on initial Block

2.9.2

• New — Blocks selected with Rectangle Selection can be also removed, copied or cut

2.9.1

• Improvements — Migrate from postcss-cssnext to postcss-preset-env and disable postcss-custom-properties which conflicts with postcss-preset-env

2.9.0

• New RectangleSelection — Ability to select Block or several Blocks with mouse

2.8.1

• Fix Caret — Fix "History back" call on backspace in Firefox

2.8.0

• Improvements API — Added API methods to manage caret position

2.7.32

• Improvements Types — TypeScript types sre updated

2.7.31

• Fix — Caret now goes through elements without type attribute

2.7.30

• Fix — Fixed selection behavior when text has modifiers form Inline Toolbar

2.7.29

• Fix — cmd+x works only for custom selection now

2.7.28

• New Tools Validation is added.

2.2.27

• New Mobile view — Editor now adopted for mobile devices
• New Narrow mode — Editor now adopted for narrow containers

2.2.26

• Improvements Caret — Improvements of the caret behaviour: arrows, backspace and enter keys better handling.

2.2.25

• New Autofocus — Now you can set focus at Editor after page has been loaded

2.2.24

• Improvements Paste handling — minor paste handling improvements

2.2.23

• New Shortcuts — copy and cut Blocks selected by CMD+A

2.2—2.7

• New Sanitize API — Sanitize Config of Block Tools now automatically extends by tags of Inline Tools that is enabled by current Tool by inlineToolbar option. You don't need more to specify a, b, mark, code manually. This feature will be added to fields that supports inline markup.
• New Block Selection — Ability to select Block by CMD+A, and the whole Editor by double CMD+A. After that, you can copy (CMD+C), remove (Backspace) or clear (Enter) selected Blocks.
• New Styles API — Added button class for stylization of any buttons provided by Tools with one unified style.
• New Notifier API — methods for showing user notifications: on success, errors, warnings, etc.
• New Block Tool — Table constructor 💪
• New If one of the Tools is unavailable on Editor initialization, its Blocks will be rendered with Dummy Block, describing that user can not edit content of this Block. Dummy Blocks can be moved, removed and saved as normal Blocks. So saved data won't be lost if one of the Tools is failed
• New Public TS-types are presented.
• Changes Tools API — options irreplaceable and contentless was removed.
• Changes Tools API — Paste API: tags, patterns and mime-types now should be specified by Tool's pasteConfig static property. Custom Paste Event should be handled by onPaste(event) that should not be static from now.
• Changes Tools API — options displayInToolbox and toolboxIcon was removed. Use toolbox instead, that should return object with icon and title field, or false if Tool should not be placed at the Toolbox. Also, there are a way to override toolbox {icon, title} settings provided by Tool with you own settings at the Initial Config.
• Improvements — All Projects code now on TypeScript
• Improvements — NPM package size decreased from 1300kb to 422kb
• Improvements — Bundle size decreased from 438kb to 252kb
• Improvements — Inline Toolbar: when you add a Link to the selected fragment, Editor will highlight this fragment even when Caret is placed into the URL-input.
• Improvements — Block Settings won't be shown near empty Blocks of initialType by default. You should click on them instead.
• Improvements — onChange-callback now will be fired even with children attributes changing.
• Improvements — HTMLJanitor package was updated due to found vulnerability
• Improvements — Logging improved: now all Editor's logs will be preceded by beautiful label with current Editor version.
• Improvements — Internal isEmpty checking was improved for Blocks with many children nodes (200 and more)
• Improvements — Paste improvements: tags that can be substituted by Tool now will matched even on deep-level of pasted DOM three.
• Improvements — There is no more «unavailable» sound on copying Block by CMD+C on macOS
• Improvements — Dozens of bugfixes and small improvements

See a whole Changelog

2.1-beta changelog

• New Tools API — support pasted content via drag-n-drop or from the Buffer. See documentation and example at the Simple Image Tool.
• New Tools API — new sanitize getter for Tools for automatic HTML sanitizing of returned data. See documentation and example at the Paragraph Tool
• New Added onChange-callback, fired after any modifications at the Editor. See documentation.
• New New Inline Tool example — Marker
• New New Inline Tool example — Code
• New New Editor.js PHP — example of server-side implementation with HTML purifying and data validation.
• Improvements - Improvements of Toolbar's position calculation.
• Improvements — Improved zero-configuration initialization.
• and many little improvements.