Bump @editorjs/editorjs from 2.26.5 to 2.28.0 #8976

dependabot · 2023-10-08T08:00:11Z

Bumps @editorjs/editorjs from 2.26.5 to 2.28.0.

Release notes

Sourced from @editorjs/editorjs's releases.

v2.28.0

New features

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.

Blocks API — The blocks.convert(blockId, newType) API method was added. It allows to convert existing Block to a Block of another type.

Blocks API — The blocks.insertMany() API method added. It allows to insert several Blocks to the specified index.

Improvements

UX — 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.

UX — The Delete keydown will work like a Backspace when several Blocks are selected.

UX — 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.

Shortcuts — Tools shortcuts could be used to convert one Block to another.

UI — Tools shortcuts displayed in the Conversion Toolbar

UI — Initialization Loader has been removed.

Styles — Selection style won't override your custom style for ::selection outside the editor.

Performance — Performance optimizations: initialization speed increased, blocks.render() API method optimized. Big documents will be displayed 8x faster.

DX — "Editor saving" log removed

DX — "I'm ready" log removed

UI — The stub-block style is simplified.

UI — If some Block's tool throws an error during construction, we will show Stub block instead of skipping it during render

onChange — Call of blocks.clear() now will trigger onChange with "block-removed" event for all removed blocks.

Blocks API — The blocks.clear() now can be awaited.

Types — BlockMutationType and BlockMutationEvent types exported

Blocks API — blocks.update(id, data) now can accept partial data object — it will update only passed properties, others will remain the same.

onChange — blocks.update(id, data) now will trigger onChange with only block-change event.

Blocks API — blocks.update(id, data) will return a promise with BlockAPI object of the changed block.

v2.28.0-rc.4

Improvement - The blocks.clear() now can be awaited.

Improvement - The blocks.render() won't lead onChange call

v2.28.0-rc.3

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 the BlockAPI object of the changed block.

v2.28.0-rc.2

Improvement - Performance optimizations: initialization speed increased, blocks.render() API method optimized. Big documents will be displayed faster.

New - The blocks.insertMany() API method added. It allows to insert several Blocks to specified index.

Improvement - Initialization Loader has been removed.

Improvement - Selection style won't override your custom style for ::selection outside the editor.

Improvement - "Editor saving" log removed

Improvement - "I'm ready" log removed

... (truncated)

Changelog

Sourced from @editorjs/editorjs's changelog.

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

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

... (truncated)

Commits

59c8d28 chore(release): bump version to 2.28.0 (#2455)
f8e9414 Bump version (#2450)
42612a0 chore(blocks.render): mutex for onchange added to the blocks.render() (#2449)
be0d33c Bump version (#2447)
922dfd8 chore(api): blocks.update(id, data) method improved (#2443)
b399966 chore(perf): initialisation and rendering performance optimisations (#2430)
0e64665 Bump version (#2424)
0223209 feat(shortcuts): convert block by tools shortcut (#2419)
41dc652 chore(package.json): bump version up to 2.28.0-rc.0 (#2355)
b24bebb feat(blocks-dom): block ids exported as data-id attribute (#2404)
Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)