@types/react-copy-to-clipboard

What is @types/react-copy-to-clipboard?

@types/react-copy-to-clipboard provides TypeScript definitions for the react-copy-to-clipboard package, which is a React component for copying text to the clipboard.

What are @types/react-copy-to-clipboard's main functionalities?

Copy Text to Clipboard

This feature allows you to copy text to the clipboard. The example demonstrates a simple input field where the user can type text, and a button to copy that text to the clipboard. When the text is copied, a message is displayed.

import React, { useState } from 'react';
import { CopyToClipboard } from 'react-copy-to-clipboard';

const CopyExample = () => {
  const [text, setText] = useState('Hello, World!');
  const [copied, setCopied] = useState(false);

  return (
    <div>
      <input value={text} onChange={(e) => setText(e.target.value)} />
      <CopyToClipboard text={text} onCopy={() => setCopied(true)}>
        <button>Copy to Clipboard</button>
      </CopyToClipboard>
      {copied ? <span style={{ color: 'red' }}>Copied.</span> : null}
    </div>
  );
};

export default CopyExample;

Other packages similar to @types/react-copy-to-clipboard

react-copy-to-clipboard

react-copy-to-clipboard is the underlying package that @types/react-copy-to-clipboard provides TypeScript definitions for. It offers the same functionality of copying text to the clipboard but without TypeScript support.

clipboard.js

clipboard.js is a popular library for copying text to the clipboard. It is not specific to React and can be used in any JavaScript project. It provides more control and customization options compared to react-copy-to-clipboard.

react-clipboard.js

react-clipboard.js is another React component for copying text to the clipboard. It is similar to react-copy-to-clipboard but offers additional features like copying rich text and images.

README

Installation

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

Summary

This package contains type definitions for react-copy-to-clipboard (https://github.com/nkbt/react-copy-to-clipboard).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-copy-to-clipboard.

index.d.ts

import * as React from "react";

export as namespace CopyToClipboard;

declare class CopyToClipboard extends React.PureComponent<CopyToClipboard.Props> {}

declare namespace CopyToClipboard {
    class CopyToClipboard extends React.PureComponent<Props> {}

    interface Options {
        debug?: boolean | undefined;
        message?: string | undefined;
        format?: string | undefined; // MIME type
    }

    interface Props {
        children?: React.ReactNode;
        text: string;
        onCopy?(text: string, result: boolean): void;
        options?: Options | undefined;
    }
}

export = CopyToClipboard;

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: @types/react

Credits

These definitions were written by Meno Abels, Bernabe, and Ward Delabastita.