updated ClipboardItem and Clipboard documentation and examples using … #33262

tayloregivens · 2024-04-24T19:10:22Z

…supports()

Updated the web API ClipboardItem and Clipboard pages to describe the supports() method. I also updated the code samples that write data to the clipboard so they use the supports method as well.

My team at Microsoft created the supports() static method and so we wanted to go ahead and document on MDN as well.

files/en-us/web/api/clipboard/write/index.md

files/en-us/web/api/clipboard/writetext/index.md

files/en-us/web/api/clipboarditem/clipboarditem/index.md

files/en-us/web/api/clipboarditem/supports/index.md

files/en-us/web/api/clipboard/write/index.md

files/en-us/web/api/clipboarditem/index.md

files/en-us/web/api/clipboarditem/supports/index.md

snianu

Added some comments. PTAL, thanks!

github-actions · 2024-04-25T04:19:00Z

Preview URLs

External URLs (1)

URL: /en-US/docs/Web/API/ClipboardItem/supports_static
Title: ClipboardItem: supports() static method

https://web.dev/articles/async-clipboard (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2024-05-27 03:35:54)

files/en-us/web/api/clipboarditem/supports/index.md

files/en-us/web/api/clipboard/writetext/index.md

wbamberg

Thank you for the PR, @tayloregivens !

files/en-us/web/api/clipboarditem/supports/index.md

files/en-us/web/api/clipboard/writetext/index.md

files/en-us/web/api/clipboarditem/index.md

files/en-us/web/api/clipboard/write/index.md

wbamberg · 2024-04-26T02:17:01Z

Oh, also I missed that the directory for supports should have the _static suffix. See for example json_static or error_static in https://github.com/mdn/content/tree/main/files/en-us/web/api/response. We need to do this to support static and instance methods that have the same name, like https://developer.mozilla.org/en-US/docs/Web/API/Response/json_static and https://developer.mozilla.org/en-US/docs/Web/API/Response/json.

files/en-us/web/api/clipboard/write/index.md

files/en-us/web/api/clipboarditem/supports_static/index.md

files/en-us/web/api/clipboard/write/index.md

files/en-us/web/api/clipboarditem/index.md

captainbrosset

Drive-by approval with a couple of comments. Let's wait for Will to do a more official review.

captainbrosset · 2024-04-30T13:43:23Z

files/en-us/web/api/clipboard/write/index.md

