EyeDropper
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The EyeDropper interface represents an instance of an eyedropper tool that can be opened and used by the user to select colors from the screen.
Constructor
EyeDropper()-
Returns a new
EyeDropperinstance.
Instance methods
The EyeDropper interface doesn't inherit any methods.
EyeDropper.open()-
Returns a promise that resolves to an object that gives access to the selected color.
Examples
Opening the eyedropper tool and sampling a color
This example shows how to open an eyedropper tool and wait for the user to either select a pixel from the screen, or press Escape to cancel the eyedropper mode.
HTML
html
<button id="start-button">Open the eyedropper</button> <span id="result"></span>
JavaScript
js
document.getElementById("start-button").addEventListener("click", () => {
const resultElement = document.getElementById("result");
if (!window.EyeDropper) {
resultElement.textContent =
"Your browser does not support the EyeDropper API";
return;
}
const eyeDropper = new EyeDropper();
eyeDropper
.open()
.then((result) => {
resultElement.textContent = result.sRGBHex;
resultElement.style.backgroundColor = result.sRGBHex;
})
.catch((e) => {
resultElement.textContent = e;
});
});
Result
Aborting the eyedropper mode
This example shows that the eyedropper mode can also be aborted before the user has selected a color or pressed Escape.
HTML
html
<button id="start-button">Open the eyedropper</button> <span id="result"></span>
JavaScript
js
document.getElementById("start-button").addEventListener("click", () => {
const resultElement = document.getElementById("result");
if (!window.EyeDropper) {
resultElement.textContent =
"Your browser does not support the EyeDropper API";
return;
}
const eyeDropper = new EyeDropper();
const abortController = new AbortController();
eyeDropper
.open({ signal: abortController.signal })
.then((result) => {
resultElement.textContent = result.sRGBHex;
resultElement.style.backgroundColor = result.sRGBHex;
})
.catch((e) => {
resultElement.textContent = e;
});
setTimeout(() => {
abortController.abort();
}, 2000);
});
Result
Specifications
| Specification |
|---|
| EyeDropper API # eyedropper-interface |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
EyeDropper
|
|
|
|
|
|
|
|
|
|
|
|
|
EyeDropper() constructor
|
|
|
|
|
|
|
|
|
|
|
|
|
open
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Secure context required
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- See implementation notes.