diff --git a/Libraries/Components/Keyboard/KeyboardAvoidingView.js b/Libraries/Components/Keyboard/KeyboardAvoidingView.js index 5b90702fefd363..1f6c4848496d5d 100644 --- a/Libraries/Components/Keyboard/KeyboardAvoidingView.js +++ b/Libraries/Components/Keyboard/KeyboardAvoidingView.js @@ -43,8 +43,8 @@ type KeyboardChangeEvent = { const viewRef = 'VIEW'; /** - * It is a component to solve the common problem of views that need to move out of the way of the virtual keyboard. - * It can automatically adjust either its position or bottom padding based on the position of the keyboard. + * This is a component to solve the common problem of views that need to move out of the way of the virtual keyboard. + * It can automatically adjust either its height, position or bottom padding based on the position of the keyboard. */ const KeyboardAvoidingView = createReactClass({ displayName: 'KeyboardAvoidingView', @@ -52,6 +52,10 @@ const KeyboardAvoidingView = createReactClass({ propTypes: { ...ViewPropTypes, + /** + * Specify how the `KeyboardAvoidingView` will react to the presence of + * the keyboard. It can adjust the height, position or bottom padding of the view + */ behavior: PropTypes.oneOf(['height', 'position', 'padding']), /** @@ -61,7 +65,7 @@ const KeyboardAvoidingView = createReactClass({ /** * This is the distance between the top of the user screen and the react native view, - * may be non-zero in some use cases. + * may be non-zero in some use cases. The default value is 0. */ keyboardVerticalOffset: PropTypes.number.isRequired, }, @@ -81,7 +85,7 @@ const KeyboardAvoidingView = createReactClass({ subscriptions: ([]: Array), frame: (null: ?ViewLayout), - relativeKeyboardHeight(keyboardFrame: ScreenRect): number { + _relativeKeyboardHeight(keyboardFrame: ScreenRect): number { const frame = this.frame; if (!frame || !keyboardFrame) { return 0; @@ -94,14 +98,14 @@ const KeyboardAvoidingView = createReactClass({ return Math.max(frame.y + frame.height - keyboardY, 0); }, - onKeyboardChange(event: ?KeyboardChangeEvent) { + _onKeyboardChange(event: ?KeyboardChangeEvent) { if (!event) { this.setState({bottom: 0}); return; } const {duration, easing, endCoordinates} = event; - const height = this.relativeKeyboardHeight(endCoordinates); + const height = this._relativeKeyboardHeight(endCoordinates); if (duration && easing) { LayoutAnimation.configureNext({ @@ -115,7 +119,7 @@ const KeyboardAvoidingView = createReactClass({ this.setState({bottom: height}); }, - onLayout(event: ViewLayoutEvent) { + _onLayout(event: ViewLayoutEvent) { this.frame = event.nativeEvent.layout; }, @@ -132,12 +136,12 @@ const KeyboardAvoidingView = createReactClass({ componentWillMount() { if (Platform.OS === 'ios') { this.subscriptions = [ - Keyboard.addListener('keyboardWillChangeFrame', this.onKeyboardChange), + Keyboard.addListener('keyboardWillChangeFrame', this._onKeyboardChange), ]; } else { this.subscriptions = [ - Keyboard.addListener('keyboardDidHide', this.onKeyboardChange), - Keyboard.addListener('keyboardDidShow', this.onKeyboardChange), + Keyboard.addListener('keyboardDidHide', this._onKeyboardChange), + Keyboard.addListener('keyboardDidShow', this._onKeyboardChange), ]; } }, @@ -161,7 +165,7 @@ const KeyboardAvoidingView = createReactClass({ heightStyle = {height: this.frame.height - this.state.bottom, flex: 0}; } return ( - + {children} ); @@ -171,7 +175,7 @@ const KeyboardAvoidingView = createReactClass({ const { contentContainerStyle } = this.props; return ( - + {children} @@ -181,14 +185,14 @@ const KeyboardAvoidingView = createReactClass({ case 'padding': const paddingStyle = {paddingBottom: this.state.bottom}; return ( - + {children} ); default: return ( - + {children} );