feat(core): implement Clipboard Plugin by ilyamore88 · Pull Request #129 · editor-js/document-model

ilyamore88 · 2026-04-17T20:36:26Z

Implementation of Clipboard Plugin. Currently it supports the same behaviour from v2, when a user can copy blocks from Editor and then paste it.
During implementation I found a limitation in Safari. The system ignores custom meta data, if user copies and paste data between different domains.

TODO

Add missing docs;
Add unit tests.

…t to eventbus

…clipboard-plugin

Copilot

Pull request overview

Implements initial “copy” pipeline support by introducing a UI-level ui:copy event, exposing selected blocks via the Selection API, and adding a Core ClipboardPlugin that writes editor-specific clipboard payloads when blocks are selected.

Changes:

UI: dispatch a new CopyUIEvent on native copy within the blocks holder.
SDK/Core APIs: add selection.selectedBlocks and selection logic to derive selected blocks from caret/index state.
Core: auto-register a new ClipboardPlugin that overrides native copy to populate text/plain, text/html, and application/x-editor-js.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
packages/ui/src/Blocks/Blocks.ts	Dispatches `CopyUIEvent` on native `copy` events from the blocks holder.
packages/sdk/src/entities/EventBus/events/ui/index.ts	Re-exports the new UI copy event from the UI events barrel.
packages/sdk/src/entities/EventBus/events/ui/CopyUIEvent.ts	Introduces `CopyUIEvent`, name constant, and payload type carrying the native `ClipboardEvent`.
packages/sdk/src/api/SelectionAPI.ts	Extends public Selection API with `selectedBlocks`.
packages/model/src/entities/Index/index.ts	Adds `Index.isCompositeIndex` predicate for composite selections.
packages/core/src/plugins/ClipboardPlugin.ts	New plugin that intercepts `ui:copy` and writes multiple clipboard formats, including editor-specific MIME data.
packages/core/src/index.ts	Registers `ClipboardPlugin` in Core default plugin set.
packages/core/src/components/SelectionManager.ts	Adds logic to derive selected blocks from caret index (block index or composite segments).
packages/core/src/api/SelectionAPI.ts	Implements SDK Selection API `selectedBlocks` getter via `SelectionManager`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

gohabereg · 2026-05-24T23:57:05Z

+   * @todo update doc
+   */
+  public destroy(): void {
+    // do nothing


Could unsubscribe from the copy event

gohabereg · 2026-05-24T23:57:24Z

+      return '';
+    }
+
+    const container = document.createElement('div');


Template might be better instead of div

…tion for null

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

…clipboard-plugin

github-actions · 2026-06-09T18:34:06Z

Unit Tests

Package	Coverage	Delta
@editorjs/collaboration-manager	85.81%	0% ⚪️
@editorjs/dom-adapters	86.95%	0% ⚪️
@editorjs/ot-server	20%	0% ⚪️
@editorjs/core	90.47%	+0.92% 🟢
@editorjs/model	98.25%	0% ⚪️
@editorjs/model-types	93.75%	-4.07% 🔴
@editorjs/clipboard-plugin	66.66%	N/A

Mutation Tests

Package	Mutation score	Dashboard URL
@editorjs/dom-adapters	No files to mutate found.
@editorjs/core	32.14% 🔴	Dashboard
@editorjs/model	No files to mutate found.
@editorjs/collaboration-manager	No files to mutate found.
@editorjs/clipboard-plugin	100.00% 🟢	Dashboard

Copilot

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.

…n, replace div with template

…clipboard-plugin

gohabereg

Looks good, just fix the code style

gohabereg · 2026-07-08T18:47:26Z

+  /**
+   *
+   */
+  get selectedBlocks(): BlockNodeSerialized[] | null;


Maybe [] instead of null

Copilot

Pull request overview

Copilot reviewed 23 out of 24 changed files in this pull request and generated 2 comments.

gohabereg · 2026-07-20T17:18:33Z

+
+      clipboardData.setData('text/plain', selectionAsPlainText);
+      clipboardData.setData('text/html', selectionAsHTML);
+      clipboardData.setData('application/x-editor-js', JSON.stringify(clipboardEditorJSObject));


The mime type could be a const

gohabereg · 2026-07-20T17:19:07Z

+/**
+ * Custom EditorJS data-type object for clipboard events
+ */
+interface ClipboardEditorJSObject {


Maybe move interfaces to the top

…clipboard-plugin

Copilot

Pull request overview

Copilot reviewed 27 out of 28 changed files in this pull request and generated 2 comments.

ilyamore88 · 2026-07-20T19:45:18Z

+    blocksHolder.addEventListener('copy', (e) => {
+      const payload: CopyUIEventPayload = {
+        nativeEvent: e,
+      };
+
+      this.#eventBus.dispatchEvent(new CopyUIEvent(payload));
+    });


Tracked in #170

neSpecc · 2026-07-21T15:49:05Z

+      });
+    });
+  });
+});


Please, add more cases covering multiline copying:

select several blocks and copy as text.

Do you mean a test like this? c322b46

Copilot · 2026-07-21T15:52:08Z

@neSpecc I've opened a new pull request, #175, to work on those changes. Once the pull request is ready, I'll request review from you.

