Skip to content

Copy in waitForElement docs #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 4, 2018
Merged

Copy in waitForElement docs #73

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e5c1866
Copy in waitForElement docs
alexkrolick May 4, 2018
8877bbb
Link out to source
alexkrolick May 4, 2018
6546373
Add waitForElement examples
alexkrolick May 4, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ facilitate testing implementation details). Read more about this in
* [`cleanup`](#cleanup)
* [`Simulate`](#simulate)
* [`wait`](#wait)
* [`waitForElement`](#waitforelement)
* [`fireEvent(node: HTMLElement, event: Event)`](#fireeventnode-htmlelement-event-event)
* [`TextMatch`](#textmatch)
* [`query` APIs](#query-apis)
Expand Down Expand Up @@ -373,6 +374,21 @@ The default `interval` is `50ms`. However it will run your callback immediately
on the next tick of the event loop (in a `setTimeout`) before starting the
intervals.

### `waitForElement`

See [dom-testing-library#waitForElement](https://github.com/kentcdodds/dom-testing-library#waitforelement)

```typescript
function waitForElement<T>(
callback?: () => T | null | undefined,
options?: {
container?: HTMLElement
timeout?: number
mutationObserverOptions?: MutationObserverInit
},
): Promise<T>
```

### `fireEvent(node: HTMLElement, event: Event)`

Fire DOM events.
Expand Down