Skip to content

Commit 7145ac6

Browse files
committed
Updated docs about onArrowPress usage
1 parent dcdaded commit 7145ac6

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,8 @@ Receives `extraProps` (see below) as argument.
309309
##### `onArrowPress` (function)
310310
Callback that is called when component is focused and any Arrow key is pressed.
311311
Receives `direction` (`left`, `right`, `up`, `down`), `extraProps` (see below) and `KeyPressDetails` as arguments.
312+
This callback HAS to return `true` if you want to proceed with the default directional navigation behavior, or `false`
313+
if you want to block the navigation in the specified direction.
312314

313315
##### `onFocus` (function)
314316
Callback that is called when component gets focus.

0 commit comments

Comments
 (0)