@appluslaboratories/react-copy-to-clipboard
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

ApplusLaboratories react-copy-to-clipboard npm

Copy to clipboard React component

This package is based on copy-to-clipboard & react-copy-to-clipboard

Copy to clipboard

Installation

NPM

npm install --save @appluslaboratories/react-copy-to-clipboard

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

Usage

import React from 'react';
import ReactDOM from 'react-dom';
import {CopyToClipboard} from '@appluslaboratories/react-copy-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.string.isRequired

Text to be copied to clipboard

onCopy: PropTypes.func

Optional callback, will be called when text is copied

onCopy(text, result)

result (bool): Returns true if copied successfully, else false.

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

Optional copy-to-clipboard options.

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 to clipboard</button>
</CopyToClipboard>

Development and testing

Currently is being developed and tested with the latest stable Node 8 on OSX.

To run example covering all CopyToClipboard features, use yarn start, which will compile example/Example.js

git clone https://APPLUSLABCENTRALPRO@dev.azure.com/APPLUSLABCENTRALPRO/Modules/_git/appluslaboratories-react-copy-to-clipboard
cd appluslaboratories-react-copy-to-clipboard
yarn install
yarn start

# then
open http://localhost:8080

Tests

# to run ESLint check
yarn lint

# to run tests
yarn test

# to run end-to-end tests
# first, run `selenium/standalone-firefox:3.4.0` docker image
docker run -p 4444:4444 selenium/standalone-firefox:3.4.0
# then run test
yarn e2e

License

MIT

Package Sidebar

Install

npm i @appluslaboratories/react-copy-to-clipboard

Weekly Downloads

1

Version

1.0.0

License

MIT

Unpacked Size

63.9 kB

Total Files

15

Last publish

Collaborators

  • luigelo.davila.applus