CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

DataTransfer (clipboard)

@ckeditor/ckeditor5-clipboard/src/datatransfer

class
See source

A facade over the native DataTransfer object.

Filtering

Properties

  • dropEffect

    See source

    The actual drop effect.

    Parameters

    value : String

  • effectAllowed

    See source

    The effect that is allowed for a drag operation.

    Parameters

    value : String

  • files : Array.<File>

    readonly

    See source

    The array of files created from the native DataTransfer#files or DataTransfer#items.

  • isCanceled

    See source

    Whether the dragging operation was canceled.

  • types

    See source

    Returns an array of available native content types.

  • _native : DataTransfer

    private

    See source

    The native DataTransfer object.

Methods

  • getData( type ) → String

    See source

    Gets the data from the data transfer by its MIME type.

    dataTransfer.getData( 'text/plain' );

    Parameters

    type : String

    The MIME type. E.g. text/html or text/plain.

    Returns

    String

  • setData( type, data )

    See source

    Sets the data in the data transfer.

    Parameters

    type : String

    The MIME type. E.g. text/html or text/plain.

    data : String