选项

以下选项允许调整 user-event API 的行为。它们可以在 setup() 中应 用。

advanceTimers

如果你使用假的计时器，当我们内部delay后续代码时，你需要改进你的计时器 。

(delay: number) => Promise<void> | void

默认值: () => Promise.resolve()

applyAccept

当使用 upload() 时，如果元素上存在不符合 accept 属 性的文件，则自动丢弃这种属性。

默认值: true

autoModify

We intend to automatically apply modifier keys for printable characters in the future.
I.e. A implying {Shift>}a{/Shift} if caps lock is not active.

This options allows you to opt out of this change in foresight.
The feature therefore will not constitute a breaking change.

default: true

delay

在一些后续的输入之间，比如输入一系列的字符，代码的执行会按照 setTimeout delay（至少）几秒钟。

这至少将下一个变化转移到下一个宏任务，并允许其它（异步）代码在事件之间运行。

null 可以防止 setTimeout 被调用。

默认值: 0

document

DOM 中的 document.

如果一个 API 被直接调用一个元素，并且没有设置，这将默认 为一个元素的所有者文件。否则，它将回到全局文件。

This defaults to the owner document of an element if an API is called directly with an element and without setup. Otherwise it falls back to the global document.

default: element.ownerDocument ?? globalThis.document

keyboardMap

An array of keyboard keys the keyboard device consists of.

This allows to plug in different layouts / localizations.

default: A "standard" US-104-QWERTY keyboard.

pointerEventsCheck

The pointer API includes a check if an element has or inherits pointer-events: none.
This check is known to be expensive and very expensive when checking deeply nested nodes.

This option determines how often the pointer related APIs perform the check.

This is a binary flag option. You can combine multiple Levels.

• PointerEventsCheckLevel.Never:
  No pointer events check
• PointerEventsCheckLevel.EachTarget:
  Check each event target once
• PointerEventsCheckLevel.EachApiCall:
  Check each event target once per API
• PointerEventsCheckLevel.EachTrigger:
  Check pointer events on every user interaction that triggers a bunch of events. E.g. once for releasing a mouse button even though this triggers pointerup, mouseup, click, etc...

default: PointerEventsCheckLevel.EachApiCall

pointerMap

An array of available pointer keys.

This allows to plug in different pointer devices.

default: A simple mouse and a touchscreen

skipAutoClose

type() automatically releases any keys still pressed at the end of the call.
This option allows to opt out of this feature.

default: false

skipClick

type() implies a click on the element.
This option allows to opt out of this feature.

default: false

skipHover

click() implies moving the cursor to the target element first.
This options allows to opt out of this feature.

writeToClipboard

Write selected data to Clipboard API when a cut or copy is triggered. The Clipboard API is usually not available to test code. Our setup() replaces the navigator.clipboard property with a stub.

default when calling the APIs directly: false
default when calling the APIs on an instance from setup(): true