aboutsummaryrefslogtreecommitdiff
path: root/files/zh-cn/web/api/clipboard_api/index.html
blob: ca91bca0a3994c9bde708d01d8563b4cbc7f4c57 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
---
title: Clipboard API
slug: Web/API/Clipboard_API
tags:
  - API
  - Clipboard
  - Clipboard API
  - 剪贴板
  - 剪贴板 API
  - 参考
translation_of: Web/API/Clipboard_API
---
<div>{{APIRef("Clipboard API")}}</div>

<p>剪贴板 <strong>Clipboard </strong> <strong>API</strong> 提供了响应剪贴板命令(剪切、复制和粘贴)与异步读写系统剪贴板的能力。从权限 <a href="/zh-CN/docs/Web/API/Permissions_API">Permissions API</a> 获取权限之后,才能访问剪贴板内容;如果用户没有授予权限,则不允许读取或更改剪贴板内容。</p>

<p>该 API 被设计用来取代使用 {{domxref("document.execCommand()")}} 的剪贴板访问方式。</p>

<h2 id="访问剪贴板">访问剪贴板</h2>

<p>除了在实例化中创建一个 <code>Clipboard</code> 对象,你还可以使用全局的 {{domxref("Navigator.clipboard")}} 来访问系统剪贴板。</p>

<pre class="brush: js">navigator.clipboard.readText().then(
  clipText =&gt; document.querySelector(".editor").innerText += clipText);</pre>

<p>上述代码提取了剪贴板的文本并将其附在 class 为 <code>editor</code> 的第一个元素后面。因为当剪贴板中不是文本时, {{domxref("Clipboard.readText", "readText()")}} (and {{domxref("Clipboard.read", "read()")}}, for that matter) 会返回一个空字符串,所以这段代码是安全的。</p>

<h2 id="接口">接口</h2>

<dl>
 <dt>{{domxref("Clipboard")}} {{securecontext_inline}}</dt>
 <dd>提供了一个用于读写系统剪贴板上的文本和数据的接口。规范中被称为异步剪贴板 API(Async Clipboard API)。</dd>
 <dt>{{domxref("ClipboardEvent")}} {{securecontext_inline}}</dt>
 <dd>表示提供了有关剪贴板修改的信息的事件,也就是 {{domxref("Element/cut_event", "cut")}}{{domxref("Element/copy_event", "copy")}},和 {{domxref("Element/paste_event", "paste")}}。规范中被称为剪贴板事件 API(Clipboard Event API)。</dd>
</dl>

<h2 id="规范">规范</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">规范</th>
   <th scope="col">状态</th>
   <th scope="col">备注</th>
  </tr>
  <tr>
   <td>{{SpecName('Clipboard API')}}</td>
   <td>{{Spec2('Clipboard API')}}</td>
   <td>初步定义</td>
  </tr>
 </tbody>
</table>

<h2 id="浏览器兼容性">浏览器兼容性</h2>

<h3 id="Clipboard"><code>Clipboard</code></h3>



<p>{{Compat("api.Clipboard")}}</p>

<h3 id="ClipboardEvent"><code>ClipboardEvent</code></h3>

<div class="hidden">The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out <a href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> and send us a pull request.</div>

<p>{{Compat("api.ClipboardEvent")}}</p>

<h2 id="参见">参见</h2>

<ul>
 <li>权限 API:<a href="/zh-CN/docs/Web/API/Permissions_API">Permissions API</a></li>
 <li><a href="/zh-CN/docs/Web/API/Permissions_API/Using_the_Permissions_API">使用权限 API</a></li>
</ul>