EyeDropper: open() メソッド

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

EyeDropper.open() メソッドは、スポイトモードを開始し、ユーザーが色を選択してスポイトモードを終了したときに履行されるプロミスを返します。

構文

js
open()
open(options)

引数

options 省略可

AbortSignal シグナルを渡す用のオプションオブジェクトです。

signal

AbortSignal です。AbortSignal の abort() メソッドを呼ぶと、スポイトモードが終了します。

返値

ユーザーが画面から色を選択すると解決する Promise です。

この Promise は、以下のプロパティを持つオブジェクトで解決します。

sRGBHex

選択された色を 16 進 sRGB 形式 (#aabbcc) で表す文字列です。

例外

例外は投げられるのではなく、Promise が拒否されたとき返されます。この Promise は以下の 2 通りの場合に拒否されます。

  • ユーザーが Escape キーを押してスポイトモードをキャンセルしたとき。
  • スポイトモードが open() の引数として渡した AbortController によって終了させられたとき。

仕様書

Specification
EyeDropper API
# dom-eyedropper-open

ブラウザーの互換性

BCD tables only load in the browser

関連情報

  • 属している EyeDropper インターフェイス