Update clipboard API docs to better represent ClipboardItem with string item data #37677
+57
−43
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chrisdavidmills
requested review from
sideshowbarker
and removed request for
a team
github-actions
bot
added
Content:WebAPI
chrisdavidmills
changed the title
tomayac
reviewed
Jan 16, 2025
| @@ -34,8 +34,7 @@ A {{jsxref("Promise")}} that resolves with a {{domxref("Blob")}} object. | |||
|
|
|||
| ## Examples | |||
|
|
|||
| In the following example, we're returning all items on the clipboard via the {{domxref("clipboard.read()")}} method. | |||
| Then utilizing the {{domxref("ClipboardItem.types")}} property to set the `getType()` argument and return the corresponding blob object. | |||
| In the following example, we're returning all items on the clipboard via the {{domxref("clipboard.read()")}} method, then using the {{domxref("ClipboardItem.types")}} property to set the `getType()` argument and return the corresponding `Blob` object. | |||
There was a problem hiding this comment.
Suggested change
| In the following example, we're returning all items on the clipboard via the {{domxref("clipboard.read()")}} method, then using the {{domxref("ClipboardItem.types")}} property to set the `getType()` argument and return the corresponding `Blob` object. | |
| In the following example, we're returning all items on the clipboard via the {{domxref("clipboard.read()")}} method, then using the {{domxref("ClipboardItem.types")}} property to set the `getType()` argument, and return the corresponding `Blob` object. |
There was a problem hiding this comment.
I fixed this one in a slightly different way:
In the following example, we're returning all items on the clipboard via the {{domxref("clipboard.read()")}} method. For each one, we pass the {{domxref("ClipboardItem.types")}} property to the
getType()method, which returns the correspondingBlobobject.
| ### Writing to the clipboard | ||
| ### Writing text to the clipboard | ||
|
|
||
| In this example we first define two constants, which respectively contain references to a {{htmlelement("p")}} element containing some text, and a {{htmlelement("button")}}. |
There was a problem hiding this comment.
Suggested change
| In this example we first define two constants, which respectively contain references to a {{htmlelement("p")}} element containing some text, and a {{htmlelement("button")}}. | |
| In this example, we first define two constants, which respectively contain references to a {{htmlelement("p")}} element containing some text, and a {{htmlelement("button")}} element. |
There was a problem hiding this comment.
I fixed this one like so:
In this example we first define two constants containing references to a {{htmlelement("p")}} element containing some text and a {{htmlelement("button")}} element.
Co-authored-by: Thomas Steiner <[email protected]>
Co-authored-by: Thomas Steiner <[email protected]>
Co-authored-by: Thomas Steiner <[email protected]>
Yay, thanks for the technical review, @tomayac! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Chrome 133 now supports using item data of type string or a promise that resolves to a string when constructing a
ClipboardItemobject. Previously, Chrome only supported item data of typeBlob, or a promise that resolves to aBlob, but this change brings it up to full standards support and parity with Firefox and Safari.This PR mostly makes small changes to multiple pages to improve grammar and make sure
ClipboardItemwith string data is represented as a valid possibility.I have also added a small example to the
ClipboardItemlanding page to show the simple case for text, where you don't need to use a Blob.Motivation
Additional details
See https://chromestatus.com/feature/4926138582040576 for the data source.
The example I used for testing can be found at https://clipboard-api-string-test.glitch.me/.
Related issues and pull requests
BCD: mdn/browser-compat-data#25673