Skip to content

Commit f538029

Browse files
docs: note required RNTL version for user-event in user-event.md (#1494)
* docs: note required RNTL version for user-event in user-event.md * chore: tweak wording * chore: tweak * chore: tweaks --------- Co-authored-by: Maciej Jastrzebski <[email protected]>
1 parent 7a12847 commit f538029

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

website/docs/UserEvent.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ User Event API is in beta stage.
1212
This means that we plan to keep the public API signatures to remain stable, but we might introduce breaking behavioural changes, e.g. changing the ordering or timing of emitted events, without a major version update. Hopefully, well written code should not rely on such specific details.
1313
:::
1414

15+
:::note
16+
User Event interactions require RNTL v12.2.0 or later.
17+
:::
18+
19+
1520
## Comparison with Fire Event API
1621

1722
Fire Event is our original event simulation API. It offers ability to invoke **any event handler** declared on **either host or composite elements**. If the element does not have `onEventName` event handler for passed `eventName` event, or the element is disabled, Fire Event will traverse up the component tree, looking for event handler on both host and composite elements along the way. By default it will **not pass any event data**, but the user might provide it in the last argument.
@@ -179,10 +184,14 @@ The `textInput` event is sent only for mutliline text inputs.
179184
- `endEditing`
180185
- `blur`
181186
182-
## `scroll()`
187+
## `scrollTo()`
188+
189+
:::note
190+
`scrollTo` interaction has been introduced in RNTL v12.4.0.
191+
:::
183192
184193
```ts
185-
type(
194+
scrollTo(
186195
element: ReactTestInstance,
187196
options: {
188197
y: number,

0 commit comments

Comments
 (0)