ilyamore88 added 8 commits April 17, 2026 21:35

feat(eventbus): create CopyUIEvent entity

9dd6f8e

feat(ui-blocks): subscribe for copy event and pass native event objec…

b53c482

…t to eventbus

feat(core): init clipboard plugin

0be2ca4

feat(core): use ClipboardPlugin

10c1c22

Merge branch 'main' of github.com:editor-js/document-model into feat/…

ad5b441

…clipboard-plugin

Merge branch 'main' of github.com:editor-js/document-model into feat/…

e1359c8

…clipboard-plugin

Merge branch 'main' of github.com:editor-js/document-model into feat/…

500178d

…clipboard-plugin

feat: implement clipboard plugin

bc3657c

ilyamore88 requested a review from Copilot May 24, 2026 21:30

Copilot started reviewing on behalf of ilyamore88 May 24, 2026 21:30 View session

Copilot AI reviewed May 24, 2026

View reviewed changes

gohabereg reviewed May 24, 2026

View reviewed changes

ilyamore88 and others added 3 commits June 9, 2026 19:21

fix(clipboard-plugin): prevent native event only after checking selec…

00d10ac

…tion for null

chore: fix stryker exception description

d426ae4

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Merge branch 'main' of github.com:editor-js/document-model into feat/…

31a5758

…clipboard-plugin

ilyamore88 requested a review from Copilot June 9, 2026 18:32

Copilot started reviewing on behalf of ilyamore88 June 9, 2026 18:32 View session

Copilot AI reviewed Jun 9, 2026

View reviewed changes

Comment thread packages/ui/src/Blocks/Blocks.ts Outdated

Comment thread packages/core/src/plugins/ClipboardPlugin.ts Outdated

Comment thread packages/sdk/src/entities/EventBus/events/ui/CopyUIEvent.ts

Comment thread packages/sdk/src/api/SelectionAPI.ts Outdated

ilyamore88 added 4 commits July 7, 2026 21:13

feat(clipboard-plugin): update docs, add destroy method implementatio…

9f44277

…n, replace div with template

Merge branch 'main' of github.com:editor-js/document-model into feat/…

f63d6dd

…clipboard-plugin

chore: use currentSelection in selection manager

55b62c8

feat(clipboard-plugin): describe clipboard object

2681e5b

ilyamore88 requested a review from gohabereg July 8, 2026 18:03

ilyamore88 marked this pull request as ready for review July 8, 2026 18:03

gohabereg reviewed Jul 8, 2026

View reviewed changes

ilyamore88 added 4 commits July 8, 2026 20:07

refactor(selection-api): return empty array instead of null

2b288dc

chore: add docs

f2a6067

chore: update docs

264f721

fix: make removeEventListener js-private

f4601a6

editor-js deleted a comment from github-actions Bot Jul 19, 2026

ilyamore88 requested a review from Copilot July 19, 2026 20:54

Copilot started reviewing on behalf of ilyamore88 July 19, 2026 20:54 View session

Copilot AI reviewed Jul 19, 2026

View reviewed changes

Comment thread packages/plugins/clipboard-plugin/tsconfig.eslint.json

Comment thread packages/core/src/components/SelectionManager.ts

chore: address review commits

a4365c3

gohabereg approved these changes Jul 20, 2026

View reviewed changes

ilyamore88 added 3 commits July 20, 2026 18:55

Merge branch 'main' of github.com:editor-js/document-model into feat/…

4dff6fa

…clipboard-plugin

chore: add spec for clipboard plugin

9d0f896

chore: address review comments

18963e9

ilyamore88 requested a review from Copilot July 20, 2026 18:31

Copilot started reviewing on behalf of ilyamore88 July 20, 2026 18:32 View session

Copilot AI reviewed Jul 20, 2026

View reviewed changes

ilyamore88 mentioned this pull request Jul 20, 2026

BlocksUI doesn't remove its blocksHolder DOM event listeners (or the holder itself) on destroy() #170

Open

ilyamore88 requested review from Reversean and neSpecc July 20, 2026 19:50

ilyamore88 mentioned this pull request Jul 20, 2026

Extract ShortcutsPlugin into a separate @editorjs/shortcuts-plugin package #171

Open

LocalhostTI mentioned this pull request Jul 20, 2026

fix(ui): remove blocksHolder DOM listeners and detach holder on destroy #173

Closed

neSpecc reviewed Jul 21, 2026

View reviewed changes

Copilot AI mentioned this pull request Jul 21, 2026

[WIP] [WIP] Address feedback on "feat(core): implement Clipboard Plugin" PR #175

Draft

test(clipboard-plugin): cover multi-line copy event

c322b46

neSpecc approved these changes Jul 21, 2026

View reviewed changes

ilyamore88 added this pull request to the merge queue Jul 21, 2026

Merged via the queue into main with commit f14b7ce Jul 21, 2026
57 checks passed

ilyamore88 deleted the feat/clipboard-plugin branch July 21, 2026 20:17

Uh oh!

Conversation

ilyamore88 commented Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jun 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unit Tests

Mutation Tests

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gohabereg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI commented Jul 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

ilyamore88 commented Apr 17, 2026 •

edited

Loading

github-actions Bot commented Jun 9, 2026 •

edited

Loading