Interface ReferenceItem<T>

Interface that allows for references to be copied.

interface ReferenceItem<T = any> {
    isClipboardItem: true;
    editMode?(): EditMode;
    getItem?(): T;
    getItemType(): string;
    isCut?(): boolean;
    toHtml?(): string | Promise<string>;
    toImage?(): Blob | Promise<Blob>;
    toText?(): string | Promise<string>;
}

Type Parameters

T = any

Index

Properties

isClipboardItem

Methods

editMode? getItem? getItemType isCut? toHtml? toImage? toText?

Properties

isClipboardItem

isClipboardItem: true

For runtime introspection.

Methods

`Optional`editMode

editMode?(): EditMode

When adding an item to the clipboard an EditMode can be associated.

Returns EditMode

`Optional`getItem

getItem?(): T

Access to the underling reference.

Returns T

getItemType

getItemType(): string

A key that indicates the type of item returned from getItem.

Returns string

Remarks
This should be unique key for the application.

`Optional`isCut

isCut?(): boolean
Indicates if the operation is a cut.

Returns boolean
Default Value
```
false
```

`Optional`toHtml

toHtml?(): string | Promise<string>

Allow items to be copied as html.

Returns string | Promise<string>

`Optional`toImage

toImage?(): Blob | Promise<Blob>

Allow items to be copied as an image Blob.

Returns Blob | Promise<Blob>

`Optional`toText

toText?(): string | Promise<string>

Allow items to be copied as text.

Returns string | Promise<string>