BlockSuite API Documentation / @blocksuite/block-std / Clipboard

Class: Clipboard

Defined in: packages/framework/block-std/src/clipboard/index.ts:63

A life cycle watcher is an extension that watches the life cycle of the editor. It is used to perform actions when the editor is created, mounted, rendered, or unmounted.

When creating a life cycle watcher, you must define a key that is unique to the watcher. The key is used to identify the watcher in the dependency injection container.

class MyLifeCycleWatcher extends LifeCycleWatcher {
 static override readonly key = 'my-life-cycle-watcher';

In the life cycle watcher, the methods will be called in the following order:

1. created: Called when the std is created.
2. rendered: Called when std.render is called.
3. mounted: Called when the editor host is mounted.
4. unmounted: Called when the editor host is unmounted.

Extends

• LifeCycleWatcher

Constructors

new Clipboard()

new Clipboard(std): Clipboard

Defined in: packages/framework/block-std/src/extension/lifecycle-watcher.ts:28

Parameters

std

BlockStdScope

Returns

Clipboard

Inherited from

LifeCycleWatcher.constructor

Properties

std

readonly std: BlockStdScope

Defined in: packages/framework/block-std/src/extension/lifecycle-watcher.ts:28

Inherited from

LifeCycleWatcher.std

---

key

readonly static key: "clipboard" = 'clipboard'

Defined in: packages/framework/block-std/src/clipboard/index.ts:64

Overrides

LifeCycleWatcher.key

Accessors

configs

Get Signature

get configs(): Map<string, string>

Defined in: packages/framework/block-std/src/clipboard/index.ts:268

Returns

Map<string, string>

Methods

copy()

copy(slice): Promise<void>

Defined in: packages/framework/block-std/src/clipboard/index.ts:160

Parameters

slice

Slice

Returns

Promise<void>

---

copySlice()

copySlice(slice): Promise<void>

Defined in: packages/framework/block-std/src/clipboard/index.ts:165

Parameters

slice

Slice

Returns

Promise<void>

---

created()

created(): void

Defined in: packages/framework/block-std/src/extension/lifecycle-watcher.ts:52

Called when std is created.

Returns

void

Inherited from

LifeCycleWatcher.created

---

duplicateSlice()

duplicateSlice(slice, doc, parent?, index?, type?): Promise<void>

Defined in: packages/framework/block-std/src/clipboard/index.ts:183

Parameters

slice

Slice

doc

Store

parent?

string

index?

number

type?

string = 'BLOCKSUITE/SNAPSHOT'

Returns

Promise<void>

---

mounted()

mounted(): void

Defined in: packages/framework/block-std/src/extension/lifecycle-watcher.ts:58

Called when editor host is mounted. Which means the editor host emit the connectedCallback lifecycle event.

Returns

void

Inherited from

LifeCycleWatcher.mounted

---

paste()

paste(event, doc, parent?, index?): Promise<undefined | null | Slice>

Defined in: packages/framework/block-std/src/clipboard/index.ts:202

Parameters

event

ClipboardEvent

doc

Store

parent?

string

index?

number

Returns

Promise<undefined | null | Slice>

---

pasteBlockSnapshot()

pasteBlockSnapshot(snapshot, doc, parent?, index?): Promise<undefined | BlockModel<object>>

Defined in: packages/framework/block-std/src/clipboard/index.ts:239

Parameters

snapshot

BlockSnapshot

doc

Store

parent?

string

index?

number

Returns

Promise<undefined | BlockModel<object>>

---

readFromClipboard()

readFromClipboard(clipboardData): any

Defined in: packages/framework/block-std/src/clipboard/index.ts:291

Parameters

clipboardData

DataTransfer

Returns

any

---

registerAdapter()

registerAdapter<T>(mimeType, adapter, priority): void

Defined in: packages/framework/block-std/src/clipboard/index.ts:248

Type Parameters

T

T extends BaseAdapter<unknown>

Parameters

mimeType

string

adapter

AdapterConstructor<T>

priority

number = 0

Returns

void

---

rendered()

rendered(): void

Defined in: packages/framework/block-std/src/extension/lifecycle-watcher.ts:63

Called when std.render is called.

Returns

void

Inherited from

LifeCycleWatcher.rendered

---

sliceToSnapshot()

sliceToSnapshot(slice): undefined | SliceSnapshot

Defined in: packages/framework/block-std/src/clipboard/index.ts:311

Parameters

slice

Slice

Returns

undefined | SliceSnapshot

---

unmounted()

unmounted(): void

Defined in: packages/framework/block-std/src/extension/lifecycle-watcher.ts:69

Called when editor host is unmounted. Which means the editor host emit the disconnectedCallback lifecycle event.

Returns

void

Inherited from

LifeCycleWatcher.unmounted

---

unregisterAdapter()

unregisterAdapter(mimeType): void

Defined in: packages/framework/block-std/src/clipboard/index.ts:256

Parameters

mimeType

string

Returns

void

---

unuse()

unuse(middleware): void

Defined in: packages/framework/block-std/src/clipboard/index.ts:260

Parameters

middleware

TransformerMiddleware

Returns

void

---

use()

use(middleware): void

Defined in: packages/framework/block-std/src/clipboard/index.ts:264

Parameters

middleware

TransformerMiddleware

Returns

void

---

writeToClipboard()

writeToClipboard(updateItems): Promise<void>

Defined in: packages/framework/block-std/src/clipboard/index.ts:316

Parameters

updateItems

(items) => Record<string, unknown> | Promise<Record<string, unknown>>

Returns

Promise<void>

---

setup()

static setup(di): void

Defined in: packages/framework/block-std/src/extension/lifecycle-watcher.ts:32

Parameters

di

Container

Returns

void

Inherited from

LifeCycleWatcher.setup