useCopyToClipboard

將文本複製到用戶的剪貼板。

useCopyToClipboard 封裝了 Clipboard API，提供一個包含最近複製文字和 copy 函式的便捷元組。這是 useClipboard 的直接替代別名，你可以根據程式碼庫的命名慣例選擇使用任一名稱。完整詳情請參閱 useClipboard。

使用場景

  • 當你偏好 useCopyToClipboard 命名慣例時，新增「複製到剪貼簿」功能
  • 從使用此命名模式的其他 hook 函式庫遷移
  • 任何適用 useClipboard 的場景——兩個 hooks 可互換使用

注意事項

  • SSR 安全：在伺服器端渲染時回傳空字串和空操作函式。伺服器上不會存取 navigator。
  • 瀏覽器支援：需要 Clipboard API（所有現代瀏覽器均支援）。
  • 權限：某些瀏覽器需要使用者授權才能存取剪貼簿。可搭配 usePermission 檢查 clipboard-read 和 clipboard-write 狀態。

用法

Live Editor
function Demo() {
  const [value, setValue] = useState("");
  const [text, copy] = useCopyToClipboard();
  const permissionRead = usePermission("clipboard-read");
  const permissionWrite = usePermission("clipboard-write");
  return (
    <div>
      <p>
        剪貼板權限: 讀取 <b>{permissionRead}</b> | 寫入&nbsp;
        <b>{permissionWrite}</b>
      </p>
      <p>
        當前複製的內容: <code>{text || "無"}</code>
      </p>
      <input
        value={value}
        onChange={(event) => {
          setValue(event.currentTarget.value);
        }}
      />
      <button onClick={() => copy(value)}>複製</button>
    </div>
  );
};
Result

API

useClipBoard

Returns

readonly [string, (txt: string) => Promise<void>]: 返回唯讀元組.

Arguments