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

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

WIP

…t to eventbus

github-actions · 2026-04-17T20:37:23Z

⏭️ No files to mutate for ./packages/model

github-actions · 2026-04-17T20:38:06Z

Coverage report for `./packages/dom-adapters`

St.^❔	Category	Percentage	Covered / Total
🟢	Statements	96.43%	27/28
🟢	Branches	86.96%	20/23
🟢	Functions	100%	5/5
🟢	Lines	96.43%	27/28

Test suite run success

11 tests passing in 2 suites.

Report generated by 🧪jest coverage report action from bc3657c

github-actions · 2026-04-17T20:38:09Z

Coverage report for `./packages/core`

St.^❔	Category	Percentage	Covered / Total
🟢	Statements	90.85% (-9.15% 🔻)	129/142
🟢	Branches	90.38% (-9.62% 🔻)	47/52
🟢	Functions	90% (-10% 🔻)	27/30
🟢	Lines	90.23% (-9.77% 🔻)	120/133

Show new covered files 🐣

St.^❔	File	Statements	Branches	Functions	Lines
🟡	api/SelectionAPI.ts	80%	100%	66.67%	75%

Show files with reduced coverage 🔻

St.^❔	File	Statements	Branches	Functions	Lines
🟡	`...` / SelectionManager.ts	80% (-20% 🔻)	80% (-20% 🔻)	66.67% (-33.33% 🔻)	79.31% (-20.69% 🔻)

Test suite run success

75 tests passing in 7 suites.

Report generated by 🧪jest coverage report action from bc3657c

github-actions · 2026-04-17T20:38:09Z

Coverage report for `./packages/model`

St.^❔	Category	Percentage	Covered / Total
🟢	Statements	99.7% (-0.1% 🔻)	988/991
🟢	Branches	97.01% (-1.97% 🔻)	292/301
🟢	Functions	97.03% (-0.41% 🔻)	229/236
🟢	Lines	99.68% (-0.1% 🔻)	948/951

Show files with reduced coverage 🔻

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / index.ts	98.9% (-1.1% 🔻)	94.23% (-5.77% 🔻)	93.75% (-6.25% 🔻)	98.86% (-1.14% 🔻)

Test suite run success

538 tests passing in 25 suites.

Report generated by 🧪jest coverage report action from bc3657c

github-actions · 2026-04-17T20:38:22Z

⏭️ No files to mutate for ./packages/dom-adapters

github-actions · 2026-04-17T20:38:22Z

Coverage report for `./packages/ot-server`

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	70.97%	22/31
🔴	Branches	20%	1/5
🟡	Functions	75%	6/8
🟡	Lines	68.97%	20/29

Test suite run success

4 tests passing in 1 suite.

Report generated by 🧪jest coverage report action from bc3657c

github-actions · 2026-04-17T20:38:31Z

⏭️ No files to mutate for ./packages/core

github-actions · 2026-04-17T20:38:46Z

Coverage report for `./packages/collaboration-manager`

St.^❔	Category	Percentage	Covered / Total
🟢	Statements	92.51%	358/387
🟢	Branches	85.51%	118/138
🟢	Functions	98.15%	53/54
🟢	Lines	92.41%	353/382

Test suite run success

117 tests passing in 7 suites.

Report generated by 🧪jest coverage report action from bc3657c

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

+      nativeEvent.preventDefault();
+
+      const currentDOMSelection = window.getSelection();
+
+      if (!currentDOMSelection) {
+        return;
+      }
+
+      const selectionAsPlainText = currentDOMSelection?.toString() ?? '';
+      const selectionAsHTML = this.#parseDOMSelectionToHTML(currentDOMSelection);
+
+      nativeEvent.clipboardData?.setData('text/plain', selectionAsPlainText);
+      nativeEvent.clipboardData?.setData('text/html', selectionAsHTML);
+      nativeEvent.clipboardData?.setData('application/x-editor-js', JSON.stringify(selectedBlocks));


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


+      return index.compositeSegments.map((segment) => {
+        const { blockIndex } = segment;
+
+        return this.#model.serialized.blocks[blockIndex!];
+      });


+   *
+   */
+  public get isCompositeIndex(): boolean {
+    /* Stryker disable next-line ConditionalExpression, LogicalOperator -- compound data-index predicate; .isDataIndex specs cover field combinations */


+  /**
+   *


+ * Payload @todo update doc
+ */
+export interface CopyUIEventPayload {
+  /**
+   * Native ClipboardEvent
+   * UI does not call .preventDefault() for this event
+   */
+  nativeEvent: ClipboardEvent;
+}
+
+/**
+ * Delegated copy event from the editor @todo update doc
+ */
+export class CopyUIEvent extends UIEventBase<CopyUIEventPayload> {
+  /**
+   * @param payload - carries the original DOM `ClipboardEvent` as `nativeEvent` for providing rich clipboard data


+/**
+ * Delegated copy event from the editor @todo update doc
+ */
+export class CopyUIEvent extends UIEventBase<CopyUIEventPayload> {


+/**
+ * @todo update doc
+ */
+export class ClipboardPlugin implements EditorjsPlugin {
+  public static readonly type = PluginType.Plugin;
+
+  readonly #api: EditorAPI;
+
+  /**
+   * @param params @todo update doc
+   */
+  constructor(params: EditorjsPluginParams) {


+  public get isCompositeIndex(): boolean {
+    /* Stryker disable next-line ConditionalExpression, LogicalOperator -- compound data-index predicate; .isDataIndex specs cover field combinations */
+    return this.compositeSegments !== undefined && this.compositeSegments.length > 0 && this.blockIndex === undefined && this.tuneName === undefined && this.dataKey === undefined && this.textRange === undefined;


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

ilyamore88 added 4 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

ilyamore88 added 4 commits April 17, 2026 21:39

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): implement Clipboard Plugin#129

feat(core): implement Clipboard Plugin#129
ilyamore88 wants to merge 8 commits into
mainfrom
feat/clipboard-plugin

ilyamore88 commented Apr 17, 2026

Uh oh!

github-actions Bot commented Apr 17, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 17, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 17, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 17, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 17, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 17, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 17, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 17, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

gohabereg May 24, 2026

Uh oh!

gohabereg May 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

ilyamore88 commented Apr 17, 2026

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Coverage report for ./packages/dom-adapters

Test suite run success

Uh oh!

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

Uh oh!

Coverage report for ./packages/core

Test suite run success

Uh oh!

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

Uh oh!

Coverage report for ./packages/model

Test suite run success

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Coverage report for ./packages/ot-server

Test suite run success

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Coverage report for ./packages/collaboration-manager

Test suite run success

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

gohabereg May 24, 2026

Choose a reason for hiding this comment

Uh oh!

gohabereg May 24, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Apr 17, 2026 •

edited

Loading

github-actions Bot commented Apr 17, 2026 •

edited

Loading

Coverage report for `./packages/dom-adapters`

github-actions Bot commented Apr 17, 2026 •

edited

Loading

Coverage report for `./packages/core`

github-actions Bot commented Apr 17, 2026 •

edited

Loading

Coverage report for `./packages/model`

github-actions Bot commented Apr 17, 2026 •

edited

Loading

github-actions Bot commented Apr 17, 2026 •

edited

Loading

Coverage report for `./packages/ot-server`

github-actions Bot commented Apr 17, 2026 •

edited

Loading

github-actions Bot commented Apr 17, 2026 •

edited

Loading

Coverage report for `./packages/collaboration-manager`