https://github.com/silverwind/clippie

Teeny-tiny browser clipboard copy
https://github.com/silverwind/clippie

browser clipboard copy image-copy javascript

Last synced: about 1 year ago
JSON representation

Teeny-tiny browser clipboard copy

• Host: GitHub
• URL: https://github.com/silverwind/clippie
• Owner: silverwind
• Created: 2022-11-24T12:20:04.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-04-13T18:51:33.000Z (about 2 years ago)
• Last Synced: 2024-04-14T08:56:11.019Z (about 2 years ago)
• Topics: browser, clipboard, copy, image-copy, javascript
• Language: JavaScript
• Homepage:
• Size: 352 KB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# clippie

[![](https://img.shields.io/npm/v/clippie.svg?style=flat)](https://www.npmjs.org/package/clippie) [![](https://img.shields.io/npm/dm/clippie.svg)](https://www.npmjs.org/package/clippie) [![](https://img.shields.io/bundlephobia/minzip/clippie.svg)](https://bundlephobia.com/package/clippie) [![](https://packagephobia.com/badge?p=clippie)](https://packagephobia.com/result?p=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

```js

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](./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](https://github.com/silverwind), distributed under BSD licence