From 648e121509fa5722208ab60a8618ff45b2b15f95 Mon Sep 17 00:00:00 2001
From: Andrew <35735666+meatnordrink@users.noreply.github.com>
Date: Fri, 8 Sep 2023 07:44:49 -0400
Subject: [PATCH 1/4] docs: note required RNTL version for user-event in
user-event.md
---
website/docs/UserEvent.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/website/docs/UserEvent.md b/website/docs/UserEvent.md
index 26695123e..8bb27cf09 100644
--- a/website/docs/UserEvent.md
+++ b/website/docs/UserEvent.md
@@ -6,6 +6,10 @@ import TOCInline from '@theme/TOCInline';
+:::note
+Requires `@testing-library/react-native` version 12.2.0.
+:::
+
:::caution
User Event API is in beta stage.
From 3e9071d3ffbbb249541c06454ac65f51af389ac2 Mon Sep 17 00:00:00 2001
From: Maciej Jastrzebski
Date: Mon, 18 Sep 2023 22:08:04 +0200
Subject: [PATCH 2/4] chore: tweak wording
---
website/docs/UserEvent.md | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/website/docs/UserEvent.md b/website/docs/UserEvent.md
index 8bb27cf09..84b1d901e 100644
--- a/website/docs/UserEvent.md
+++ b/website/docs/UserEvent.md
@@ -6,16 +6,17 @@ import TOCInline from '@theme/TOCInline';
-:::note
-Requires `@testing-library/react-native` version 12.2.0.
-:::
-
:::caution
User Event API is in beta stage.
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.
:::
+:::note
+User Event interactions require v12.2.0.
+:::
+
+
## Comparison with Fire Event API
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.
From e9bd1dc0946e1d692a3366b78b0af82958d841bb Mon Sep 17 00:00:00 2001
From: Maciej Jastrzebski
Date: Mon, 18 Sep 2023 22:09:15 +0200
Subject: [PATCH 3/4] chore: tweak
---
website/docs/UserEvent.md | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/website/docs/UserEvent.md b/website/docs/UserEvent.md
index 84b1d901e..4a6bda7b5 100644
--- a/website/docs/UserEvent.md
+++ b/website/docs/UserEvent.md
@@ -13,7 +13,7 @@ This means that we plan to keep the public API signatures to remain stable, but
:::
:::note
-User Event interactions require v12.2.0.
+User Event interactions require RNTL v12.2.0.
:::
@@ -184,10 +184,14 @@ The `textInput` event is sent only for mutliline text inputs.
- `endEditing`
- `blur`
-## `scroll()`
+## `scrollTo()`
+
+:::note
+`scrollTo` interaction requires RNTL v12.4.0.
+:::
```ts
-type(
+scrollTo(
element: ReactTestInstance,
options: {
y: number,
From b7256ceafca939b9fac79aaa6444065e5dad69f2 Mon Sep 17 00:00:00 2001
From: Maciej Jastrzebski
Date: Mon, 18 Sep 2023 22:10:44 +0200
Subject: [PATCH 4/4] chore: tweaks
---
website/docs/UserEvent.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/website/docs/UserEvent.md b/website/docs/UserEvent.md
index 4a6bda7b5..005021d0a 100644
--- a/website/docs/UserEvent.md
+++ b/website/docs/UserEvent.md
@@ -13,7 +13,7 @@ This means that we plan to keep the public API signatures to remain stable, but
:::
:::note
-User Event interactions require RNTL v12.2.0.
+User Event interactions require RNTL v12.2.0 or later.
:::
@@ -187,7 +187,7 @@ The `textInput` event is sent only for mutliline text inputs.
## `scrollTo()`
:::note
-`scrollTo` interaction requires RNTL v12.4.0.
+`scrollTo` interaction has been introduced in RNTL v12.4.0.
:::
```ts