react-copy-html-to-clipboard

Copy text/html to clipboard React component

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
react-copy-html-to-clipboard
206.0.47 years ago7 years agoMinified + gzip package size for react-copy-html-to-clipboard in KB

Readme

react-copy-html-to-clipboard npm
Gitter
CircleCI AppVeyor Coverage Dependencies Dev Dependencies
Copy text/html to clipboard React component
Forked from react-copy-to-clipboard
Based on copy-html-to-clipboard
Would try to use execCommand with fallback to IE specific clipboardData interface and finally, fallback to simple prompt with proper text content & 'Copy to clipboard: Ctrl+C, Enter'

Copy to clipboard

Installation

NPM

npm install --save react react-copy-html-to-clipboard

Don't forget to manually install peer dependencies (react) if you use npm@3.

Bower:

bower install --save https://unpkg.com/react-copy-to-clipboard/bower.zip

or in bower.json
{
  "dependencies": {
    "react-copy-to-clipboard": "https://unpkg.com/react-copy-to-clipboard/bower.zip"
  }
}

then include as
<script src="bower_components/react/react.js"></script>
<script src="bower_components/react-copy-to-clipboard/build/react-copy-to-clipboard.js"></script>

1998 Script Tag:

<script src="https://unpkg.com/react/dist/react.js"></script>
<script src="https://unpkg.com/react-copy-to-clipboard/build/react-copy-to-clipboard.js"></script>
(Module exposed as `CopyToClipboard`)

Demo

http://nkbt.github.io/react-copy-to-clipboard

Codepen demo

http://codepen.io/nkbt/pen/eNPoQv

Usage

import React from 'react';
import ReactDOM from 'react-dom';
import CopyToClipboard from 'react-copy-html-to-clipboard';

class App extends React.Component {
  state = {
    value: '',
    copied: false,
  }

  render() {
    return (
      <div>
        <input value={this.state.value}
          onChange={({target: {value}}) => this.setState({value, copied: false})} />

        <CopyToClipboard text={this.state.value}
          onCopy={() => this.setState({copied: true})}>
          <span>Copy to clipboard with span</span>
        </CopyToClipboard>

        <CopyToClipboard text={() => this.state.value}
          onCopy={() => this.setState({copied: true})}>
          <button>Copy to clipboard with button</button>
        </CopyToClipboard>

        {this.state.copied ? <span style={{color: 'red'}}>Copied.</span> : null}
      </div>
    );
  }
}

const appRoot = document.createElement('div');
document.body.appendChild(appRoot);
ReactDOM.render(<App />, appRoot);

Options

text: PropTypes.any.isRequired

Text/html to be copied to clipboard or function returning text/html

onCopy: PropTypes.func

Optional callback, will be called when text/html is copied
onCopy(text, result)
result (bool): Returns true if copied successfully, else false.

options: PropTypes.shape({asHtml: bool, onlyHtml: bool, canUsePrompt: bool, debug: bool, message: string})

Optional copy-html-to-clipboard options:
asHtml: PropTypes.bool
True - use param text as html
onlyHtml: PropTypes.bool
True - if can't copy html to clipboard, don't try to copy text with alternative ways
canUsePrompt: PropTypes.bool
True - try alternative ugly prompt-way
See API docs for details

children: PropTypes.node.isRequired

CopyToClipboard is a simple wrapping component, it does not render any tags, so it requires the only child element to be present, which will be used to capture clicks.
<CopyToClipboard text="Hello!">
  <button>Copy text to clipboard</button>
</CopyToClipboard>

<CopyToClipboard text="Hello, <b>I am bold</b>!" options={{asHtml: true}} >
  <button>Copy html to clipboard</button>
</CopyToClipboard>

Development and testing

Currently is being developed and tested with the latest stable Node 7 on OSX and Windows.
To run example covering all CopyToClipboard features, use npm start dev, which will compile src/example/Example.js
git clone git@github.com:nkbt/react-copy-to-clipboard.git
cd react-copy-to-clipboard
npm install
npm start dev

# then
open http://localhost:8080

Tests

# to run tests
npm start test

# to generate test coverage (./reports/coverage)
npm start test.cov

# to run end-to-end tests
npm start test.e2e

License

MIT