-- Unified Toolbox
+- Unified Toolbars
- [x] Block Tunes moved left
- [x] Toolbox becomes vertical
- [x] Ability to display several Toolbox buttons by the single Tool
- [x] Block Tunes become vertical
- - [ ] Block Tunes support nested menus
- - [ ] Conversion Toolbar uses Unified Toolbox
- - [ ] Conversion Toolbar added to the Block Tunes
+ - [x] Block Tunes support nested menus
+ - [x] Block Tunes support separators
+ - [x] Conversion Menu added to the Block Tunes
+ - [x] Unified Toolbar supports hints
+ - [x] Conversion Toolbar uses Unified Toolbar
+ - [x] Inline Toolbar uses Unified Toolbar
- Collaborative editing
- [ ] Implement Inline Tools JSON format
- [ ] Operations Observer, Executor, Manager, Transformer
diff --git a/cypress.config.ts b/cypress.config.ts
new file mode 100644
index 000000000..58f69cfe7
--- /dev/null
+++ b/cypress.config.ts
@@ -0,0 +1,39 @@
+import { defineConfig } from 'cypress';
+import path from 'node:path';
+import vitePreprocessor from 'cypress-vite';
+
+export default defineConfig({
+ env: {
+ NODE_ENV: 'test',
+ },
+ fixturesFolder: 'test/cypress/fixtures',
+ screenshotsFolder: 'test/cypress/screenshots',
+ video: false,
+ videosFolder: 'test/cypress/videos',
+ e2e: {
+ // We've imported your old cypress plugins here.
+ // You may want to clean this up later by importing these.
+ setupNodeEvents(on, config) {
+ on('file:preprocessor', vitePreprocessor({
+ configFile: path.resolve(__dirname, './vite.config.test.js'),
+ }));
+
+ /**
+ * Plugin for cypress that adds better terminal output for easier debugging.
+ * Prints cy commands, browser console logs, cy.request and cy.intercept data. Great for your pipelines.
+ * https://github.com/archfz/cypress-terminal-report
+ */
+ require('cypress-terminal-report/src/installLogsPrinter')(on);
+
+ require('@cypress/code-coverage/task')(on, config);
+ },
+ specPattern: 'test/cypress/tests/**/*.cy.{js,jsx,ts,tsx}',
+ supportFile: 'test/cypress/support/index.ts',
+ },
+ 'retries': {
+ // Configure retry attempts for `cypress run`
+ 'runMode': 2,
+ // Configure retry attempts for `cypress open`
+ 'openMode': 0,
+ },
+});
diff --git a/cypress.json b/cypress.json
deleted file mode 100644
index 2bed0b88a..000000000
--- a/cypress.json
+++ /dev/null
@@ -1,11 +0,0 @@
-{
- "env": {
- "NODE_ENV": "test"
- },
- "fixturesFolder": "test/cypress/fixtures",
- "integrationFolder": "test/cypress/tests",
- "screenshotsFolder": "test/cypress/screenshots",
- "videosFolder": "test/cypress/videos",
- "supportFile": "test/cypress/support/index.ts",
- "pluginsFile": "test/cypress/plugins/index.ts"
-}
diff --git a/devserver.js b/devserver.js
deleted file mode 100644
index 5087a7b47..000000000
--- a/devserver.js
+++ /dev/null
@@ -1,128 +0,0 @@
-/**
- * Server for testing example page on mobile devices.
- *
- * Usage:
- * 1. run `yarn devserver:start`
- * 2. Open `http://{ip_address}:3000/example/example-dev.html`
- * where {ip_address} is IP of your machine.
- *
- * Also, can serve static files from `/example` or `/dist` on any device in local network.
- */
-const path = require('path');
-const fs = require('fs');
-const http = require('http');
-const { networkInterfaces } = require('os');
-
-const port = 3000;
-const localhost = '127.0.0.1';
-const nonRoutableAddress = '0.0.0.0';
-const host = getHost();
-const server = http.createServer(serveStatic([
- '/example',
- '/dist',
-]));
-
-server.listen(port, nonRoutableAddress, () => {
- console.log(`
-
-${wrapInColor('Editor.js 💖', consoleColors.hiColor)} devserver is running ᕕ(⌐■_■)ᕗ ✨
----------------------------------------------
-${wrapInColor('http://' + host + ':' + port + '/example/example-dev.html', consoleColors.fgGreen)}
----------------------------------------------
-Page can be opened from any device connected to the same local network.
-`);
-
- if (host === localhost) {
- console.log(wrapInColor('Looks like you are not connected to any Network so you couldn\'t debug the Editor on your mobile device at the moment.', consoleColors.fgRed));
- }
-});
-
-/**
- * Serves files from specified directories
- *
- * @param {string[]} paths - directories files from which should be served
- * @returns {Function}
- */
-function serveStatic(paths) {
- return (request, response) => {
- const resource = request.url;
- const isPathAllowed = paths.find(p => resource.startsWith(p));
-
- if (!isPathAllowed) {
- response.writeHead(404);
- response.end();
-
- return;
- }
- const filePath = path.join(__dirname, resource);
-
- try {
- const stat = fs.statSync(filePath);
-
- response.writeHead(200, {
- 'Content-Length': stat.size,
- });
- const readStream = fs.createReadStream(filePath);
-
- readStream.on('error', e => {
- throw e;
- });
- readStream.pipe(response);
- } catch (e) {
- response.writeHead(500);
- response.end(e.toString());
- }
- };
-}
-
-/**
- * Returns IP address of a machine
- *
- * @returns {string}
- */
-function getHost() {
- const nets = networkInterfaces();
- const results = {};
-
- for (const name of Object.keys(nets)) {
- for (const net of nets[name]) {
- // Skip over non-IPv4 and internal (i.e. 127.0.0.1) addresses
- if (net.family === 'IPv4' && !net.internal) {
- if (!results[name]) {
- results[name] = [];
- }
- results[name].push(net.address);
- }
- }
- }
-
- /**
- * Offline case
- */
- if (Object.keys(results).length === 0) {
- return localhost;
- }
-
- return results['en0'][0];
-}
-
-/**
- * Terminal output colors
- */
-const consoleColors = {
- fgMagenta: 35,
- fgRed: 31,
- fgGreen: 32,
- hiColor: 1,
-};
-
-/**
- * Set a terminal color to the message
- *
- * @param {string} msg - text to wrap
- * @param {string} color - color
- * @returns {string}
- */
-function wrapInColor(msg, color) {
- return '\x1b[' + color + 'm' + msg + '\x1b[0m';
-}
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
index 996914d37..751942620 100644
--- a/docs/CHANGELOG.md
+++ b/docs/CHANGELOG.md
@@ -1,11 +1,199 @@
# Changelog
+### 2.31.3
+
+- `Fix` - Prevent text formatting removal when applying link
+
+### 2.31.2
+
+- `Fix` - Prevent link removal when applying bold to linked text
+
+### 2.31.1
+
+- `Fix` - Prevent the warning from appearing when `readOnly` mode is initially set to `true`
+
+### 2.31.0
+
+- `New` - Inline tools (those with `isReadOnlySupported` specified) can now be used in read-only mode
+- `New` - Inline tools (those with `isReadOnlySupported` specified) shortcuts now work in read-only mode
+- `Improvement` - Block manager passes target tool config to the `conversionConfig.import` method on conversion
+- `Fix` - Fix selection of first block in read-only initialization with "autofocus=true"
+- `Fix` - Incorrect caret position after blocks merging in Safari
+- `Fix` - Several toolbox items exported by the one tool have the same shortcut displayed in toolbox
+- `Improvement` - The current block reference will be updated in read-only mode when blocks are clicked
+- `Fix` - codex-notifier and codex-tooltip moved from devDependencies to dependencies in package.json to solve type errors
+- `Fix` - Handle whitespace input in empty placeholder elements to prevent caret from moving unexpectedly to the end of the placeholder
+- `Fix` - Fix the memory leak issue in `Shortcuts` class
+- `Fix` - Fix when / overides selected text outside of the editor
+- `DX` - Tools submodules removed from the repository
+- `Improvement` - Shift + Down/Up will allow to select next/previous line instead of Inline Toolbar flipping
+- `Improvement` - The API `caret.setToBlock()` offset now works across the entire block content, not just the first or last node.
+- `Improvement` - The API `blocks.renderFromHTML()` became async and now can be awaited.
+- `Fix` - `blocks.renderFromHTML()` — Error "Can't find a Block to remove." fixed
+- `Fix` - The API `.clear()` index invalidation fixed
+
+
+
+### 2.30.7
+
+- `Fix` - Link insertion in Safari fixed
+
+### 2.30.6
+
+- `Fix` – Fix the display of ‘Convert To’ near blocks that do not have the ‘conversionConfig.export’ rule specified
+- `Fix` – The Plus button does not appear when the editor is loaded in an iframe in Chrome
+- `Fix` - Prevent inline toolbar from closing in nested instance of editor
+
+### 2.30.5
+
+– `Fix` – Fix exported types
+
+### 2.30.4
+
+- `Fix` - Tool's exporting types added
+
+### 2.30.3
+
+- `Fix` – I18n in nested popover
+
+### 2.30.2
+
+- `Fix` – The onChange callback won't be fired when editor is initialized in the Read-Only mode
+- `Fix` – Convert To supports i18n again
+- `Fix` – Prevent form submit on inline tool click
+
+### 2.30.1
+
+- `Fix` – Remove fake selection after multiple "convert to" inline tool toggles
+
+### 2.30.0
+
+- `New` – Block Tunes now supports nesting items
+- `New` – Block Tunes now supports separator items
+- `New` – *Menu Config* – New item type – HTML
+- `New` – *Menu Config* – Default and HTML items now support hints
+- `New` – Inline Toolbar has new look 💅
+- `New` – Inline Tool's `render()` now supports [Menu Config](https://editorjs.io/menu-config/) format
+- `New` – *ToolsAPI* – All installed block tools now accessible via ToolsAPI `getBlockTools()` method
+- `New` – *SelectionAPI* – Exposed methods `save()` and `restore()` that allow to save selection to be able to temporally move focus away, methods `setFakeBackground()` and `removeFakeBackground()` that allow to immitate selection while focus moved away
+- `New` – *BlocksAPI* – Exposed `getBlockByElement()` method that helps find block by any child html element
+- `New` – "Convert to" control is now also available in Block Tunes
+- `New` — Editor.js now supports contenteditable placeholders out of the box. Just add `data-placeholder` or `data-placeholder-active` attribute to make it work. The first one will work like native placeholder while the second one will show placeholder only when block is current.
+- `Improvement` — Now Paragraph placeholder will be shown for the current paragraph, not only the first one.
+- `Improvement` - The API `blocks.update` now accepts `tunes` data as optional third argument and makes `data` - block data as optional.
+- `Improvement` — The ability to merge blocks of different types (if both tools provide the conversionConfig)
+- `Improvement` - The API `blocks.convert()` now returns the new block API
+- `Improvement` - The API `caret.setToBlock()` now can accept either BlockAPI or block index or block id
+- `Improvement` – *MenuConfig* – `TunesMenuConfig` type is deprecated, use the `MenuConfig` instead
+– `Improvement` — *Types* — `BlockToolConstructorOptions` type improved, `block` and `config` are not optional anymore
+- `Improvement` - The Plus button and Block Tunes toggler are now better aligned with large line-height blocks, such as Headings
+- `Improvement` — Creating links on Android devices: now the mobile keyboard will have an "Enter" key for accepting the inserted link.
+- `Improvement` — Placeholders will stay visible on inputs focus.
+– `Refactoring` – Switched to Vite as Cypress bundler
+- `Fix` — `onChange` will be called when removing the entire text within a descendant element of a block.
+- `Fix` - Unexpected new line on Enter press with selected block without caret
+- `Fix` - Search input autofocus loosing after Block Tunes opening
+- `Fix` - Block removing while Enter press on Block Tunes
+- `Fix` – Unwanted scroll on first typing on iOS devices
+- `Fix` - Unwanted soft line break on Enter press after period and space (". |") on iOS devices
+- `Fix` - Caret lost after block conversion on mobile devices.
+- `Fix` - Caret lost after Backspace at the start of block when previoius block is not convertable
+– `Fix` — Deleting whitespaces at the start/end of the block
+- `Fix` — The problem caused by missed "import type" in block mutation event types resolved
+
+### 2.29.1
+
+- `Fix` — Toolbox wont be shown when Slash pressed with along with Shift or Alt
+- `Fix` — Toolbox will be opened when Slash pressed in non-US keyboard layout where there is no physical '/' key.
+
+### 2.29.0
+
+- `New` — Editor Config now has the `style.nonce` attribute that could be used to allowlist editor style tag for Content Security Policy "style-src"
+- `New` — Toolbox now will be opened by '/' in empty Block instead of Tab
+- `New` — Block Tunes now will be opened by 'CMD+/' instead of Tab in non-empty block
+- `New` — Tab now will navigate through Blocks. In last block Tab will navigate to the next input on page.
+- `Fix` — Passing an empty array via initial data or `blocks.render()` won't break the editor
+- `Fix` — Layout did not shrink when a large document cleared in Chrome
+- `Fix` — Multiple Tooltip elements creation fixed
+- `Fix` — When the focusing Block is out of the viewport, the page will be scrolled.
+- `Fix` - Compiler error "This import is never used as a value and must use 'import type'..." fixed
+- `Fix` — `blocks.render()` won't lead the `onChange` call in Safari
+- `Fix` — Editor wrapper element growing on the Inline Toolbar close
+- `Fix` — Fix errors thrown by clicks on a document when the editor is being initialized
+- `Fix` — Caret losing on Mobile Devices when adding a block via Toolbox or via Backspace at the beginning of a Block
+- `Improvement` — Now you can set focus via arrows/Tab to "contentless" (decorative) blocks like Delimiter which have no inputs.
+- `Improvement` — Inline Toolbar sometimes opened in an incorrect position. Now it will be aligned by the left side of the selected text. And won't overflow the right side of the text column.
+- `Improvement` - Now the `data-mutation-free` supports deep nesting, so you can mark some element with it to prevent the onChange call caused by child element mutating
+- `Improvement` - Now the `data-mutation-free` also allows to skip "characterData" mutations (eg. text content change)
+- `Refactoring` — `ce-block--focused` class toggling removed as unused.
+
+### 2.28.2
+
+- `Fix` — Get rid of redundant logs from the build
+
+### 2.28.1
+
+- `Fix` — Some Block were be skipped on saving after pasting them as HTML
+
+### 2.28.0
+
+- `New` - Block ids now displayed in DOM via a data-id attribute. Could be useful for plugins that want to access a Block's element by id.
+- `New` - The `blocks.convert(blockId, newType)` API method was added. It allows to convert existing Block to a Block of another type.
+- `New` - The `blocks.insertMany()` API method added. It allows to insert several Blocks to the specified index.
+- `Improvement` - The Delete keydown at the end of the Block will now work opposite a Backspace at the start. Next Block will be removed (if empty) or merged with the current one.
+- `Improvement` - The Delete keydown will work like a Backspace when several Blocks are selected.
+- `Improvement` - If we have two empty Blocks, and press Backspace at the start of the second one, the previous will be removed instead of the current.
+- `Improvement` - Tools shortcuts could be used to convert one Block to another.
+- `Improvement` - Tools shortcuts displayed in the Conversion Toolbar
+- `Improvement` - Initialization Loader has been removed.
+- `Improvement` - Selection style won't override your custom style for `::selection` outside the editor.
+- `Improvement` - Performance optimizations: initialization speed increased, `blocks.render()` API method optimized. Big documents will be displayed faster.
+- `Improvement` - "Editor saving" log removed
+- `Improvement` - "I'm ready" log removed
+- `Improvement` - The stub-block style is simplified.
+- `Improvement` - If some Block's tool throws an error during construction, we will show Stub block instead of skipping it during render
+- `Improvement` - Call of `blocks.clear()` now will trigger onChange with "block-removed" event for all removed blocks.
+- `Improvement` - The `blocks.clear()` now can be awaited.
+- `Improvement` - `BlockMutationType` and `BlockMutationEvent` types exported
+- `Improvement` - `blocks.update(id, data)` now can accept partial data object — it will update only passed properties, others will remain the same.
+- `Improvement` - `blocks.update(id, data)` now will trigger onChange with only `block-change` event.
+- `Improvement` - `blocks.update(id, data)` will return a promise with BlockAPI object of the changed block.
+
+
+### 2.27.2
+
+- `Fix` - `onChange` won't be called when element with data-mutation-free changes some attribute
+
+### 2.27.1
+
+- `Fix` - `onChange` will be called on removing the whole text in a block
+
### 2.27.0
-- `Refactoring` — Popover class refactored.
+- `New` — *Toolbar API* — Added a new method for toggling the toolbox.
+- `New` — Added types for block mutation events
+- `New` — Batching added to the `onChange` callback. Now the second argument can contain an array of CustomEvents as well as a single one. Multiple changes made in a short period of time will be batched under a single `onChange` call.
- `Improvement` — *Toolbox* — Number of `close()` method calls optimized.
-- `Improvement` — The `onChange` callback won't be triggered only if all mutations contain nodes with the `data-mutation-free` attributes.
-- `Fix` — Resolve compiler error from importing the BlockToolData type
+- `Improvement` — The `onChange` callback can be muted if all mutations contain nodes with the `data-mutation-free` attribute.
+- `Improvement` — Pressing "Enter" at the end of a Block won't lead to redundant `block-changed` event triggering. Only `block-added` event will be dispatched.
+- `Improvement` — The block mutation handler is now called on every block change (including background changes), instead of only when a block is focused
+- `Improvement` — Number of caret saving method calls optimized for Block Tunes opening/closing.
+- `Improvement` — Package size reduced by removing redundant files.
+- `Refactoring` — Switched from Webpack to Vite as the build system.
+- `Refactoring` — *Dependencies* — Upgraded Cypress to v12 and related libraries to the latest versions.
+- `Refactoring` — *Dependencies* — Upgraded TypeScript to v5.
+- `Refactoring` — `EventDispatcher` types improved. Now we can pass `EventsMap` via generic to specify a map of event names and their payloads that can be used in a particular EventDispatcher instance.
+- `Refactoring` — All events in common editor Event Bus now have own type declarations.
+- `Refactoring` — Removed the block mutation observer from blocks and attached a single observer to the editor's blocks wrapper element.
+- `Refactoring` — Removed the debounce from the block mutation handler and used batching instead.
+- `Refactoring` — Refactored the popover class for better performance and maintenance.
+- `Fix` — The `onChange` callback won't trigger when block tunes are opened or closed.
+- `Fix` — Resolved a compiler error caused by importing the `BlockToolData` type.
+- `Fix` — Resolved a problem where the document would scroll to the beginning after moving a block above the viewport.
+- `Fix`- Fixed several bugs caused by browser extensions — Removed the search for a block's container in the DOM on saving and kept it in memory instead, updating it when the tool changes a container element.
+- `Fix` — *ToolsAPI* — `pasteConfig` getter with `false` value could be used to disable paste handling by Editor.js core. Could be useful if your tool has its own paste handler.
+- `CI` — Ubuntu container is now used for Edge tests runner.
+- `CI` — Node 16 is used for GitHib Actions.
### 2.26.5
@@ -46,6 +234,7 @@
- `Improvement` — *CodeStyle* — [CodeX ESLint Config](https://github.com/codex-team/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! yarn build
- yarn pull_tools && yarn tools:update
-