Welcome What's new in Chrome extensions Getting started API Reference Samples
Welcome What's new in Chrome extensions Getting started API Reference Samples

chrome.clipboard

This API is part of the deprecated Chrome Apps platform. Learn more about migrating your app.
  • Description

    The chrome.clipboard API is provided to allow users to access data of the clipboard. This is a temporary solution for chromeos platform apps until open-web alternative is available. It will be deprecated once open-web solution is available, which could be in 2017 Q4.

  • Permissions
    clipboard
  • Availability
    Dev channel

Summary

Types

AdditionalDataItem

Properties

  • data

    string

    Content of the additional data item. Either the plain text string if type is "textPlain" or markup string if type is "textHtml". The data can not exceed 2MB.

  • Type of the additional data item.

DataItemType

Type

"textPlain"

, or

"textHtml"

ImageType

Supported image types.

Type

"png"

, or

"jpeg"

Methods

setImageData

chrome.clipboard.setImageData(
  imageData: ArrayBuffer,
  type: ImageType,
  additionalItems?: AdditionalDataItem[],
  callback?: function,
)
Promise Chrome 57+

Sets image data to clipboard.

Parameters

  • imageData

    ArrayBuffer

    Chrome 60+

    The encoded image data.

  • The type of image being passed.

  • additionalItems

    AdditionalDataItem[] optional

    Chrome 60+

    Additional data items for describing image data. The callback is called with chrome.runtime.lastError set to error code if there is an error. Requires clipboard and clipboardWrite permissions.

  • callback

    function optional

    The callback parameter looks like: () => void

Returns

  • Promise<void>

    Pending

    This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Events

onClipboardDataChanged

chrome.clipboard.onClipboardDataChanged.addListener(
  callback: function,
)
Chrome 54+

Fired when clipboard data changes. Requires clipboard and clipboardRead permissions for adding listener to chrome.clipboard.onClipboardDataChanged event. After this event fires, the clipboard data is available by calling document.execCommand('paste').

Parameters

  • callback

    function

    The callback parameter looks like: () => void

We serve cookies on this site to analyze traffic, remember your preferences, and optimize your experience.