annuhdo/react-clipboard.js

React wrapper for clipboard.js (flashless clipboard)

React-Clipboard

React wrapper for clipboard.js

Installation

$ npm i --save react-clipboard.js

Usage

You can use clipboard.js original data-* attributes:

import React, { Component } from 'react';
import ClipboardButton from 'react-clipboard.js';

class MyView extends Component {
  render() {
    return (
      <ClipboardButton data-clipboard-text="I'll be copied">
        copy to clipboard
      </ClipboardButton>
    );
  }
}

React.render(<MyView/>, document.getElementById('app'));

• If you want to provide any constructor option as in new Clipboard('#id', options), you may use option-* attributes

• callbacks will be connected via on* attributes (such as onSuccess)

import React, { Component } from 'react';
import ClipboardButton from 'react-clipboard.js';

class MyView extends Component {
  constructor() {
    super();

    this.onSuccess = this.onSuccess.bind(this);
    this.getText = this.getText.bind(this);
  }

  onSuccess() {
    console.info('successfully coppied');
  }

  getText() {
    return 'I\'ll be copied';
  }

  render() {
    // Providing option-text as this.getText works the same way as providing:
    //
    // var clipboard = new Clipboard('#anything', {
    //   text: this.getText,
    // });
    //
    // onSuccess works as a 'success' callback:
    //
    // clipboard.on('success', this.onSuccess);
    return (
      <ClipboardButton option-text={this.getText} onSuccess={this.onSuccess}>
        copy to clipboard
      </ClipboardButton>
    );
  }
}

React.render(<MyView/>, document.getElementById('app'));

Custom HTML tags may be used as well:

import React, { Component } from 'react';
import ClipboardButton from 'react-clipboard.js';

class MyView extends Component {
  render() {
    // Clipboard is now rendered as an '<a>'
    return (
      <Clipboard component="a" button-href="#" data-clipboard-text="I'll be copied">
        copy to clipboard
      </Clipboard>
    );
  }
}

Default html properties may be passed with the button-* pattern:

import React, { Component } from 'react';
import ClipboardButton from 'react-clipboard.js';

class MyView extends Component {
  render() {
    return (
      <ClipboardButton data-clipboard-text="I'll be copied" button-title="I'm a tooltip">
        copy to clipboard
      </ClipboardButton>
    );
  }
}

React.render(<MyView/>, document.getElementById('react-body'));

License

This code is released under CC0 (Public Domain)