Skip to content

Teeny-tiny browser clipboard copy

Notifications You must be signed in to change notification settings

silverwind/clippie

Repository files navigation

clippie

clippie copies text and images to clipboard in browsers. Text copy works on both secure and insecure contexts (via fallback), image or array copy requires a secure context (https or localhost).

Usage

import {clippie} from "clippie";

// copy text
const success = await clippie("text to copy");

// copy image
const success = await clippie(imageBlob);

// copy image and text at once
const success = await clippie([imageBlob, "image description"]);

See index.html for more example.

API

clippie(content, [options])

  • content String, Blob, Array[String,Blob]: Content to copy. If an Array is passed, will construct a ClipboardItem with all items where only one item per type (blob.type or text/plain for strings) is allowed.
  • options Object
    • reject: Boolean: Whether to reject on unexpected errors. Default: false.

Returns true when all content was successfully copied, false when not. Will never throw unless reject is true.

© silverwind, distributed under BSD licence