小程序开放平台

文档中心
基础
界面
网络
数据缓存
媒体
位置
开放接口
设备
剪贴板
getClipboardData
setClipboardData
网络
电话
内存
扫码
XHSML
性能
文件
数据分析
画布

xhs.setClipboardData

开发
>
JS API
>
设备
>
剪贴板
>
setClipboardData
>
更新时间:2025-04-11 18:44:47

以Promise风格调用: 支持

设置系统剪贴板的内容。调用成功后,会弹出 toast 提示'内容已复制',持续 1.5s。

参数

Object object

属性
类型
默认值
必填
说明
datastring剪贴板的内容
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

属性
类型
说明
errMsgstring

实例代码

function setClipboardData(data) {
  return new Promise((resolve, reject) => {
    xhs.setClipboardData({
      data, // 要设置到剪贴板的内容
      success: (res) => {
        console.log('设置剪贴板内容成功:', res);
        resolve(res); // 返回成功信息
      },
      fail: (err) => {
        console.error('设置剪贴板内容失败:', err);
        reject(err); // 返回错误信息
      },
      complete: () => {
        console.log('设置剪贴板操作完成');
      }
    });
  });
}

// 调用示例
setClipboardData('这是要复制到剪贴板的内容')
  .then((res) => {
    console.log('操作成功:', res.errMsg);
  })
  .catch((err) => {
    console.error('操作失败:', err);
  });