BlockSuite API Documentation / @blocksuite/affine-block-root / PageClipboard

Class: PageClipboard

Defined in: packages/affine/blocks/block-root/src/clipboard/page-clipboard.ts:27

PageClipboard is a class that provides a clipboard for the page root block. It is supported to copy and paste models in the page root block.

Extends

• ReadOnlyClipboard

Constructors

new PageClipboard()

new PageClipboard(host): PageClipboard

Defined in: packages/affine/blocks/block-root/src/clipboard/readonly-clipboard.ts:106

Parameters

host

BlockComponent

Returns

PageClipboard

Inherited from

ReadOnlyClipboard.constructor

Properties

_disposables

protected _disposables: DisposableGroup

Defined in: packages/affine/blocks/block-root/src/clipboard/readonly-clipboard.ts:35

Inherited from

ReadOnlyClipboard._disposables

---

host

host: BlockComponent

Defined in: packages/affine/blocks/block-root/src/clipboard/readonly-clipboard.ts:93

Inherited from

ReadOnlyClipboard.host

---

onPageCopy

onPageCopy: UIEventHandler

Defined in: packages/affine/blocks/block-root/src/clipboard/readonly-clipboard.ts:95

Inherited from

ReadOnlyClipboard.onPageCopy

---

onPageCut

onPageCut: UIEventHandler

Defined in: packages/affine/blocks/block-root/src/clipboard/page-clipboard.ts:64

---

onPagePaste

onPagePaste: UIEventHandler

Defined in: packages/affine/blocks/block-root/src/clipboard/page-clipboard.ts:79

Accessors

_std

Get Signature

get protected _std(): BlockStdScope

Defined in: packages/affine/blocks/block-root/src/clipboard/readonly-clipboard.ts:102

Returns

BlockStdScope

Inherited from

ReadOnlyClipboard._std

Methods

_copySelected()

protected readonly _copySelected(onCopy?): Chain<InitCommandCtx & object & object & object & object>

Defined in: packages/affine/blocks/block-root/src/clipboard/readonly-clipboard.ts:26

Parameters

onCopy?

() => void

Returns

Chain<InitCommandCtx & object & object & object & object>

Inherited from

ReadOnlyClipboard._copySelected

---

_init()

protected _init(): void

Defined in: packages/affine/blocks/block-root/src/clipboard/page-clipboard.ts:28

Returns

void

---

_initAdapters()

protected _initAdapters(): void

Defined in: packages/affine/blocks/block-root/src/clipboard/readonly-clipboard.ts:37

Returns

void

Inherited from

ReadOnlyClipboard._initAdapters

---

hostConnected()

hostConnected(): void

Defined in: packages/affine/blocks/block-root/src/clipboard/page-clipboard.ts:156

Returns

void

Overrides

ReadOnlyClipboard.hostConnected

---

hostDisconnected()

hostDisconnected(): void

Defined in: packages/affine/blocks/block-root/src/clipboard/readonly-clipboard.ts:120

Returns

void

Inherited from

ReadOnlyClipboard.hostDisconnected

---

onBlockSnapshotPaste()

onBlockSnapshotPaste(snapshot, doc, parent?, index?): Promise<null | string>

Defined in: packages/affine/blocks/block-root/src/clipboard/page-clipboard.ts:49

Parameters

snapshot

BlockSnapshot

doc

Store

parent?

string

index?

number

Returns

Promise<null | string>