Fix docs for onResponderGrant (#3785)

facebook · Jul 7, 2023 · 84e581a · 84e581a
1 parent 14b87f8
commit 84e581a
Show file tree

Hide file tree

Showing 18 changed files with 90 additions and 54 deletions.
diff --git a/docs/text.md b/docs/text.md
@@ -545,9 +545,11 @@ Called when a touch is released.
 
 The View is now responding to touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                              |
-| ------------------------------------------------- |
-| ({nativeEvent: [PressEvent](pressevent)}) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                         |
+| ------------------------------------------------------------ |
+| ({nativeEvent: [PressEvent](pressevent)}) => void \| boolean |
 
 ---
 

diff --git a/docs/view.md b/docs/view.md
@@ -580,9 +580,11 @@ If a parent `View` wants to prevent a child `View` from becoming responder on a
 
 The View is now responding for touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                              |
-| ------------------------------------------------- |
-| ({nativeEvent: [PressEvent](pressevent)}) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                         |
+| ------------------------------------------------------------ |
+| ({nativeEvent: [PressEvent](pressevent)}) => void \| boolean |
 
 ---
 

diff --git a/website/versioned_docs/version-0.65/text.md b/website/versioned_docs/version-0.65/text.md
@@ -469,9 +469,11 @@ This function is called on press.
 
 The View is now responding to touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                                |
-| --------------------------------------------------- |
-| ({ nativeEvent: [PressEvent](pressevent) }) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                           |
+| -------------------------------------------------------------- |
+| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
 
 ---
 

diff --git a/website/versioned_docs/version-0.65/view.md b/website/versioned_docs/version-0.65/view.md
@@ -373,9 +373,11 @@ If a parent `View` wants to prevent a child `View` from becoming responder on a
 
 The View is now responding for touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                                | Required |
-| --------------------------------------------------- | -------- |
-| ({ nativeEvent: [PressEvent](pressevent) }) => void | No       |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                           | Required |
+| -------------------------------------------------------------- | -------- |
+| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean | No       |
 
 ---
 

diff --git a/website/versioned_docs/version-0.66/text.md b/website/versioned_docs/version-0.66/text.md
@@ -513,9 +513,11 @@ Called when a touch is released.
 
 The View is now responding to touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                                |
-| --------------------------------------------------- |
-| ({ nativeEvent: [PressEvent](pressevent) }) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                           |
+| -------------------------------------------------------------- |
+| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
 
 ---
 

diff --git a/website/versioned_docs/version-0.66/view.md b/website/versioned_docs/version-0.66/view.md
@@ -441,9 +441,11 @@ If a parent `View` wants to prevent a child `View` from becoming responder on a
 
 The View is now responding for touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                                |
-| --------------------------------------------------- |
-| ({ nativeEvent: [PressEvent](pressevent) }) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                           |
+| -------------------------------------------------------------- |
+| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
 
 ---
 

diff --git a/website/versioned_docs/version-0.67/text.md b/website/versioned_docs/version-0.67/text.md
@@ -513,9 +513,11 @@ Called when a touch is released.
 
 The View is now responding to touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                                |
-| --------------------------------------------------- |
-| ({ nativeEvent: [PressEvent](pressevent) }) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                           |
+| -------------------------------------------------------------- |
+| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
 
 ---
 

diff --git a/website/versioned_docs/version-0.67/view.md b/website/versioned_docs/version-0.67/view.md
@@ -441,9 +441,11 @@ If a parent `View` wants to prevent a child `View` from becoming responder on a
 
 The View is now responding for touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                                |
-| --------------------------------------------------- |
-| ({ nativeEvent: [PressEvent](pressevent) }) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                           |
+| -------------------------------------------------------------- |
+| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
 
 ---
 

diff --git a/website/versioned_docs/version-0.68/text.md b/website/versioned_docs/version-0.68/text.md
@@ -513,9 +513,11 @@ Called when a touch is released.
 
 The View is now responding to touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                                |
-| --------------------------------------------------- |
-| ({ nativeEvent: [PressEvent](pressevent) }) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                           |
+| -------------------------------------------------------------- |
+| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
 
 ---
 

diff --git a/website/versioned_docs/version-0.68/view.md b/website/versioned_docs/version-0.68/view.md
@@ -441,9 +441,11 @@ If a parent `View` wants to prevent a child `View` from becoming responder on a
 
 The View is now responding for touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                                |
-| --------------------------------------------------- |
-| ({ nativeEvent: [PressEvent](pressevent) }) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                           |
+| -------------------------------------------------------------- |
+| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
 
 ---
 

diff --git a/website/versioned_docs/version-0.69/text.md b/website/versioned_docs/version-0.69/text.md
@@ -525,9 +525,11 @@ Called when a touch is released.
 
 The View is now responding to touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                                |
-| --------------------------------------------------- |
-| ({ nativeEvent: [PressEvent](pressevent) }) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                           |
+| -------------------------------------------------------------- |
+| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
 
 ---
 

diff --git a/website/versioned_docs/version-0.69/view.md b/website/versioned_docs/version-0.69/view.md
@@ -453,9 +453,11 @@ If a parent `View` wants to prevent a child `View` from becoming responder on a
 
 The View is now responding for touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                                |
-| --------------------------------------------------- |
-| ({ nativeEvent: [PressEvent](pressevent) }) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                           |
+| -------------------------------------------------------------- |
+| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
 
 ---
 

diff --git a/website/versioned_docs/version-0.70/text.md b/website/versioned_docs/version-0.70/text.md
@@ -525,9 +525,11 @@ Called when a touch is released.
 
 The View is now responding to touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                                |
-| --------------------------------------------------- |
-| ({ nativeEvent: [PressEvent](pressevent) }) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                           |
+| -------------------------------------------------------------- |
+| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
 
 ---
 

diff --git a/website/versioned_docs/version-0.70/view.md b/website/versioned_docs/version-0.70/view.md
@@ -453,9 +453,11 @@ If a parent `View` wants to prevent a child `View` from becoming responder on a
 
 The View is now responding for touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                                |
-| --------------------------------------------------- |
-| ({ nativeEvent: [PressEvent](pressevent) }) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                           |
+| -------------------------------------------------------------- |
+| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
 
 ---
 

diff --git a/website/versioned_docs/version-0.71/text.md b/website/versioned_docs/version-0.71/text.md
@@ -587,9 +587,11 @@ Called when a touch is released.
 
 The View is now responding to touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                              |
-| ------------------------------------------------- |
-| ({nativeEvent: [PressEvent](pressevent)}) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                         |
+| ------------------------------------------------------------ |
+| ({nativeEvent: [PressEvent](pressevent)}) => void \| boolean |
 
 ---
 

diff --git a/website/versioned_docs/version-0.71/view.md b/website/versioned_docs/version-0.71/view.md
@@ -615,9 +615,11 @@ If a parent `View` wants to prevent a child `View` from becoming responder on a
 
 The View is now responding for touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                              |
-| ------------------------------------------------- |
-| ({nativeEvent: [PressEvent](pressevent)}) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                         |
+| ------------------------------------------------------------ |
+| ({nativeEvent: [PressEvent](pressevent)}) => void \| boolean |
 
 ---
 

diff --git a/website/versioned_docs/version-0.72/text.md b/website/versioned_docs/version-0.72/text.md
@@ -545,9 +545,11 @@ Called when a touch is released.
 
 The View is now responding to touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                              |
-| ------------------------------------------------- |
-| ({nativeEvent: [PressEvent](pressevent)}) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                         |
+| ------------------------------------------------------------ |
+| ({nativeEvent: [PressEvent](pressevent)}) => void \| boolean |
 
 ---
 

diff --git a/website/versioned_docs/version-0.72/view.md b/website/versioned_docs/version-0.72/view.md
@@ -580,9 +580,11 @@ If a parent `View` wants to prevent a child `View` from becoming responder on a
 
 The View is now responding for touch events. This is the time to highlight and show the user what is happening.
 
-| Type                                              |
-| ------------------------------------------------- |
-| ({nativeEvent: [PressEvent](pressevent)}) => void |
+On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
+
+| Type                                                         |
+| ------------------------------------------------------------ |
+| ({nativeEvent: [PressEvent](pressevent)}) => void \| boolean |
 
 ---