Skip to content

Commit 84e581a

Browse files
javachejavache
authored
Fix docs for onResponderGrant (#3785)
1 parent 14b87f8 commit 84e581a

File tree

18 files changed

+90
-54
lines changed

18 files changed

+90
-54
lines changed

‎docs/text.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -545,9 +545,11 @@ Called when a touch is released.
545545

546546
The View is now responding to touch events. This is the time to highlight and show the user what is happening.
547547

548-
| Type |
549-
| ------------------------------------------------- |
550-
| ({nativeEvent: [PressEvent](pressevent)}) => void |
548+
On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
549+
550+
| Type |
551+
| ------------------------------------------------------------ |
552+
| ({nativeEvent: [PressEvent](pressevent)}) => void \| boolean |
551553

552554
---
553555

‎docs/view.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -580,9 +580,11 @@ If a parent `View` wants to prevent a child `View` from becoming responder on a
580580

581581
The View is now responding for touch events. This is the time to highlight and show the user what is happening.
582582

583-
| Type |
584-
| ------------------------------------------------- |
585-
| ({nativeEvent: [PressEvent](pressevent)}) => void |
583+
On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
584+
585+
| Type |
586+
| ------------------------------------------------------------ |
587+
| ({nativeEvent: [PressEvent](pressevent)}) => void \| boolean |
586588

587589
---
588590

‎website/versioned_docs/version-0.65/text.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -469,9 +469,11 @@ This function is called on press.
469469

470470
The View is now responding to touch events. This is the time to highlight and show the user what is happening.
471471

472-
| Type |
473-
| --------------------------------------------------- |
474-
| ({ nativeEvent: [PressEvent](pressevent) }) => void |
472+
On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
473+
474+
| Type |
475+
| -------------------------------------------------------------- |
476+
| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
475477

476478
---
477479

‎website/versioned_docs/version-0.65/view.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -373,9 +373,11 @@ If a parent `View` wants to prevent a child `View` from becoming responder on a
373373

374374
The View is now responding for touch events. This is the time to highlight and show the user what is happening.
375375

376-
| Type | Required |
377-
| --------------------------------------------------- | -------- |
378-
| ({ nativeEvent: [PressEvent](pressevent) }) => void | No |
376+
On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
377+
378+
| Type | Required |
379+
| -------------------------------------------------------------- | -------- |
380+
| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean | No |
379381

380382
---
381383

‎website/versioned_docs/version-0.66/text.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -513,9 +513,11 @@ Called when a touch is released.
513513

514514
The View is now responding to touch events. This is the time to highlight and show the user what is happening.
515515

516-
| Type |
517-
| --------------------------------------------------- |
518-
| ({ nativeEvent: [PressEvent](pressevent) }) => void |
516+
On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
517+
518+
| Type |
519+
| -------------------------------------------------------------- |
520+
| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
519521

520522
---
521523

‎website/versioned_docs/version-0.66/view.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -441,9 +441,11 @@ If a parent `View` wants to prevent a child `View` from becoming responder on a
441441

442442
The View is now responding for touch events. This is the time to highlight and show the user what is happening.
443443

444-
| Type |
445-
| --------------------------------------------------- |
446-
| ({ nativeEvent: [PressEvent](pressevent) }) => void |
444+
On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
445+
446+
| Type |
447+
| -------------------------------------------------------------- |
448+
| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
447449

448450
---
449451

‎website/versioned_docs/version-0.67/text.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -513,9 +513,11 @@ Called when a touch is released.
513513

514514
The View is now responding to touch events. This is the time to highlight and show the user what is happening.
515515

516-
| Type |
517-
| --------------------------------------------------- |
518-
| ({ nativeEvent: [PressEvent](pressevent) }) => void |
516+
On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
517+
518+
| Type |
519+
| -------------------------------------------------------------- |
520+
| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
519521

520522
---
521523

‎website/versioned_docs/version-0.67/view.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -441,9 +441,11 @@ If a parent `View` wants to prevent a child `View` from becoming responder on a
441441

442442
The View is now responding for touch events. This is the time to highlight and show the user what is happening.
443443

444-
| Type |
445-
| --------------------------------------------------- |
446-
| ({ nativeEvent: [PressEvent](pressevent) }) => void |
444+
On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
445+
446+
| Type |
447+
| -------------------------------------------------------------- |
448+
| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
447449

448450
---
449451

‎website/versioned_docs/version-0.68/text.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -513,9 +513,11 @@ Called when a touch is released.
513513

514514
The View is now responding to touch events. This is the time to highlight and show the user what is happening.
515515

516-
| Type |
517-
| --------------------------------------------------- |
518-
| ({ nativeEvent: [PressEvent](pressevent) }) => void |
516+
On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
517+
518+
| Type |
519+
| -------------------------------------------------------------- |
520+
| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
519521

520522
---
521523

‎website/versioned_docs/version-0.68/view.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -441,9 +441,11 @@ If a parent `View` wants to prevent a child `View` from becoming responder on a
441441

442442
The View is now responding for touch events. This is the time to highlight and show the user what is happening.
443443

444-
| Type |
445-
| --------------------------------------------------- |
446-
| ({ nativeEvent: [PressEvent](pressevent) }) => void |
444+
On Android, return true from this callback to prevent any other native components from becoming responder until this responder terminates.
445+
446+
| Type |
447+
| -------------------------------------------------------------- |
448+
| ({ nativeEvent: [PressEvent](pressevent) }) => void \| boolean |
447449

448450
---
449451

0 commit comments

Comments
 (0)