Merge pull request #14 from APSL/iss_12

closes #12 #13

Author: alvaromb

.flowconfig

@@ -0,0 +1,96 @@
+[ignore]
+
+# We fork some components by platform.
+.*/*.web.js
+.*/*.android.js
+
+# Some modules have their own node_modules with overlap
+.*/node_modules/node-haste/.*
+
+# Ugh
+.*/node_modules/babel.*
+.*/node_modules/babylon.*
+.*/node_modules/invariant.*
+
+# Ignore react and fbjs where there are overlaps, but don't ignore
+# anything that react-native relies on
+.*/node_modules/fbjs/lib/Map.js
+.*/node_modules/fbjs/lib/fetch.js
+.*/node_modules/fbjs/lib/ExecutionEnvironment.js
+.*/node_modules/fbjs/lib/ErrorUtils.js
+
+# Flow has a built-in definition for the 'react' module which we prefer to use
+# over the currently-untyped source
+.*/node_modules/react/react.js
+.*/node_modules/react/lib/React.js
+.*/node_modules/react/lib/ReactDOM.js
+
+.*/__mocks__/.*
+.*/__tests__/.*
+
+.*/commoner/test/source/widget/share.js
+
+# Ignore commoner tests
+.*/node_modules/commoner/test/.*
+
+# See https://github.com/facebook/flow/issues/442
+.*/react-tools/node_modules/commoner/lib/reader.js
+
+# Ignore jest
+.*/node_modules/jest-cli/.*
+
+# Ignore Website
+.*/website/.*
+
+# Ignore generators
+.*/local-cli/generator.*
+
+# Ignore BUCK generated folders
+.*\.buckd/
+
+.*/node_modules/is-my-json-valid/test/.*\.json
+.*/node_modules/iconv-lite/encodings/tables/.*\.json
+.*/node_modules/y18n/test/.*\.json
+.*/node_modules/spdx-license-ids/spdx-license-ids.json
+.*/node_modules/spdx-exceptions/index.json
+.*/node_modules/resolve/test/subdirs/node_modules/a/b/c/x.json
+.*/node_modules/resolve/lib/core.json
+.*/node_modules/jsonparse/samplejson/.*\.json
+.*/node_modules/json5/test/.*\.json
+.*/node_modules/ua-parser-js/test/.*\.json
+.*/node_modules/builtin-modules/builtin-modules.json
+.*/node_modules/binary-extensions/binary-extensions.json
+.*/node_modules/url-regex/tlds.json
+.*/node_modules/joi/.*\.json
+.*/node_modules/isemail/.*\.json
+.*/node_modules/tr46/.*\.json
+
+
+[include]
+
+[libs]
+node_modules/react-native/Libraries/react-native/react-native-interface.js
+node_modules/react-native/flow
+flow/
+
+[options]
+module.system=haste
+
+esproposal.class_static_fields=enable
+esproposal.class_instance_fields=enable
+
+munge_underscores=true
+
+module.name_mapper='^image![a-zA-Z0-9$_-]+$' -> 'GlobalImageStub'
+module.name_mapper='^[./a-zA-Z0-9$_-]+\.\(bmp\|gif\|jpg\|jpeg\|png\|psd\|svg\|webp\|m4v\|mov\|mp4\|mpeg\|mpg\|webm\|aac\|aiff\|caf\|m4a\|mp3\|wav\|html\)$' -> 'RelativeImageStub'
+
+suppress_type=$FlowIssue
+suppress_type=$FlowFixMe
+suppress_type=$FixMe
+
+suppress_comment=\\(.\\|\n\\)*\\$FlowFixMe\\($\\|[^(]\\|(\\(>=0\\.\\(2[0-3]\\|1[0-9]\\|[0-9]\\).[0-9]\\)? *\\(site=[a-z,_]*react_native[a-z,_]*\\)?)\\)
+suppress_comment=\\(.\\|\n\\)*\\$FlowIssue\\((\\(>=0\\.\\(2[0-3]\\|1[0-9]\\|[0-9]\\).[0-9]\\)? *\\(site=[a-z,_]*react_native[a-z,_]*\\)?)\\)?:? #[0-9]+
+suppress_comment=\\(.\\|\n\\)*\\$FlowFixedInNextDeploy
+
+[version]
+0.23.0

README.md

@@ -50,6 +50,20 @@ _scrollToInput (event, reactNode) {
 </KeyboardAwareScrollView>
 ```
 
+## Register to keyboard events
+You can register to `ScrollViewResponder` events `onKeyboardWillShow` and `onKeyboardWillHide`:
+
+```js
+<KeyboardAwareScrollView
+  onKeyboardWillShow={(frames: Object) => {
+    console.log('Keyboard event', frames)
+  }}>
+  <View>
+    <TextInput />
+  </View>
+</KeyboardAwareScrollView>
+```
+
 ## License
 
 MIT.

index.js

@@ -1,3 +1,5 @@
+/* @flow */
+
 import KeyboardAwareMixin from './lib/KeyboardAwareMixin'
 import KeyboardAwareScrollView from './lib/KeyboardAwareScrollView'
 import KeyboardAwareListView from './lib/KeyboardAwareListView'

lib/KeyboardAwareListView.js

@@ -1,4 +1,7 @@
-import React, { ListView } from 'react-native'
+/* @flow */
+
+import React, { PropTypes } from 'react'
+import { ListView } from 'react-native'
 import KeyboardAwareMixin from './KeyboardAwareMixin'
 
 const KeyboardAwareListView = React.createClass({

lib/KeyboardAwareMixin.js

@@ -1,3 +1,5 @@
+/* @flow */
+
 import { DeviceEventEmitter } from 'react-native'
 import TimerMixin from 'react-timer-mixin'
 
@@ -6,12 +8,12 @@ const _KAM_DEFAULT_TAB_BAR_HEIGHT = 49
 const KeyboardAwareMixin = {
   mixins: [TimerMixin],
 
-  setViewIsInsideTabBar: function (viewIsInsideTabBar) {
+  setViewIsInsideTabBar: function (viewIsInsideTabBar: bool) {
     this.viewIsInsideTabBar = viewIsInsideTabBar
     this.setState({keyboardSpace: _KAM_DEFAULT_TAB_BAR_HEIGHT})
   },
 
-  getInitialState: function (props) {
+  getInitialState: function (props: Object) {
     this.viewIsInsideTabBar = false
     this.keyboardWillShowEvent = undefined
     this.keyboardWillHideEvent = undefined
@@ -21,7 +23,7 @@ const KeyboardAwareMixin = {
   },
 
   // Keyboard actions
-  updateKeyboardSpace: function (frames) {
+  updateKeyboardSpace: function (frames: Object) {
     const keyboardSpace = (this.props.viewIsInsideTabBar) ? frames.endCoordinates.height - _KAM_DEFAULT_TAB_BAR_HEIGHT : frames.endCoordinates.height
     this.setState({
       keyboardSpace: keyboardSpace,
@@ -49,7 +51,7 @@ const KeyboardAwareMixin = {
   /**
    * @param extraHeight: takes an extra height in consideration.
    */
-  scrollToFocusedInput: function (event, reactNode, extraHeight = _KAM_DEFAULT_TAB_BAR_HEIGHT) {
+  scrollToFocusedInput: function (event: Object, reactNode: Object, extraHeight: number = _KAM_DEFAULT_TAB_BAR_HEIGHT) {
     const scrollView = this.refs.keyboardView.getScrollResponder()
     this.setTimeout(() => {
       scrollView.scrollResponderScrollNativeHandleToKeyboard(

lib/KeyboardAwareScrollView.js

@@ -1,10 +1,13 @@
-import React, { ScrollView } from 'react-native'
+/* @flow */
+
+import React, { PropTypes } from 'react'
+import { ScrollView } from 'react-native'
 import KeyboardAwareMixin from './KeyboardAwareMixin'
 
 const KeyboardAwareScrollView = React.createClass({
   propTypes: {
     ...ScrollView.propTypes,
-    viewIsInsideTabBar: React.PropTypes.bool,
+    viewIsInsideTabBar: PropTypes.bool,
   },
   mixins: [KeyboardAwareMixin],