此组件已弃用。请改用 @wordpress/compose 包中的 useCopyToClipboard hook。

使用剪贴板按钮,用户可以通过单击或轻触一次来复制文本(或其他元素)。

剪贴板按钮组件

用法

import { useState } from 'react';
import { ClipboardButton } from '@wordpress/components';

const MyClipboardButton = () => {
    const [ hasCopied, setHasCopied ] = useState( false );
    return (
        <ClipboardButton
            variant="primary"
            text="Text to be copied."
            onCopy={ () => setHasCopied( true ) }
            onFinishCopy={ () => setHasCopied( false ) }
        >
            { hasCopied ? 'Copied!' : 'Copy Text' }
        </ClipboardButton>
    );
};

属性

该组件接受以下属性:

className

将添加到基础 <Button> 组件类名的类名。

  • 类型:string
  • 是否必需:否

text

将被复制到剪贴板的文本。

  • 类型:string
  • 是否必需:是

onCopy

当文本被复制时调用的函数。

  • 类型:() => void
  • 是否必需:是

onFinishCopy

当文本被复制且复制动画完成时调用的函数。

  • 类型:() => void
  • 是否必需:否

继承的属性

任何额外的属性都将传递给基础的 <Button/> 组件。有关可用属性的更多详细信息,请参阅 Button 组件。