Ir para o conteúdo principal

Opções

[Tradução Beta Não Oficial]

Esta página foi traduzida por PageTurner AI (beta). Não é oficialmente endossada pelo projeto. Encontrou um erro? Reportar problema →

As opções a seguir permitem ajustar o comportamento das APIs do user-event. Elas podem ser aplicadas por meio de setup().

advanceTimers​

O user-event adiciona um delay entre algumas entradas subsequentes. Ao usar fake timers, é necessário definir esta opção para a função de avanço de tempo do seu test runner. Por exemplo:

const user = userEvent.setup({advanceTimers: jest.advanceTimersByTime})
cuidado

Você pode encontrar sugestões para definir delay: null para evitar timeouts em testes ao usar fake timers. Isso não é recomendado, pois pode causar comportamento inesperado. A partir da v14.1, sugerimos usar a opção advanceTimers em vez disso.

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

default: () => Promise.resolve()

applyAccept​

Ao usar upload(), descarta automaticamente arquivos que não correspondem à propriedade accept quando essa propriedade existe no elemento.

default: true

autoModify​

Pretendemos aplicar automaticamente teclas modificadoras para caracteres imprimíveis no futuro.
Por exemplo, A implicaria {Shift>}a{/Shift} se o caps lock não estiver ativo.

Esta opção permite recusar antecipadamente essa alteração.
O recurso, portanto, não constituirá uma breaking change.

default: true

delay​

Entre algumas entradas subsequentes, como digitar uma série de caracteres, a execução do código é atrasada via setTimeout por (pelo menos) delay milissegundos.

Isso move as próximas alterações para pelo menos a próxima macro task e permite que outro código (assíncrono) seja executado entre eventos.

null impede a chamada do setTimeout.

default: 0

document​

O documento.

Por padrão, usa o owner document de um elemento se uma API for chamada diretamente com um elemento e sem setup. Caso contrário, recai para o documento global.

default: element.ownerDocument ?? globalThis.document

keyboardMap​

Um array de teclas do teclado que compõem o dispositivo.

Isso permite conectar diferentes layouts/localizações.

default: Um teclado "padrão" US-104-QWERTY.

pointerEventsCheck​

A API de ponteiro inclui uma verificação se um elemento tem ou herda pointer-events: none.
Essa verificação é conhecida por ser custosa e muito custosa ao verificar nós profundamente aninhados.

Esta opção determina com que frequência as APIs relacionadas a ponteiros executam a verificação.

Esta é uma opção de flag binária. Você pode combinar múltiplos níveis.

  • PointerEventsCheckLevel.Never:
    Sem verificação de pointer events

  • PointerEventsCheckLevel.EachTarget:
    Verifica cada event target uma vez

  • PointerEventsCheckLevel.EachApiCall:
    Verifica cada event target uma vez por API

  • PointerEventsCheckLevel.EachTrigger:
    Verifica pointer events em toda interação do usuário que dispara múltiplos eventos. Ex.: uma vez ao soltar um botão do mouse, mesmo que isso dispare pointerup, mouseup, click, etc...

default: PointerEventsCheckLevel.EachApiCall

pointerMap​

Um array de botões de ponteiro disponíveis.

Isso permite conectar diferentes dispositivos de ponteiro.

default: Um mouse simples e uma tela sensível ao toque

skipAutoClose​

type() libera automaticamente quaisquer teclas ainda pressionadas ao final da chamada.
Esta opção permite recusar esse comportamento.

default: false

skipClick​

type() implica em um clique no elemento.
Esta opção permite recusar esse comportamento.

default: false

skipHover​

click() implica em mover o cursor primeiro para o elemento alvo.
Esta opção permite recusar esse comportamento.

default: false

writeToClipboard​

Grava dados selecionados na API Clipboard quando um cut ou copy é acionado. A API Clipboard geralmente não está disponível para códigos de teste. Nosso setup() substitui a propriedade navigator.clipboard por um stub.

default ao chamar as APIs diretamente: false
default ao chamar as APIs em uma instância de setup(): true