1766860 - Revise the prefs for clipboard API

Status: RESOLVED FIXED

(Core :: DOM: Copy & Paste and Drag & Drop, task)

Description

[Edgar Chen [:edgar]]

Currently, dom.events.asyncClipboard.clipboardItem is used to control Clipboard.write and also ClipboardItem interface, and dom.events.asyncClipboard.read is used to control Clipboard.read only.

But exposing Clipboard.read will also need to expose ClipboardItem interface. And we plan to work on Clipboard.read first.

So in this bug, I would like to

• Make dom.events.asyncClipboard.read controls both Clipboard.read and ClipboardItem interface.
• Rename dom.events.asyncClipboard.clipboardItem to dom.events.asyncClipboard.write and make it only controls Clipboard.write().

Comment 1

[Tom S]

In my opinion we should only expose ClipboardItem together with Clipboard.write. Clipboard.read will work even without exposing ClipboardItem directly.

Comment 2

[Edgar Chen [:edgar]]

But Clipboard.read do return a ClipboardItem instance, but there is no ClipboardItem interface exposed, which is not trivial. We could hide the constructor for Clipboard.write. WDYT?

Comment 3

[Tom S]

But Clipboard.read do return a ClipboardItem instance, but there is no ClipboardItem interface exposed, which is not trivial.

I am not sure what you mean "is not trivial". Only partially exposing these features is of course far from ideal, but I think exposing ClipboardItem and not clipboard.write will lead to compatibility issues. When you say hide the constructor, would that mean "window.ClipboardItem" doesn't exist?

Comment 4

[Edgar Chen [:edgar]]

(In reply to Tom Schuster [:evilpie] from comment #3)

When you say hide the constructor, would that mean "window.ClipboardItem" doesn't exist?

I mean https://searchfox.org/mozilla-central/rev/86c98c486f03b598d0f80356b69163fd400ec8aa/dom/webidl/Clipboard.webidl#36-38 doesn't exist.
Note that once someone calls clipboard.read(), window.ClipboardItem will also be defined, I think it might because we create a ClipboardItem instance.

Comment 5

[Edgar Chen [:edgar]]

(In reply to Tom Schuster [:evilpie] from comment #3)

I think exposing ClipboardItem and not clipboard.write will lead to compatibility issues.

Could you elaborate why?

Comment 6

[Tom S]

Because I think it's quite likely that code (like this) will assume that when ClipboardItem is available then clipboard.write is also available.

Comment 7

[Edgar Chen [:edgar]]

Okay, thanks. So give that there is already an example for that, then I think we should expose them all together.

Comment 8

[Edgar Chen [:edgar]]

Attachment: Bug 1766860 - Revise the prefs for clipboard API;

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/fbf680efd6dc
Revise the prefs for clipboard API; r=evilpie,nika

Comment 10

[Cosmin Sabou [:CosminS]]

https://hg.mozilla.org/mozilla-central/rev/fbf680efd6dc