Improvements
- The Cypress was integrated as the end-to-end testing frameworkImprovements
- Nativetypeof
replaced with custom utils methodsImprovements
- Bind shortcuts listeners on the editor wrapper instead of document (#1391)(codex-team#1391)Fix
- The problem with destroy() method #1380.Fix
- add getter keyword toblock.mergeable
method #1415.Fix
— Fix problem with entering to Editor.js by Tab key #1393Fix
- Sanitize pasted block data #1396.Fix
- Unnecessary block creation after arrow navigation at last non-default block#1414
New
- Read-only mode 🥳 #837New
- RTL mode added #670New
- Allows users to provide commoninlineToolbar
property which will be used for all tools whoseinlineToolbar
property is set totrue
. It can be overridden by the tool's owninlineToolbar
property. Also, inline tools will be ordered according to the order of the inline tools in array provided in theinlineToolbar
property. #1056New
- Tool'sreset
static method added to the API to clean up any data added by Tool on initializationImprovements
- TheinitialBlock
property of Editor config is deprecated. Use thedefaultBlock
instead. #993Improvements
- BlockAPIcall()
method now returns the result of calling method, thus allowing it to expose arbitrary data as needed #1205Improvements
- Unuseful log about missed i18n section has been removed #1269Improvements
- Allowed to setfalse
astoolbox
config in order to hide Toolbox button #1221Fix
— Fix problem with types usage #1183Fix
- Fixed issue with Spam clicking the "Click to tune" button duplicates the icons on FireFox. #1273Fix
- Fixed issue witheditor.blocks.delete(index)
method which throws an error when Editor.js is not focused, even after providing a valid index. #1182Fix
- Fixed the issue of toolbar not disappearing on entering input in Chinese, Hindi and some other languages. #1196Fix
- Do not stop events propagation if not needed (essential for React synthetic events) #1051 #946Fix
- Tool'sdestroy
method is not invoked wheneditor.destroy()
is called. #1047Fix
- Fixed issue with enter key in inputs and textareas #920Fix
- blocks.getBlockByIndex() API method now returns void for indexes out of range #1270Fix
- Fixed theTab
key behavior when the caret is not set inside contenteditable element, but the block is selected #1302.Fix
- Fixed theonChange
callback issue. This method didn't be called for native inputs before some contentedtable element changed #843Fix
- Fixed theonChange
callback issue. This method didn't be called after the callback throws an exception #1339Fix
- The internalshortcut
getter of Tools classes will work now.Deprecated
— The Inline Toolclear()
method is deprecated because the new instance of Inline Tools will be created on every showing of the Inline Toolbar
New
I18n API — Ability to provide internalization for Editor.js core and tools. #751New
— Block API that allows you to access certain Block properties and methodsImprovements
- 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: ifblocks.delete
method is called, but no Block is selected, show warning instead of throwing an error #1102Improvements
- Blocks API: allow deletion of blocks by specifying block index viablocks.delete(index)
.Improvements
- UX: Navigate next Block from the last non-initial one creates new initial Block now #1103Improvements
- Improve performance of DOM traversing at theisEmpty()
method #1095Improvements
- CODE OF CONDUCT addedImprovements
- 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 havedestroy
method called on Editor.js destroyImprovements
- Block settings can contain text inputs, focus will be restored after settings closed #1090Fix
- Editor's styles won't be appended to the<head>
when another instance have already do that #1079Fix
- Fixed wrong toolbar icon centering in Firefox #1120Fix
- Toolbox: Tool's order in Toolbox now saved in accordance withtools
object keys order #1073Fix
- Settingautofocus
config property totrue
cause adding.ce-block--focused
for the autofocused block #1073Fix
- Public gettershortcut
now works for Inline Tools #1132Fix
-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
Improvements
- Editor's onchange callback now accepts an API as a parameterFix
- Some mistakes are fixed in installation.mdFix
- Fixed multiple paste callback triggering in a case when several editors are instantiated #1011Fix
- Fixed inline toolbar flipper activation on closing conversion toolbar #995Improvements
- New window tab is opened by clicking on anchor with ctrl #1057Fix
- Fix block-tune buttons alignment in some CSS-resetors that forcesbox-sizing: border-box
rule #1003Improvements
- New style of a Block Settings button. Focused block background removed.New
— Add in-house copy-paste support throughapplication/x-editor-js
mime-typeNew
Block lifecycle hookmoved
Deprecated
—blocks.swap(fromIndex, toIndex)
method is deprecated. Useblocks.move(toIndex, fromIndex)
instead.Fix
— Improve plain text paste #1012Fix
— Fix multiline paste #1015
Fix
— Fix Firefox bug with incorrect height and cursor position of empty content editable elements #947 #876 #608 #876Fix
— Set initial hidden Inline Toolbar position #979Fix
— Fix issue with CodeX.Toolips TypeScript definitions #978Fix
— Fix some issues with Inline and Tunes toolbars.Fix
- FixminHeight
option with zero-value issue #724Improvements
— Disable Conversion Toolbar if there are no Tools to convert #984
Improvements
— Inline Toolbar design improvedImprovements
— Conversion Toolbar now included in the Inline Toolbar #853Improvements
— All buttons now have beautiful Tooltips provided by CodeX TooltipsNew
— new Tooltips API for displaying tooltips near your custom elementsNew
API — Block lifecycle hooksNew
Inline Tools API — Ability to specify Tool's title viatitle
static getter.Fix
— On selection from end to start backspace is working as expected now #869Fix
— Fix flipper with empty dom iterator #926Fix
— Normalize node before walking through children atisEmpty
method #943Fix
— Fixed Grammarly conflict #779Improvements
— Module Listeners now correctly removes events with options #904Improvements
— Styles API:.cdx-block
default vertical margins decreased from 0.7 to 0.4 ems.Fix
— FixedgetRangeCount
call if range count is 0 #938New
— Log levels now available to suppress Editor.js console messages #962Fix
— Fixed wrong navigation on block deletion
Refactoring
— Constants of tools settings separated by internal and external to correspond APIRefactoring
— Created universal Flipper class that responses for navigation by keyboard inside of any ToolbarsFix
— First CMD+A on block with now uses default behaviour. Fixed problem with second CMD+A after selection clearing #827Improvements
— Style of inline selection and selected blocks improvedFix
- Fixed problem when property 'observer' in modificationObserver is not defined
New
— Newblocks.insert()
API method #715.New
Conversion Toolbar — Ability to convert one block to another #704New
Cross-block selection — Ability to select multiple blocks by mouse and with SHIFT+ARROWS #703Deprecated
—blocks.insertNewBlock()
method is deprecated. Useblocks.insert()
instead.Improvements
— Inline Toolbar now works on mobile devices #706Improvements
— Toolbar looks better on mobile devices #706Improvements
— NowpasteConfig
can returnfalse
to disable paste handling on your Tool #801Fix
— EditorConfig'sonChange
callback now fires when native inputs` content has been changed #794Fix
— Resolve bug with deleting leading new lines #726Fix
— Fix inline link Tool to support different link types likemailto
andtel
#809Fix
— Addedtypeof
util method to check exact object type #805Fix
— Remove internalenableLineBreaks
option from external Tool settings type description #825
Fix
Config — User config now has higher priority than internal settings #771New
— Ability to work with Block Actions and Inline Toolbar from the keyboard by Tab. #705Fix
— Fix error thrown by click on the empty editor afterblocks.clear()
method calling #761Fix
— Fix placeholder property appearance. Now you can assign it viaplaceholder
property of EditorConfig. #714Fix
— Add API shorthands to TS types #788
Improvements
BlockSelection — Block Selection allows to select single editable element via CMD+ANew
API — Added API methods to open and close inline toolbar #665New
Config - Added new property in EditorConfigholder
, use this property for append Editor insteadholderId
.holder
property now support reference on dom element. #696Deprecated
Config -holderId
property now is deprecated and will removed in next major release. Useholder
instead.Fix
Types — Fixed error withcodex-notifier
package #713Improvements
— Close inline toolbar after creating a new link.New
Config — OptionminHeight
for customizing Editor's bottom zone height added.
Improvements
— CodeX.Shortcuts version updated to the v1.1 #684Fix
— Do not start multi-block selection on Toolbox and Inline Toolbar #646Fix
— Minor fixes of caret behaviour #663Fix
— Fix inline-link icon position in Firefox #674
Fix
— Make Toolbox tooltip position font-size independent
- New Inline Tools — pass tool settings from configuration to Tool constructor
Fix
— Fix processingcolor-mod
function in styles
New
API - newblocks
API methodrenderFromHTML
New
— Add ability to pass configuration for internal Tools
Fix
- Fix editor view on mobile devices
Fix
- Fix inline toolbar buttons margin. Update dependencies list. Update tools for example page.
Fix
— Block tunes margins now better works with more than 3 buttons
Fix
Paste — Fix pasting into non-initial Blocks
Fix
Paste — Polyfill for Microsoft Edge
Fix
RectangeSelection — Redesign of the scrolling zones
Fix
- Clear focus when click is outside the Editor instance
Fix
— Fix CMD+A Selection on multiple Editor instances
Improvements
— Docs updated and common enhancements
Fix
RectangeSelection — Selection is available only for the main mouse button
New
— Add API methods shorthands
New
— Rename from CodeX Editor to Editor.js
New
— Toolbox now have beautiful helpers with Tool names and shortcuts
Improvements
— Prevent navigating back on Firefox when Block is removing by backspace
Fix
— Handle paste only on initial Block
New
— Blocks selected with Rectangle Selection can be also removed, copied or cut
Improvements
— Migrate frompostcss-cssnext
topostcss-preset-env
and disablepostcss-custom-properties
which conflicts withpostcss-preset-env
New
RectangeSelection — Ability to select Block or several Blocks with mouse
Fix
Caret — Fix "History back" call on backspace in Firefox
Imporvements
API — Added API methods to manage caret position
Improvements
Types — TypeScript types sre updated
Fix
— Caret now goes through elements withouttype
attribute
Fix
— Fixed selection behavior when text has modifiers form Inline Toolbar
Fix
— cmd+x works only for custom selection now
New
Tools Validation is added.
New
Mobile view — Editor now adopted for mobile devicesNew
Narrow mode — Editor now adopted for narrow containers
Improvements
Caret — Improvements of the caret behaviour: arrows, backspace and enter keys better handling.
New
Autofocus — Now you can set focus at Editor after page has been loaded
Improvements
Paste handling — minor paste handling improvements
New
Shortcuts — copy and cut Blocks selected by CMD+A
New
Sanitize API — Sanitize Config ofBlock Tools
now automatically extends by tags ofInline Tools
that is enabled by current Tool byinlineToolbar
option. You don't need more to specifya, b, mark, code
manually. This feature will be added to fields that supports inline markup.New
Block Selection — Ability to select Block byCMD+A
, and the whole Editor by doubleCMD+A
. After that, you can copy (CMD+C
), remove (Backspace
) or clear (Enter
) selected Blocks.New
Styles API — Addedbutton
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 failedNew
Public TS-types are presented.Changes
Tools API — optionsirreplaceable
andcontentless
was removed.Changes
Tools API — Paste API: tags, patterns and mime-types now should be specified by Tool'spasteConfig
static property. Custom Paste Event should be handled byonPaste(event)
that should not be static from now.Changes
Tools API — optionsdisplayInToolbox
andtoolboxIcon
was removed. Usetoolbox
instead, that should return object withicon
andtitle
field, orfalse
if Tool should not be placed at the Toolbox. Also, there are a way to overridetoolbox {icon, title}
settings provided by Tool with you own settings at the Initial Config.Improvements
— All Projects code now on TypeScriptImprovements
— NPM package size decreased from 1300kb to 422kbImprovements
— Bundle size decreased from 438kb to 252kbImprovements
—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 ofinitialType
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 vulnerabilityImprovements
— Logging improved: now all Editor's logs will be preceded by beautiful label with current Editor version.Improvements
— InternalisEmpty
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 byCMD+C
on macOSImprovements
— Dozens of bugfixes and small improvements
See a whole 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 — newsanitize
getter for Tools for automatic HTML sanitizing of returned data. See documentation and example at the Paragraph ToolNew
AddedonChange
-callback, fired after any modifications at the Editor. See documentation.New
New Inline Tool example — MarkerNew
New Inline Tool example — CodeNew
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.