BlockSuite API Documentation / @blocksuite/block-std / Clipboard
Class: Clipboard
Constructors
new Clipboard(std)
new Clipboard(
std
):Clipboard
Parameters
• std: BlockStdScope
Returns
Source
packages/framework/block-std/src/clipboard/index.ts:24
Properties
_adapterMap
private
_adapterMap:AdapterMap
Source
packages/framework/block-std/src/clipboard/index.ts:22
_jobMiddlewares
private
_jobMiddlewares:JobMiddleware
[] =[]
Source
packages/framework/block-std/src/clipboard/index.ts:21
std
std:
BlockStdScope
Source
packages/framework/block-std/src/clipboard/index.ts:24
Accessors
configs
get
configs():Map
<string
,string
>
Returns
Map
<string
, string
>
Source
packages/framework/block-std/src/clipboard/index.ts:42
Methods
_getClipboardItem()
private
_getClipboardItem(slice
,type
):Promise
<unknown
>
Parameters
• slice: Slice
• type: string
Returns
Promise
<unknown
>
Source
packages/framework/block-std/src/clipboard/index.ts:77
_getDataByType()
private
_getDataByType(clipboardData
): (type
) =>string
|File
[]
Parameters
• clipboardData: DataTransfer
Returns
Function
Parameters
• type:
string
Returns
string
|File
[]
Source
packages/framework/block-std/src/clipboard/index.ts:55
_getJob()
private
_getJob():Job
Returns
Source
packages/framework/block-std/src/clipboard/index.ts:46
_getSnapshotByPriority()
private
_getSnapshotByPriority(getItem
,doc
,parent
?,index
?):Promise
<null
|Slice
>
Parameters
• getItem
• doc: Doc
• parent?: string
• index?: number
Returns
Promise
<null
| Slice
>
Source
packages/framework/block-std/src/clipboard/index.ts:89
copy()
copy(
slice
):Promise
<void
>
Parameters
• slice: Slice
Returns
Promise
<void
>
Source
packages/framework/block-std/src/clipboard/index.ts:134
copySlice()
copySlice(
slice
):Promise
<void
>
Parameters
• slice: Slice
Returns
Promise
<void
>
Source
packages/framework/block-std/src/clipboard/index.ts:241
paste()
paste(
event
,doc
,parent
?,index
?):Promise
<undefined
|null
|Slice
>
Parameters
• event: ClipboardEvent
• doc: Doc
• parent?: string
• index?: number
Returns
Promise
<undefined
| null
| Slice
>
Source
packages/framework/block-std/src/clipboard/index.ts:138
pasteBlockSnapshot()
pasteBlockSnapshot(
snapshot
,doc
,parent
?,index
?):Promise
<BlockModel
<object
>>
Parameters
• snapshot: BlockSnapshot
• doc: Doc
• parent?: string
• index?: number
Returns
Promise
<BlockModel
<object
>>
Source
packages/framework/block-std/src/clipboard/index.ts:231
readFromClipboard()
readFromClipboard(
clipboardData
):any
Parameters
• clipboardData: DataTransfer
Returns
any
Source
packages/framework/block-std/src/clipboard/index.ts:217
registerAdapter()
registerAdapter(
mimeType
,adapter
,priority
):void
Parameters
• mimeType: string
• adapter: BaseAdapter
<unknown
>
• priority: number
= 0
Returns
void
Source
packages/framework/block-std/src/clipboard/index.ts:34
unregisterAdapter()
unregisterAdapter(
mimeType
):void
Parameters
• mimeType: string
Returns
void
Source
packages/framework/block-std/src/clipboard/index.ts:38
unuse()
unuse(
middleware
):void
Parameters
• middleware: JobMiddleware
Returns
void
Source
packages/framework/block-std/src/clipboard/index.ts:30
use()
use(
middleware
):void
Parameters
• middleware: JobMiddleware
Returns
void
Source
packages/framework/block-std/src/clipboard/index.ts:26
writeToClipboard()
writeToClipboard(
updateItems
):Promise
<void
>
Parameters
• updateItems
Returns
Promise
<void
>
Source
packages/framework/block-std/src/clipboard/index.ts:170