Skip to content

Commit a7f3503

Browse files
authored
Merge pull request testing-library#6 from Gpx/readme
docs: ✏️ add README
2 parents b727fc0 + a759e5e commit a7f3503

File tree

3 files changed

+34
-0
lines changed

3 files changed

+34
-0
lines changed

.prettierrc.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
proseWrap: "always"
3+
};

README.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<div align="center">
2+
<h1>user-event</h1>
3+
4+
<a href="https://www.emojione.com/emoji/1f415">
5+
<img height="80" width="80" alt="dog" src="https://raw.githubusercontent.com/gpx/user-event/master/other/dog.png" />
6+
</a>
7+
8+
<p>Simulate user events for <a href="https://github.com/kentcdodds/react-testing-library">react-testing-library</a></p>
9+
</div>
10+
11+
<hr />
12+
13+
[![Build Status](https://travis-ci.org/Gpx/user-event.svg?branch=master)](https://travis-ci.org/Gpx/user-event)
14+
[![Maintainability](https://api.codeclimate.com/v1/badges/75f1ff4397e994c6004e/maintainability)](https://codeclimate.com/github/Gpx/user-event/maintainability)
15+
[![Test Coverage](https://api.codeclimate.com/v1/badges/75f1ff4397e994c6004e/test_coverage)](https://codeclimate.com/github/Gpx/user-event/test_coverage)
16+
17+
## The problem
18+
19+
From
20+
[kentcdodds/dom-testing-library#107](https://github.com/kentcdodds/dom-testing-library/issues/107):
21+
22+
> [...] it is becoming apparent the need to express user actions on a web page
23+
> using a higher-level abstraction than `fireEvent`
24+
25+
## The solution
26+
27+
`user-event` tries to simulate the real events that would happen in the browser
28+
as the user interacts with it. For example `userEvent.click(checkbox)` would
29+
change the state of the checkbox.
30+
31+
The library is still a work in progress and any help is appreciated.

other/dog.png

3.05 KB
Loading

0 commit comments

Comments
 (0)