Identify keyboardDismissMode platform-specific options

Summary:
Similar to `TextInput`'s `returnKeyType`, comments allow to see at a glance which options are cross-platform and which are not.

<!--
Thank you for sending the PR!

If you changed any code, please provide us with clear instructions on how you verified your changes work. In other words, a test plan is *required*. Bonus points for screenshots and videos!

Please read the Contribution Guidelines at https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md to learn more about contributing to React Native.

Happy contributing!
-->
Closes https://github.com/facebook/react-native/pull/14780

Differential Revision: D5480895

Pulled By: hramos

fbshipit-source-id: c38337def920678d29c8322e52b54f57e80cb95b
This commit is contained in:
Taylor Kline 2017-07-24 11:13:14 -07:00 committed by Facebook Github Bot
parent 879d2e3cc5
commit 64899c08f3

View File

@ -201,16 +201,21 @@ const ScrollView = createReactClass({
/** /**
* Determines whether the keyboard gets dismissed in response to a drag. * Determines whether the keyboard gets dismissed in response to a drag.
* *
* *Cross platform*
*
* - `'none'` (the default), drags do not dismiss the keyboard. * - `'none'` (the default), drags do not dismiss the keyboard.
* - `'on-drag'`, the keyboard is dismissed when a drag begins. * - `'on-drag'`, the keyboard is dismissed when a drag begins.
*
* *iOS Only*
*
* - `'interactive'`, the keyboard is dismissed interactively with the drag and moves in * - `'interactive'`, the keyboard is dismissed interactively with the drag and moves in
* synchrony with the touch; dragging upwards cancels the dismissal. * synchrony with the touch; dragging upwards cancels the dismissal.
* On android this is not supported and it will have the same behavior as 'none'. * On android this is not supported and it will have the same behavior as 'none'.
*/ */
keyboardDismissMode: PropTypes.oneOf([ keyboardDismissMode: PropTypes.oneOf([
'none', // default 'none', // default
'interactive', 'on-drag', // Cross-platform
'on-drag', 'interactive', // iOS-only
]), ]),
/** /**
* Determines when the keyboard should stay visible after a tap. * Determines when the keyboard should stay visible after a tap.