TypeError: can't access property "writeText", navigator.clipboard is undefined

配图源自 Freepik

前言

在此前,我们会使用 document.execCommand('copy')document.execCommand('paste') 来实现复杂和粘贴的功能。但它们是同步的,在处理大量文本或者图像解码等耗时较大的情况下,它会阻塞页面。

后来,WHATWG 带来了异步的 Clipboard API,如果用户授予了相应的权限,它就能提供系统剪贴板的读写访问能力,常用于实现剪切、复制和粘贴功能。

它们都暴露于 navigator.clipboard 属性上:

  • navigator.clipboard.write()
  • navigator.clipboard.writeText()
  • navigator.clipboard.read()
  • navigator.clipboard.readText()

均返回 Promise 对象。其中 writeText() 只是通用 write() 方法的一种便捷方法,read()readText() 同理。

其兼容性如下:

问题

这里有一个最简单的示例,利用 navigator.clipboard.writeText() 复制一段文本。

<!DOCTYPE html>
<html lang="en">
  <body>
    <button>Copy</button>
    <script>
      const btn = document.querySelector('button')
      btn.addEventListener('click', copy)

      function copy() {
        navigator.clipboard.writeText(new Date())
      }
    </script>
  </body>
</html>

当我们启用一个本地服务,发现点击复制是不成功的,报错如下:

TypeError: can't access property "writeText", navigator.clipboard is undefined
TypeError: Cannot read properties of undefined (reading 'writeText')

由于

与许多新 API 一样,Clipboard API 仅支持通过 HTTPS 提供的页面。为帮助防止滥用,仅当页面是活动选项卡时才允许访问剪贴板。活动选项卡中的页面无需请求许可即可写入剪贴板,但从剪贴板读取始终需要许可。

Clipboard API 的复制与粘贴能力对应 Permissions APIclipboard-writeclipboard-read 权限。

通过以下示例,我们可以发现:

const queryOpts = { name: 'clipboard-write', allowWithoutGesture: false }
const permissionStatus = await navigator.permissions.query(queryOpts)
console.log(permissionStatus.state) // Will be 'granted', 'denied' or 'prompt'

permissionStatus.state 返回结果是 denied,也就是该权限被设为「拒绝」状态,自然就无法实现复制的目的了。

其实是浏览器的一种安全策略,当页面不安全的时候,全局属性 navigator.clipboard 是不存在的,也就是 undefined,所以就出现前面的问题了。

解决方法

在域名安全的情况下,比如 HTTPSlocalhost127.0.0.1,是可以访问到 navigator.clipboard 对象的。
由于生产环境上几乎都是 HTTPS 了,所以主要面向本地调试的场景,我们可以把类似 http://172.10.3.24:3000 改成 http://localhost:3000 来解决复制问题。

更多

其实 window 对象上有一个属性 isSecureContext 可用于判断当前域名是否安全。

if (window.isSecureContext) {
  // 页面在安全上下文中,所以 Clipboard API 可用
  // do something...
}

许多 Web API 仅能在安全上下文(Secure contexts)中访问。

本地传递的资源,如那些带有 http://127.0.0.1http://localhosthttp://*.localhost 网址(如 http://dev.whatever.localhost/)和 file:// 网址的资源也是认为经过安全传递的。

非本地资源要被认为是安全的,必须满足以下标准:

  • 必须通过 https://wss:// URL 提供服务
  • 用于传送资源的网络信道的安全属性不能是废弃的

参考链接

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,874评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,102评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,676评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,911评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,937评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,935评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,860评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,660评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,113评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,363评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,506评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,238评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,861评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,486评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,674评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,513评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,426评论 2 352

推荐阅读更多精彩内容