-  const blob = new Blob([text], { type });
-  const data = [new ClipboardItem({ [type]: blob })];
-  await navigator.clipboard.write(data);
+  if (ClipboardItem.supports(type)) {


As discussed offline, let's remove this change since text/plain is always supported.

"image/png" is also listed as a mandatory data type: should we then change the example in the supports() page to use something from the optional list, like "image/svg+xml" ?

We should list the types in supports() as per updated ClipboardItem and Clipboard documentation and examples using … #33262 (comment) - the lists are small and discrete, while the current implication of that doc is you can use any MIME type.

I don't understand it yet, but the interesting optional type I'd like here is the custom type prefixed by web .

@tayloregivens (and @wbamberg) FYI, I'm showing an interest because this is being supported in FF127, and I'm part of the MDN team documenting that, - see #33564 . Great so see work already happening on this!

files/en-us/web/api/clipboard/write/index.md

files/en-us/web/api/clipboarditem/index.md

wbamberg

Thank you for the updates @tayloregivens !

I had just one more suggested change, but I think we also have an open question about whether it's appropriate to use supports() with "img/png" (#33262 (comment)). If not we should use a different MIME type for the supports() page and remove the supports() check from the examples that use "img/png" as well as the plain text ones.

files/en-us/web/api/clipboarditem/index.md

github-actions · 2024-05-03T18:26:47Z

This pull request has merge conflicts that must be resolved before it can be merged.

Since plain text is always supported no need to add support() static method to example

text always support so no need for supports()

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

files/en-us/web/api/clipboard/write/index.md

hamishwillee · 2024-05-20T07:38:51Z

Hi @tayloregivens
I've fixed up the example/conflicts and rebased (this is now a live example). I'll continue with necessary updates tomorrow, unless you have time to look at them.

files/en-us/web/api/clipboarditem/supports_static/index.md

hamishwillee · 2024-05-21T02:39:09Z

@tayloregivens I have fixed this up to address the comments. Let's see if we can get it through review!

@wbamberg Can you please look at this again. The main changes are:

The ClipboardItem and supports() page examples use image/svg+xml for the mime types.
Clipboard.write() still uses image/png and is a live example (merged in from main and slightly modified). I've added a note to make it clear that the supports() check is not really necessary, but highlight some cases where it could be (i.e. showing "for information").
The supports() method now states the supported MIME types. Note that it omits one in the specification that no one has implemented.

tayloregivens · 2024-05-24T23:53:56Z

@tayloregivens I have fixed this up to address the comments. Let's see if we can get it through review!

@wbamberg Can you please look at this again. The main changes are:

The ClipboardItem and supports() page examples use image/svg+xml for the mime types.

Clipboard.write() still uses image/png and is a live example (merged in from main and slightly modified). I've added a note to make it clear that the supports() check is not really necessary, but highlight some cases where it could be (i.e. showing "for information").

The supports() method now states the supported MIME types. Note that it omits one in the specification that no one has implemented.

Thanks for addressing the remaining comments and updating the 'supports()' page to use 'image/svg+xml' and making a note that supports() isn't necessary with 'image/png' on the Clipboard.write()

for 3. the supports method allows web authors to specify any arbitrary type and returns false for types that aren't supported by the browser. If you did want to add extra information there you could say that the mandatory types, html, text, and png are always supported and don't require using supports() static method.

files/en-us/web/api/clipboarditem/supports_static/index.md

Wbamberg changes have been fixed.

files/en-us/web/api/clipboarditem/supports_static/index.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

wbamberg

👍 thank you @tayloregivens and @hamishwillee for your work on this PR!

* upstream/main: (55 commits) Replace `.` with `#` in example given selectors are `#ids` (mdn#33791) update info in cross browser testing strategies (mdn#33730) Clarify that `navigator.storage.persist()` depends on heuristics (mdn#33780) fix typo (mdn#33785) feat: improvements on Glossary/Hoisting (mdn#33787) CSS update: overview of shapes guide (mdn#33771) CSS update: Shapes from box values (mdn#33770) Fix issue 033506: correct droppedEntriesCount (mdn#33538) Revert "=== Symbol("foo")" (mdn#33782) docs(css): FF126 - Support for `shape()` function (mdn#33446) Bump lint-staged from 15.2.4 to 15.2.5 (mdn#33777) Bump ajv from 8.13.0 to 8.14.0 (mdn#33776) Add missing spaces for `subtlecrypto` (mdn#33774) fix: typo in `color_and_luminca` (mdn#33775) feat: improvments on gutters (mdn#33751) FF127Relnote- data: and javascript: URLS forbidden in base HREF (mdn#33738) update the content of SVG `<view>` element (mdn#33710) Clipboard.write() - log and fixes (mdn#33769) updated ClipboardItem and Clipboard documentation and examples using … (mdn#33262) Fix error in the code snippet for Symbol (mdn#33765) ...

tayloregivens requested a review from a team as a code owner April 24, 2024 19:10

tayloregivens requested review from Elchi3 and removed request for a team April 24, 2024 19:10

github-actions bot added Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed labels Apr 24, 2024

github-actions bot reviewed Apr 24, 2024

View reviewed changes

snianu reviewed Apr 24, 2024

View reviewed changes

files/en-us/web/api/clipboard/write/index.md Outdated Show resolved Hide resolved

snianu reviewed Apr 24, 2024

View reviewed changes

files/en-us/web/api/clipboard/write/index.md Show resolved Hide resolved

snianu reviewed Apr 24, 2024

View reviewed changes

files/en-us/web/api/clipboarditem/index.md Outdated Show resolved Hide resolved

snianu reviewed Apr 24, 2024

View reviewed changes

files/en-us/web/api/clipboarditem/index.md Outdated Show resolved Hide resolved

snianu reviewed Apr 24, 2024

View reviewed changes

files/en-us/web/api/clipboarditem/supports/index.md Outdated Show resolved Hide resolved

snianu reviewed Apr 24, 2024

View reviewed changes

captainbrosset reviewed Apr 25, 2024

View reviewed changes

files/en-us/web/api/clipboarditem/supports/index.md Outdated Show resolved Hide resolved

captainbrosset reviewed Apr 25, 2024

View reviewed changes

files/en-us/web/api/clipboard/writetext/index.md Outdated Show resolved Hide resolved

wbamberg requested review from wbamberg and removed request for Elchi3 April 25, 2024 15:32

wbamberg previously requested changes Apr 25, 2024

View reviewed changes

github-actions bot reviewed Apr 29, 2024

View reviewed changes

files/en-us/web/api/clipboard/write/index.md Outdated Show resolved Hide resolved

github-actions bot reviewed Apr 29, 2024

View reviewed changes

files/en-us/web/api/clipboarditem/supports_static/index.md Show resolved Hide resolved

wbamberg reviewed Apr 30, 2024

View reviewed changes

files/en-us/web/api/clipboarditem/supports_static/index.md Outdated Show resolved Hide resolved

wbamberg reviewed Apr 30, 2024

View reviewed changes

files/en-us/web/api/clipboard/write/index.md Outdated Show resolved Hide resolved

wbamberg reviewed Apr 30, 2024

View reviewed changes

files/en-us/web/api/clipboarditem/index.md Outdated Show resolved Hide resolved

wbamberg reviewed Apr 30, 2024

View reviewed changes

files/en-us/web/api/clipboarditem/index.md Outdated Show resolved Hide resolved

captainbrosset approved these changes Apr 30, 2024

View reviewed changes

wbamberg reviewed Apr 30, 2024

View reviewed changes

files/en-us/web/api/clipboarditem/index.md Outdated Show resolved Hide resolved

github-actions bot added the merge conflicts 🚧 [PR only] label May 3, 2024

dipikabh mentioned this pull request May 12, 2024

[Web API] Implement ClipboardItem.supports #33564

Closed

8 tasks

wbamberg and others added 5 commits May 20, 2024 16:53

Fix domxref calls to work with static

ac020c8

Revert changes to writeText file

7009d48

Since plain text is always supported no need to add support() static method to example

changes reverted to write file

6576c41

text always support so no need for supports()

removed "us" in clipboardItem index.md

8dae30c

Update files/en-us/web/api/clipboard/write/index.md

e7270dc

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

hamishwillee force-pushed the clipboard-supports branch from 470c814 to e7270dc Compare May 20, 2024 06:54

github-actions bot reviewed May 20, 2024

View reviewed changes

files/en-us/web/api/clipboard/write/index.md Outdated Show resolved Hide resolved

files/en-us/web/api/clipboard/write/index.md Outdated Show resolved Hide resolved

Fix write() example

5c58947

hamishwillee force-pushed the clipboard-supports branch from abf8d8b to 5c58947 Compare May 20, 2024 07:37

supports() - list supported types

5371498

hamishwillee reviewed May 21, 2024

View reviewed changes

files/en-us/web/api/clipboarditem/supports_static/index.md Show resolved Hide resolved

hamishwillee added 3 commits May 21, 2024 11:49

Update files/en-us/web/api/clipboarditem/index.md

3357f95

index - Change to svg

32eacb8

Note on clipboard.write() about not needing the check

4db0511

hamishwillee requested review from wbamberg and captainbrosset May 21, 2024 02:35

hamishwillee self-requested a review May 24, 2024 04:25

hamishwillee reviewed May 27, 2024

View reviewed changes

files/en-us/web/api/clipboarditem/supports_static/index.md Outdated Show resolved Hide resolved

Update files/en-us/web/api/clipboarditem/supports_static/index.md

3e94619

github-actions bot reviewed May 27, 2024

View reviewed changes

files/en-us/web/api/clipboarditem/supports_static/index.md Outdated Show resolved Hide resolved

wbamberg and others added 2 commits May 26, 2024 20:32

Update files/en-us/web/api/clipboarditem/supports_static/index.md

c1e0950

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Merge branch 'main' into clipboard-supports

d743138

wbamberg approved these changes May 27, 2024

View reviewed changes

wbamberg merged commit 9fca458 into mdn:main May 27, 2024
8 checks passed

hamishwillee mentioned this pull request May 27, 2024

Clipboard.write() - log and fixes #33769

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

updated ClipboardItem and Clipboard documentation and examples using … #33262

updated ClipboardItem and Clipboard documentation and examples using … #33262

tayloregivens commented Apr 24, 2024

snianu left a comment

github-actions bot commented Apr 25, 2024 •

edited

Loading

wbamberg left a comment

wbamberg commented Apr 26, 2024

captainbrosset left a comment

captainbrosset Apr 30, 2024

wbamberg Apr 30, 2024

hamishwillee May 13, 2024 •

edited

Loading

wbamberg left a comment

github-actions bot commented May 3, 2024

hamishwillee commented May 20, 2024

hamishwillee commented May 21, 2024

tayloregivens commented May 24, 2024

wbamberg left a comment

updated ClipboardItem and Clipboard documentation and examples using … #33262

updated ClipboardItem and Clipboard documentation and examples using … #33262

Conversation

tayloregivens commented Apr 24, 2024

snianu left a comment

Choose a reason for hiding this comment

github-actions bot commented Apr 25, 2024 • edited Loading

wbamberg left a comment

Choose a reason for hiding this comment

wbamberg commented Apr 26, 2024

captainbrosset left a comment

Choose a reason for hiding this comment

captainbrosset Apr 30, 2024

Choose a reason for hiding this comment

wbamberg Apr 30, 2024

Choose a reason for hiding this comment

hamishwillee May 13, 2024 • edited Loading

Choose a reason for hiding this comment

wbamberg left a comment

Choose a reason for hiding this comment

github-actions bot commented May 3, 2024

hamishwillee commented May 20, 2024

hamishwillee commented May 21, 2024

tayloregivens commented May 24, 2024

wbamberg left a comment

Choose a reason for hiding this comment

github-actions bot commented Apr 25, 2024 •

edited

Loading

hamishwillee May 13, 2024 •

edited

Loading