Skip to content

Commit 3e2060d

Browse files
docs: add note user.scrollTo in favour of fireEvent.scroll and edit broken links (#1551)
* add note user.scrollTo in favour of fireEvent.scroll and edit broken links * Update website/docs/API.md --------- Co-authored-by: Maciej Jastrzebski <mdjastrzebski@gmail.com>
1 parent b222792 commit 3e2060d

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

website/docs/API.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -396,11 +396,17 @@ render(
396396
fireEvent.scroll(screen.getByText('scroll-view'), eventData);
397397
```
398398

399+
:::note
400+
401+
Prefer using [`user.scrollTo`](./UserEvent.md#scrollto) over `fireEvent.scroll` for `ScrollView`, `FlatList`, and `SectionList` components. User Event provides a more realistic event simulation based on React Native runtime behavior.
402+
403+
:::
404+
399405
## Helper functions
400406

401407
### `waitFor`
402408

403-
- [`Example code`](https://github.com/callstack/react-native-testing-library/blob/main/src/__tests__/waitFor.test.tsx)
409+
- [`Example code`](https://github.com/callstack/react-native-testing-library/blob/main/src/__tests__/wait-for.test.tsx)
404410

405411
Defined as:
406412

@@ -414,7 +420,7 @@ function waitFor<T>(
414420
Waits for a period of time for the `expectation` callback to pass. `waitFor` may run the callback a number of times until timeout is reached, as specified by the `timeout` and `interval` options. The callback must throw an error when the expectation is not met. Returning any value, including a falsy one, will be treated as meeting the expectation, and the callback result will be returned to the caller of `waitFor` function.
415421

416422
```tsx
417-
await waitFor(() => expect(mockFunction).toHaveBeenCalledWith()))
423+
await waitFor(() => expect(mockFunction).toHaveBeenCalledWith())
418424
```
419425

420426
`waitFor` function will be executing `expectation` callback every `interval` (default: every 50 ms) until `timeout` (default: 1000 ms) is reached. The repeated execution of callback is stopped as soon as it does not throw an error, in such case the value returned by the callback is returned to `waitFor` caller. Otherwise, when it reaches the timeout, the final error thrown by `expectation` will be re-thrown by `waitFor` to the calling code.
@@ -504,7 +510,7 @@ If you receive warnings related to `act()` function consult our [Undestanding Ac
504510

505511
### `waitForElementToBeRemoved`
506512

507-
- [`Example code`](https://github.com/callstack/react-native-testing-library/blob/main/src/__tests__/waitForElementToBeRemoved.test.tsx)
513+
- [`Example code`]https://github.com/callstack/react-native-testing-library/blob/main/src/__tests__/wait-for-element-to-be-removed.test.tsx)
508514

509515
Defined as:
510516

0 commit comments

Comments
 (0)