Options
Cette page a été traduite par PageTurner AI (bêta). Non approuvée officiellement par le projet. Vous avez trouvé une erreur ? Signaler un problème →
Les options suivantes permettent d'ajuster le comportement des API user-event.
Elles peuvent être appliquées via setup().
advanceTimers
user-event ajoute un délai entre certaines entrées successives.
Lorsqu'on utilise des fake timers, il faut définir cette option avec la fonction d'avancement temporel de votre runner de tests. Par exemple :
const user = userEvent.setup({advanceTimers: jest.advanceTimersByTime})
Certaines suggestions conseillent delay: null pour éviter des timeouts avec les faux timers.
Cette approche n'est pas recommandée car elle peut causer des comportements imprévisibles.
Depuis la v14.1, nous suggérons plutôt d'utiliser l'option advanceTimers.
(delay: number) => Promise<void> | void
default: () => Promise.resolve()
applyAccept
Avec upload(), écarte automatiquement les fichiers non conformes à la propriété accept si celle-ci existe sur l'élément.
default: true
autoModify
Nous prévoyons d'appliquer automatiquement les touches modificatrices pour les caractères imprimables à l'avenir.
Par exemple : A impliquera {Shift>}a{/Shift} si le verrouillage majuscule est inactif.
Cette option permet d'anticiper et de désactiver ce changement.
La fonctionnalité ne constituera donc pas un changement cassant.
default: true
delay
Entre certaines entrées successives (comme la saisie d'une série de caractères), l'exécution du code est retardée via setTimeout d'au moins delay millisecondes.
Ceci décale les prochains changements au moins jusqu'à la prochaine macro-tâche et permet à d'autres codes (asynchrones) de s'exécuter entre les événements.
null empêche l'appel à setTimeout.
default: 0
document
Le document.
Par défaut : le document propriétaire de l'élément si une API est appelée directement avec un élément sans configuration préalable.
Sinon, utilisation du document global.
default: element.ownerDocument ?? globalThis.document
keyboardMap
Un tableau des touches composant le dispositif clavier.
Permet d'intégrer différents layouts ou localisations.
default:
Clavier QWERTY US-104 "standard".
pointerEventsCheck
L'API pointeur inclut une vérification si un élément a ou hérite de pointer-events: none.
Cette vérification est réputée coûteuse, particulièrement pour les nœuds profondément imbriqués.
Cette option détermine la fréquence des vérifications par les API liées aux pointeurs.
Option à drapeaux binaires. Combinaison de niveaux possible.
PointerEventsCheckLevel.Never:
Aucune vérificationPointerEventsCheckLevel.EachTarget:
Vérifie chaque cible d'événement une foisPointerEventsCheckLevel.EachApiCall:
Vérifie chaque cible d'événement une fois par appel APIPointerEventsCheckLevel.EachTrigger:
Vérifie les événements pointeurs à chaque interaction utilisateur déclenchant des événements.
Ex : une fois pour le relâchement d'un bouton souris, même si cela déclenchepointerup,mouseup,click, etc.
default: PointerEventsCheckLevel.EachApiCall
pointerMap
Un tableau des touches pointeur disponibles.
Permet d'intégrer différents périphériques pointeurs.
default:
Une souris simple et un écran tactile
skipAutoClose
type() relâche automatiquement toutes les touches encore enfoncées
à la fin de l'appel.
Cette option permet de désactiver cette fonctionnalité.
default: false
skipClick
type() implique un clic sur l'élément.
Cette option permet de désactiver cette fonctionnalité.
default: false
skipHover
click() implique de déplacer d'abord le curseur sur l'élément
cible.
Cette option permet de désactiver cette fonctionnalité.
default: false
writeToClipboard
Écrit les données sélectionnées dans
l'API Clipboard lorsqu'un
cut ou copy est déclenché. L'API Clipboard n'est généralement pas disponible pour
le code de test. Notre setup() remplace la propriété navigator.clipboard
par un stub.
default lors de l'appel direct des API directes: false
default lors de l'appel des API sur une instance de setup(): true