Release/2.17

README.md

@@ -18,8 +18,6 @@ If you like Editor.js you can support project improvements and development of ne
 
  👉  [https://opencollective.com/editorjs](https://opencollective.com/editorjs)
 
- 👉  Bitcoin: `3DCCemgtE6GrzehVpU6Sa2RJHFUUh8iT9q`
-
 ### Sponsors
 
 Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/editorjs#sponsor)]
@@ -36,11 +34,11 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
 
 This project exists thanks to all the people who contribute. <img src="https://opencollective.com/editorjs/contributors.svg?width=890&button=false" />
 
-We are really welcome new contributors. If you want to make some code with us, please take a look at the [Good First Tasks](https://github.com/codex-team/editor.js/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+task%22). You can write to us on `[email protected]` or via special [Telegram chat](https://t.me/editorjsdev), or any other way. 
+We really welcome new contributors. If you want to make some code with us, please take a look at the [Good First Tasks](https://github.com/codex-team/editor.js/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+task%22). You can write to us on `[email protected]` or via special [Telegram chat](https://t.me/editorjsdev), or any other way. 
 
 ## Documentation
 
-Please, visit [https://editorjs.io/](https://editorjs.io) to view all documentation articles.
+Please visit [https://editorjs.io/](https://editorjs.io) to view all documentation articles.
 
 - [Base concepts](https://editorjs.io/base-concepts)
 - [Getting started](https://editorjs.io/getting-started)
@@ -53,37 +51,37 @@ You can join a [Gitter-channel](https://gitter.im/codex-team/editor.js) or [Tele
 
 ## Changelog
 
-See a whole [Changelog](/docs/CHANGELOG.md)
+See the whole [Changelog](/docs/CHANGELOG.md)
 
-## So how to use Editor.js
+## How to use Editor.js
 
 ### Basics
 
 Editor.js is a Block-Styled editor. Blocks are structural units, of which the Entry is composed.
 For example, `Paragraph`, `Heading`, `Image`, `Video`, `List` are Blocks. Each Block is represented by Plugin.
 We have [many](http://github.com/editor-js/) ready-to-use Plugins and a [simple API](https://editorjs.io/tools-api) for creating new ones.
 
-So how to use the Editor after [Installation](https://editorjs.io/getting-started).
+How to use the Editor after [Installation](https://editorjs.io/getting-started).
 
-- Create new Blocks by Enter or with the Plus Button
+- Create new Blocks by pressing Enter or clicking the Plus Button
 - Press `TAB` or click on the Plus Button to view the Toolbox
 - Press `TAB` again to leaf Toolbox and select a Block you need. Then press Enter.
 
 
  ![](https://github.com/editor-js/list/raw/master/assets/example.gif)
 
-- Select text fragment and apply a style or insert a link from the Inline Toolbar
+- Select a text fragment and apply a style or insert a link from the Inline Toolbar
 
 ![](https://capella.pics/7ccbcfcd-1c49-4674-bea7-71021468a1bd.jpg)
 
-- Use «three-dots» button on the right to open Block Settings. From here, you can move and delete a Block
-or apply Tool's settings, if it provided. For example, set a Heading level or List style.
+- Use the «three-dots» button on the right to open Block Settings. From here, you can move and delete a Block
+or apply a Tool's settings, if it provided. For example, you can set a Heading level or List style.
 
 ![](https://capella.pics/01a55381-46cd-47c7-b92e-34765434f2ca.jpg)
 
 ### Shortcuts
 
-We really appreciate shortcuts. So there are few presets.
+A few shortcuts are preset as available.
 
 Shortcut | Action | Restrictions
 -- | -- | --
@@ -94,7 +92,7 @@ Shortcut | Action | Restrictions
 `CMD+I` | Italic style | On selection
 `CMD+K` | Insert a link | On selection
 
-Also we support shortcuts on the all type of Tools. Specify a shortcut with the Tools configuration. For example:
+Each Tool can also have its own shortcuts. These are specified in the configuration of the Tool, for example:
 
 ```js
 var editor = new EditorJS({
@@ -123,17 +121,17 @@ There are few steps to run Editor.js on your site.
 2. [Load Tools](#load-tools)
 3. [Initialize Editor's instance](#create-editor-instance)
 
-### Load Editor's core
+### Step 1. Load Editor's core
 
-Firstly you need to get Editor.js itself. It is a [minified script](dist/editor.js) with Editor's core and some default must-have tools.
+Get Editor.js itself. It is a [minified script](dist/editor.js) with Editor's core and some default must-have tools.
 
 Choose the most usable method of getting Editor for you.
 
 - Node package
 - Source from CDN
 - Local file from project
 
-#### Node.js
+##### Option A. NPM install
 
 Install the package via NPM or Yarn
 
@@ -147,43 +145,39 @@ Include module in your application
 const EditorJS = require('@editorjs/editorjs');
 ```
 
-#### Use from CDN
+##### Option B. Use a CDN
 
-You can load specific version of package from [jsDelivr CDN](https://www.jsdelivr.com/package/npm/@editorjs/editorjs).
+You can load EditorJS directly from from [jsDelivr CDN](https://www.jsdelivr.com/package/npm/@editorjs/editorjs).
 
 `https://cdn.jsdelivr.net/npm/@editorjs/editorjs@latest`
 
-Then require this script.
+For example, place this in your HTML:
 
 ```html
-<script src="..."></script>
+<script src="https://cdn.jsdelivr.net/npm/@editorjs/editorjs@latest"></script>
 ```
 
-#### Save sources to project
+##### Option C. Save source within your project
 
-Copy [editor.js](dist/editor.js) file to your project and load it.
+Copy the [editor.js](dist/editor.js) file to your project and load it.
 
 ```html
 <script src="editor.js"></script>
 ```
 
-### Load Tools
-
-Each Block at the Editor.js is represented by [Tools](docs/tools.md). There are simple external scripts with their own logic. Probably you want to use several Block Tools that should be connected.
+### Step 2. Load the Tools that you want to make available
 
-For example check out our [Header](https://github.com/editor-js/header) Tool that represents heading blocks.
-
-You can install Header Tool by the same way as the Editor (Node.js, CDN, local file).
-
-Check [Editor.js's community](https://github.com/editor-js/) to see more ready-to-use Tools.
+Each Block is represented by a [Tool](docs/tools.md). Tools are simple external scripts with their own logic. For example, there is a [Header](https://github.com/editor-js/header) Tool into which you type your heading text. If you want to be able to use this, install the Header Tool the same way as the Editor (Node.js, CDN, local file).
 
 **Example:** use Header from CDN
 
 ```html
 <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/bundle.js"></script>
 ```
 
-### Create Editor instance
+Check [Editor.js's community](https://github.com/editor-js/) to see more ready-to-use Tools.
+
+### Step 3. Create Editor instance
 
 Create an instance of Editor.js and pass [Configuration Object](types/configs/editor-config.d.ts) with `holderId` and tools list.
 

dist/editor.js.LICENSE

@@ -1,7 +1,7 @@
 /*!
  * Editor.js
  * 
- * @version 2.16.1
+ * @version 2.17.0
  * 
  * @licence Apache-2.0
  * @author CodeX <https://codex.so>

docs/CHANGELOG.md

@@ -1,31 +1,45 @@
 # Changelog
 
+### 2.17
+
+- `Improvements` - Editor's [onchange callback](https://editorjs.io/configuration#editor-modifications-callback) now accepts an API as a parameter
+- `Fix` - Some mistakes are fixed in [installation.md](installation.md)
+- `Fix` - Fixed multiple paste callback triggering in a case when several editors are instantiated [#1011](https://github.com/codex-team/editor.js/issues/1011)
+- `Fix` - Fixed inline toolbar flipper activation on closing conversion toolbar [#995](https://github.com/codex-team/editor.js/issues/995)
+- `Improvements` - New window tab is opened by clicking on anchor with ctrl [#1057](https://github.com/codex-team/editor.js/issues/1057)
+- `Fix` - Fix block-tune buttons alignment in some CSS-resetors that forces `box-sizing: border-box` rule [#1003](https://github.com/codex-team/editor.js/issues/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](tools.md#block-lifecycle-hooks) `moved`
+- `Deprecated` — [`blocks.swap(fromIndex, toIndex)`](api.md) method is deprecated. Use `blocks.move(toIndex, fromIndex)` instead.
+- `Fix` — Improve plain text paste [#1012](https://github.com/codex-team/editor.js/issues/1012)
+- `Fix` — Fix multiline paste [#1015](https://github.com/codex-team/editor.js/issues/1015)
+
 ### 2.16.1
 
 - `Fix` — Fix Firefox bug with incorrect height and cursor position of empty content editable elements [#947](https://github.com/codex-team/editor.js/issues/947) [#876](https://github.com/codex-team/editor.js/issues/876) [#608](https://github.com/codex-team/editor.js/issues/608) [#876](https://github.com/codex-team/editor.js/issues/876)
-- `Fix` — Set initial hidden Inline Toolbar position [#979](https://github.com/codex-team/editor.js/issues/979) 
-- `Fix` — Fix issue with CodeX.Toolips TypeScript definitions [#978](https://github.com/codex-team/editor.js/issues/978) 
+- `Fix` — Set initial hidden Inline Toolbar position [#979](https://github.com/codex-team/editor.js/issues/979)
+- `Fix` — Fix issue with CodeX.Toolips TypeScript definitions [#978](https://github.com/codex-team/editor.js/issues/978)
 - `Fix` — Fix some issues with Inline and Tunes toolbars.
 - `Fix` - Fix `minHeight` option with zero-value issue [#724](https://github.com/codex-team/editor.js/issues/724)
-- `Improvements` — Disable Conversion Toolbar if there are no Tools to convert [#984](https://github.com/codex-team/editor.js/issues/984)  
+- `Improvements` — Disable Conversion Toolbar if there are no Tools to convert [#984](https://github.com/codex-team/editor.js/issues/984)
 
 ### 2.16
 
 - `Improvements` — Inline Toolbar design improved
 - `Improvements` — Conversion Toolbar now included in the Inline Toolbar [#853](https://github.com/codex-team/editor.js/issues/853)
 - `Improvements` — All buttons now have beautiful Tooltips provided by [CodeX Tooltips](https://github.com/codex-team/codex.tooltips)
-- `New` — new Tooltips API for displaying tooltips near your custom elements  
+- `New` — new Tooltips API for displaying tooltips near your custom elements
 - `New` *API* — Block [lifecycle hooks](tools.md#block-lifecycle-hooks)
-- `New` *Inline Tools API* — Ability to specify Tool's title via `title` static getter. 
+- `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](https://github.com/codex-team/editor.js/issues/869)
 - `Fix` — Fix flipper with empty dom iterator [#926](https://github.com/codex-team/editor.js/issues/926)
 - `Fix` — Normalize node before walking through children at `isEmpty` method [#943](https://github.com/codex-team/editor.js/issues/943)
 - `Fix` — Fixed Grammarly conflict [#779](https://github.com/codex-team/editor.js/issues/779)
 - `Improvements` — Module Listeners now correctly removes events with options [#904](https://github.com/codex-team/editor.js/pull/904)
-- `Improvements` — Styles API: `.cdx-block` default vertical margins decreased from 0.7 to 0.4 ems. 
-- `Fix` — Fixed History Back on block deletion by Backspace in Firefox [#967](https://github.com/codex-team/editor.js/pull/967)
+- `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](https://github.com/codex-team/editor.js/issues/938)
-- `New` — Log levels now available to suppress Editor.js console messages [#962](https://github.com/codex-team/editor.js/issues/962) 
+- `New` — Log levels now available to suppress Editor.js console messages [#962](https://github.com/codex-team/editor.js/issues/962)
 - `Fix` — Fixed wrong navigation on block deletion
 
 ### 2.15.1
@@ -38,10 +52,10 @@
 
 ### 2.15
 
-- `New` — New [`blocks.insert()`](api.md) API method [#715](https://github.com/codex-team/editor.js/issues/715).  
+- `New` — New [`blocks.insert()`](api.md) API method [#715](https://github.com/codex-team/editor.js/issues/715).
 - `New` *Conversion Toolbar* — Ability to convert one block to another [#704](https://github.com/codex-team/editor.js/issues/704)
 - `New` *Cross-block selection* — Ability to select multiple blocks by mouse and with SHIFT+ARROWS [#703](https://github.com/codex-team/editor.js/issues/703)
-- `Deprecated` — [`blocks.insertNewBlock()`](api.md) method is deprecated. Use `blocks.insert()` instead.  
+- `Deprecated` — [`blocks.insertNewBlock()`](api.md) method is deprecated. Use `blocks.insert()` instead.
 - `Improvements` — Inline Toolbar now works on mobile devices [#706](https://github.com/codex-team/editor.js/issues/706)
 - `Improvements` — Toolbar looks better on mobile devices [#706](https://github.com/codex-team/editor.js/issues/706)
 - `Improvements` — Now `pasteConfig` can return `false` to disable paste handling on your Tool [#801](https://github.com/codex-team/editor.js/issues/801)
@@ -67,9 +81,9 @@
 - `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](https://github.com/codex-team/editor.js/issues/713)
 - `Improvements` — Close inline toolbar after creating a new link.
-- `New` *Config* — Option `minHeight` for customizing Editor's bottom zone height added. 
+- `New` *Config* — Option `minHeight` for customizing Editor's bottom zone height added.
 
-### 2.12.4 
+### 2.12.4
 
 - `Improvements` — CodeX.Shortcuts version updated to the v1.1 [#684](https://github.com/codex-team/editor.js/issues/684)
 - `Fix` — Do not start multi-block selection on Toolbox and Inline Toolbar [#646](https://github.com/codex-team/editor.js/issues/646)
@@ -82,15 +96,15 @@
 
 ### 2.12.2
 
-- New *Inline Tools* — pass tool settings from configuration to Tool constructor 
+- 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 
+### 2.12.0
 
-- `New` *API* - new `blocks` API method `renderFromHTML` 
+- `New` *API* - new `blocks` API method `renderFromHTML`
 
 ### 2.11.11
 
@@ -102,7 +116,7 @@
 
 ### 2.11.9
 
-- `Fix` - Fix inline toolbar buttons margin. Update dependencies list. Update tools for example page. 
+- `Fix` - Fix inline toolbar buttons margin. Update dependencies list. Update tools for example page.
 
 ### 2.11.8
 
@@ -192,7 +206,7 @@
 
 - `Fix` — cmd+x works only for custom selection now
 
-### 2.7.28 
+### 2.7.28
 
 - `New` [Tools Validation](https://github.com/codex-team/editor.js/blob/master/docs/tools.md#validate-optional) is added.
 
@@ -222,9 +236,9 @@
 - `New` *Sanitize API* — [Sanitize Config](https://github.com/codex-team/editor.js/blob/master/docs/tools.md#automatic-sanitize) 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](https://github.com/codex-team/editor.js/blob/master/types/api/styles.d.ts)* — Added `button` class for stylization of any buttons provided by Tools with one unified style.
-- `New` *[Notifier API](https://github.com/codex-team/editor.js/blob/master/docs/api.md#notifierapi)* — methods for showing user notifications: on success, errors, warnings, etc. 
-- `New` *Block Tool* — [Table](http://github.com/editor-js/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` *[Notifier API](https://github.com/codex-team/editor.js/blob/master/docs/api.md#notifierapi)* — methods for showing user notifications: on success, errors, warnings, etc.
+- `New` *Block Tool* — [Table](http://github.com/editor-js/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](https://github.com/codex-team/editor.js/tree/master/types) are presented.
 - `Changes` *Tools API*  — options `irreplaceable` and `contentless` was removed.
 - `Changes` *Tools API* — [Paste API](https://github.com/codex-team/editor.js/blob/master/docs/tools.md#paste-handling): 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.

docs/api.md

@@ -26,7 +26,11 @@ Methods that working with Blocks
 
 `renderFromHTML(data)` - parse and render passed HTML string (*not for production use*)
 
-`swap(fromIndex, toIndex)` - swaps two Blocks by their positions
+`swap(fromIndex, toIndex)` - swaps two Blocks by their positions (deprecated:
+use 'move' instead)
+
+`move(toIndex, fromIndex)` - moves block from one index to another position.
+`fromIndex` will be the current block's index by default.
 
 `delete(blockIndex?: Number)` - deletes Block with passed index