README.md 43.9 KB

user-event

dog

Fire events the same way the user does


[**Read The Docs**](https://testing-library.com/docs/ecosystem-user-event) | [Edit the docs](https://github.com/testing-library/testing-library-docs)

Build Status Code Coverage version downloads MIT License All Contributors PRs Welcome Code of Conduct Discord

Watch on GitHub Star on GitHub Tweet

Table of Contents

The problem

From testing-library/dom-testing-library#107:

[...] it is becoming apparent the need to express user actions on a web page using a higher-level abstraction than fireEvent

The solution

user-event tries to simulate the real events that would happen in the browser as the user interacts with it. For example userEvent.click(checkbox) would change the state of the checkbox.

The more your tests resemble the way your software is used, the more confidence they can give you.

Installation

With NPM:

npm install --save-dev @testing-library/user-event @testing-library/dom

With Yarn:

yarn add --dev @testing-library/user-event @testing-library/dom

Docs

Read The Docs | Edit the docs

Known limitations

  • No <input type="color" /> support. #423

Issues

Looking to contribute? Look for the Good First Issue label.

🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

See Bugs

💡 Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.

See Feature Requests

❓ Questions

For questions related to using the library, please visit a support community instead of filing an issue on GitHub.

Contributors

Thanks goes to these people (emoji key):


Giorgio Polvara

🐛 💻 📖 🤔 🚇 👀 ⚠️

Weyert de Boer

💻 ⚠️

Tim Whitbeck

🐛 💻

Michaël De Boey

📖

Michael Lasky

💻 📖 🤔

Ahmad Esmaeilzadeh

📖

Caleb Eby

💻 🐛 👀

Adrià Fontcuberta

🐛 ⚠️ 💻

Sky Wickenden

🐛 💻

Bodnar Bogdan

🐛 💻

Zach Perrault

📖

Ryan Stelly

📖

Ben Monro

💻

Christopher Martin

💻

Yuancheng Wu

👀

MJ

📖

Jeff McRiffey

💻 ⚠️

Jaga Santagostino

💻 ⚠️

jordyvandomselaar

💻 ⚠️

Ilya Lyamkin

💻 ⚠️

Kenneth Luján Rosas

💻 ⚠️

Joe Morgan

💻

David Hirtle

💻

whiteUnicorn

💻

Matej Šnuderl

👀

Rodrigo Pombo

💻

Jake Verbaten

💻

Spencer Miskoviak

📖

Vadim Shvetsov

🤔 💻 ⚠️

Greg Shtilman

💻 ⚠️ 🐛

Ricardo Busquet

🐛 💻 ⚠️

Doug Bacelar

💻 ⚠️

Kayleigh Ridd

🐛 💻 ⚠️

Malcolm Kee

💻 📖 ⚠️

kelvinlzhang

🐛

Krzysztof

🐛

Pontus Lundin

💻 ⚠️

Aleks Hudochenkov

🐛

Vijay Kumar Otti

🐛

Tom Picton

🐛 💻 ⚠️

Hung Viet Nguyen

🐛

Nick McCurdy

📆 💬 💻 ⚠️ 📖

Tim Deschryver

⚠️

Ben Dyer

💻 ⚠️

Dan Kirkham

💻

Johannesklint

📖

Juan Carlos Medina

💻 ⚠️

Dade Cook

💻 ⚠️

Leandro Lourenci

💻 ⚠️

Marco Moretti

💻 ⚠️

ybentz

💻 ⚠️

Nasdan

🐛

Javier Martínez

📖

Jörg Bayreuther

💻 ⚠️ 📖

Lucas Bernalte

📖

Maxwell Newlands

💻 ⚠️

ph-fritsche

💻 ⚠️

Rey Wright

🐛 💻

Niklas Mischkulnig

💻 ⚠️

Pascal Duez

💻

Malachi Willey

💻 ⚠️

Clark Winters

📖

lazytype

💻 ⚠️

Luís Takahashi

💻 ⚠️

Jesu Castillo

💻 ⚠️

Sarah Dayan

📖

Mirone

🐛

Amanda Pouget

📖

Sonic12040

💻 ⚠️ 📖

Gonzalo D'Elia

💻 ⚠️ 📖

Vasilii Kovalev

💻 📖

Dale Seo

📖

Alex Boyce

💻

Ben Styles

💻 ⚠️

Laura Beatris

💻 ⚠️

Boris Serdiuk

🐛

bozdoz

📖 🐛 ⚠️

Jan Kattelans

💻

schoeneu

🐛

Martin Kapal

🐛

Stavros

🐛

geoffroymounier

🐛

Fergus McDonald

💻

Robin Ambachtsheer

🐛

Mohit

🐛 💻 ⚠️

Daniel Contreras

🐛

Eugene Ghanizadeh

💻

Victor Repkow

💻

Jonathan Felchlin

💻

sydneyjodon-wk

🐛 💻

Charles Magic Woo

🐛

mkurcius

💻

Tim Fischbach

🐛

Brian Donovan

💻

Eric Wang

💻

Jesper Orb

💻

Johannes Fischer

💻

Andrew D.

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

LICENSE

MIT