オプション
以下のオプションを使用すると、user-event API の動作を調整できます。これらは、setup() ごとに適用できます。
advanceTimers
user-event は、一部の連続した入力の間に 遅延 を追加します。フェイクタイマー を使用する場合、このオプションをテストランナーの時刻を進める関数に設定する必要があります。例:
const user = userEvent.setup({advanceTimers: jest.advanceTimersByTime})
フェイクタイマーを使用する際にテストタイムアウトを防ぐために、delay: null を設定することが推奨されている場合があります。これは予期しない動作を引き起こす可能性があるため、推奨されません。v14.1 以降では、代わりに advanceTimers オプションを使用することをお勧めします。
(delay: number) => Promise<void> | void
default: () => Promise.resolve()
applyAccept
upload() を使用する際に、要素に accept プロパティが存在する場合、そのプロパティに一致しないファイルを自動的に破棄します。
default: true
autoModify
将来的に、印刷可能な文字の修飾キーを自動的に適用する予定です。
例えば、Caps Lock がアクティブでない場合、A は {Shift>}a{/Shift} を意味します。
このオプションを使用すると、この変更を事前にオプトアウトできます。
したがって、この機能は破壊的な変更とは見なされません。
default: true
delay
一連の文字を入力するなど、一部の連続した入力の間で、コードの実行が setTimeout で (少なくとも) delay ミリ秒遅延されます。
これにより、次の変更が少なくとも次のマクロタスクに移動し、イベント間で他の (非同期) コードが実行できるようになります。
null を設定すると、setTimeout が呼び出されなくなります。
default: 0
document
ドキュメント。
これは、APIが要素を使用して直接呼び出され、セットアップなしで呼び出された場合、要素のオーナー ドキュメントがデフォルトになります。それ以外の場合は、グローバルドキュメントに戻ります。
default: element.ownerDocument ?? globalThis.document
keyboardMap
キーボードデバイスを構成するキーボードキーの配列。
これにより、異なるレイアウト/ローカライズをプラグインできます。
default: 「標準」の US-104-QWERTY キーボード。
pointerEventsCheck
ポインターAPIには、要素が pointer-events: none を持っているか、または継承しているかどうかを確認するチェックが含まれています。
このチェックはコストが高く、深くネストされたノードをチェックする場合は非常にコストがかかることが知られています。
このオプションは、ポインター関連のAPIがチェックを実行する頻度を決定します。
これはバイナリフラグオプションです。複数のレベルを組み合わせることができます。
PointerEventsCheckLevel.Never:
ポインターイベントチェックなしPointerEventsCheckLevel.EachTarget:
各イベントターゲットを1回チェックPointerEventsCheckLevel.EachApiCall:
APIごとに各イベントターゲットを1回チェックPointerEventsCheckLevel.EachTrigger:
多数のイベントをトリガーするすべてのユーザーインタラクションでポインターイベントをチェックします。例:pointerup、mouseup、clickなどをトリガーする場合でも、マウスボタンを離す場合は1回のみ。
default: PointerEventsCheckLevel.EachApiCall
pointerMap
利用可能なポインターキーの配列。
これにより、異なるポインターデバイスをプラグインできます。
default: シンプルなマウスとタッチスクリーン
skipAutoClose
type() は、呼び出しの最後に押されたままになっているすべてのキーを自動的に解放します。
このオプションを使用すると、この機能をオプトアウトできます。
default: false
skipClick
type() は、要素のクリックを意味します。
このオプションを使用すると、この機能をオプトアウトできます。
default: false
skipHover
click() は、最初にカーソルをターゲット要素に移動することを意味します。
このオプションを使用すると、この機能をオプトアウトできます。
default: false
writeToClipboard
cut または copy がトリガーされたときに、選択したデータを Clipboard API に書き込みます。通常、Clipboard API はテストコードでは使用できません。setup() は、navigator.clipboard プロパティをスタブで置き換えます。
直接APIを呼び出す場合のdefault: false
setup() からのインスタンスでAPIを呼び出す場合のdefault: true