Class InternalClipboard

The Internal clipboard is a replacement for the native clipboard api. This should be used for several reasons:

Guarantees that the intra-application clipboard actions will work even if system clipboard is unavailable.
- This can be because the browser doesn't support it (e.g. Firefox)
- The user has restricted native clipboard access
Polyfill for onclipboardchange event.
Implements ReferenceableClipboard. These are items that add a paste callback to the clipboard to allow for items to only be copied when the paste operation is performed.

InternalClipboard will attempt to sync with the native clipboard unless sync is false.

If a mimetype is text/html/image then value will be copied to the clipboard.

Remarks

TODO - If native copy/paste events are fired wrap them.
TODO - Once private web mimeTypes are widely supported we can use them rather than embedding into html
TODO - Allow for service worker to copy across tabs and sessions.

Implements

ReferenceableClipboard

Index

Constructors

constructor

Methods

addEventListener clear close dispatchEvent read readReference readText removeEventListener write writeReference writeText

Constructors

constructor

new InternalClipboard(
options?: InternalClipboard.ConstructorOptions,
): InternalClipboard
Parameters
- Optionaloptions: InternalClipboard.ConstructorOptions
Returns InternalClipboard

Methods

addEventListener

addEventListener(
    type: string,
    callback: EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
Events types supported: copy, cut, paste, nativeSyncWarning, and (clipboardchange as a polyfill)
Parameters
- type: string
  A known string type.
- callback: EventListenerOrEventListenerObject
  A Callback.
- Optionaloptions: boolean | AddEventListenerOptions
  Listener options.
Returns void
Remarks
AddEventListenerOptions.signal is not supported. useCapture is not supported.

See
https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener

Implementation of ReferenceableClipboard.addEventListener

clear

clear(native?: boolean): void
Simple method for clearing the clipboard.
Parameters
- Optionalnative: boolean
  By default this will only clear the reference. Set to true to clear the native clipboard items if available.
Returns void
Implementation of ReferenceableClipboard.clear

close

close(): void
Returns void

dispatchEvent

dispatchEvent(event: Event): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference
Parameters
- event: Event
Returns boolean
Implementation of ReferenceableClipboard.dispatchEvent

read

read(): Promise<ClipboardItems>
MDN Reference

Returns Promise<ClipboardItems>
Implementation of ReferenceableClipboard.read

readReference

readReference<T extends ReferenceableClipboard.ReferenceItem<any>>(): Promise<T>
Allows for an item to be added to the clipboard that is not a Blob.
Type Parameters
- T extends ReferenceableClipboard.ReferenceItem<any>
Returns Promise<T>
Implementation of ReferenceableClipboard.readReference

readText

readText(): Promise<string>
MDN Reference

Returns Promise<string>
Implementation of ReferenceableClipboard.readText

removeEventListener

removeEventListener(
    type: string,
    callback: EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference
Parameters
- type: string
- callback: EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Implementation of ReferenceableClipboard.removeEventListener

write

write(data: ClipboardItems): Promise<void>
MDN Reference
Parameters
- data: ClipboardItems
Returns Promise<void>
Implementation of ReferenceableClipboard.write

writeReference

writeReference<T extends ReferenceableClipboard.ReferenceItem<any>>(
data: T,
): Promise<void>
Allows for an item to be added to the clipboard that is not a serializable blob.
Type Parameters
- T extends ReferenceableClipboard.ReferenceItem<any>
Parameters
- data: T
Returns Promise<void>
Implementation of ReferenceableClipboard.writeReference

writeText

writeText(data: string): Promise<void>
MDN Reference
Parameters
- data: string
Returns Promise<void>
Implementation of ReferenceableClipboard.writeText

Class InternalClipboard

Remarks

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns InternalClipboard

Methods

addEventListener

Parameters

Returns void

Remarks

See

clear

Parameters

Returns void

close

Returns void

dispatchEvent

Parameters

Returns boolean

read

Returns Promise<ClipboardItems>

readReference

Type Parameters

Returns Promise<T>

readText

Returns Promise<string>

removeEventListener

Parameters

Returns void

write

Parameters

Returns Promise<void>

writeReference

Type Parameters

Parameters

Returns Promise<void>

writeText

Parameters

Returns Promise<void>

Settings

On This Page