uilib-native 3.0.4 → 3.0.8

package/components/Keyboard/KeyboardInput/{KeyboardRegistry.js → KeyboardRegistry.ts}

@@ -6,7 +6,7 @@ import EventEmitterManager from './utils/EventEmitterManager';
  * Tech debt: how to deal with multiple registries in the app?
  */
 
-const getKeyboardsWithIDs = keyboardIDs => {
+const getKeyboardsWithIDs = (keyboardIDs: string[]) => {
   return keyboardIDs.map(keyboardId => {
     return {
       id: keyboardId,
@@ -17,11 +17,11 @@ const getKeyboardsWithIDs = keyboardIDs => {
 
 /**
  * @description: used for registering keyboards and performing certain actions on the keyboards.
- * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/nativeComponentScreens/keyboardInput/demoKeyboards.js
+ * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/nativeComponentScreens/keyboardAccessory/demoKeyboards.js
  */
 export default class KeyboardRegistry {
   static displayName = 'KeyboardRegistry';
-  static registeredKeyboards = {};
+  static registeredKeyboards: {[key: string]: any} = {};
   static eventEmitter = new EventEmitterManager();
 
   /**
@@ -30,7 +30,7 @@ export default class KeyboardRegistry {
    * generator (function) - a function for the creation of the keyboard.
    * params (object) - to be returned when using other methods (i.e. getKeyboards and getAllKeyboards).
    */
-  static registerKeyboard = (componentID, generator, params = {}) => {
+  static registerKeyboard = (componentID: string, generator: Function, params = {}) => {
     if (!_.isFunction(generator)) {
       console.error(`KeyboardRegistry.registerKeyboard: ${componentID} you must register a generator function`);
       return;
@@ -43,7 +43,7 @@ export default class KeyboardRegistry {
    * Get a specific keyboard
    * componentID (string) - the ID of the keyboard.
    */
-  static getKeyboard = componentID => {
+  static getKeyboard = (componentID: string) => {
     const res = KeyboardRegistry.registeredKeyboards[componentID];
     if (!res || !res.generator) {
       console.error(`KeyboardRegistry.getKeyboard: ${componentID} used but not yet registered`);
@@ -74,7 +74,7 @@ export default class KeyboardRegistry {
    *                     (i.e. if componentID='kb1' globalID='kb1.onItemSelected')
    * callback (function) - the callback to be called when the said event happens
    */
-  static addListener = (globalID, callback) => {
+  static addListener = (globalID: string, callback: Function) => {
     KeyboardRegistry.eventEmitter.listenOn(globalID, callback);
   };
 
@@ -84,7 +84,7 @@ export default class KeyboardRegistry {
    *                     (i.e. if componentID='kb1' globalID='kb1.onItemSelected')
    * args (object) - data to be sent to the listener.
    */
-  static notifyListeners = (globalID, args) => {
+  static notifyListeners = (globalID: string, args: any) => {
     KeyboardRegistry.eventEmitter.emitEvent(globalID, args);
   };
 
@@ -93,7 +93,7 @@ export default class KeyboardRegistry {
    * globalID (string) - ID that includes the componentID and the event name
    *                     (i.e. if componentID='kb1' globalID='kb1.onItemSelected')
    */
-  static removeListeners = globalID => {
+  static removeListeners = (globalID: string) => {
     KeyboardRegistry.eventEmitter.removeListeners(globalID);
   };
 
@@ -102,7 +102,7 @@ export default class KeyboardRegistry {
    * componentID (string) - the ID of the keyboard.
    * args (object) - data to be sent to the listener.
    */
-  static onItemSelected = (componentID, args) => {
+  static onItemSelected = (componentID: string, args: any) => {
     KeyboardRegistry.notifyListeners(`${componentID}.onItemSelected`, args);
   };
 
@@ -110,16 +110,17 @@ export default class KeyboardRegistry {
    * Request to show the keyboard
    * componentID (string) - the ID of the keyboard.
    */
-  static requestShowKeyboard = componentID => {
+  static requestShowKeyboard = (componentID: string) => {
     KeyboardRegistry.notifyListeners('onRequestShowKeyboard', {keyboardId: componentID});
   };
 
   /**
+   * @deprecated
    * iOS only (experimental)
    * Call to make the keyboard full screen
    * componentID (string) - the ID of the keyboard.
    */
-  static toggleExpandedKeyboard = componentID => {
+  static toggleExpandedKeyboard = (componentID: string) => {
     KeyboardRegistry.notifyListeners('onToggleExpandedKeyboard', {keyboardId: componentID});
   };
 }

package/components/Keyboard/KeyboardInput/{TextInputKeyboardManager.ios.js → TextInputKeyboardManager/TextInputKeyboardManager.ios.ts}

@@ -3,7 +3,8 @@ import ReactNative, {NativeModules, LayoutAnimation} from 'react-native';
 const CustomInputControllerTemp = NativeModules.CustomInputControllerTemp;
 
 export default class TextInputKeyboardManager {
-  static setInputComponent = (textInputRef, {component, initialProps, useSafeArea}) => {
+  static setInputComponent = (textInputRef: any,
+    {component, initialProps, useSafeArea}: {component?: string; initialProps: any; useSafeArea?: boolean}) => {
     if (!textInputRef || !CustomInputControllerTemp) {
       return;
     }
@@ -13,7 +14,7 @@ export default class TextInputKeyboardManager {
     }
   };
 
-  static removeInputComponent = textInputRef => {
+  static removeInputComponent = (textInputRef: any) => {
     if (!textInputRef || !CustomInputControllerTemp) {
       return;
     }
@@ -27,7 +28,7 @@ export default class TextInputKeyboardManager {
     CustomInputControllerTemp.dismissKeyboard();
   };
 
-  static toggleExpandKeyboard = (textInputRef, expand, performLayoutAnimation = false) => {
+  static toggleExpandKeyboard = (textInputRef: any, expand: boolean, performLayoutAnimation = false) => {
     if (textInputRef) {
       if (performLayoutAnimation) {
         LayoutAnimation.configureNext(springAnimation);
@@ -42,7 +43,7 @@ export default class TextInputKeyboardManager {
   };
 }
 
-function findNodeHandle(ref) {
+function findNodeHandle(ref: any) {
   return ReactNative.findNodeHandle(ref.current || ref);
 }
 

package/components/Keyboard/KeyboardInput/TextInputKeyboardManager/index.ts

@@ -0,0 +1,9 @@
+import {Platform} from 'react-native';
+import {default as TextInputKeyboardManagerIOS} from './TextInputKeyboardManager.ios';
+import {default as TextInputKeyboardManagerAndroid} from './TextInputKeyboardManager.android';
+
+const IsAndroid = Platform.OS === 'android';
+
+const TextInputKeyboardManager = IsAndroid ? TextInputKeyboardManagerAndroid : TextInputKeyboardManagerIOS;
+
+export default TextInputKeyboardManager;

package/components/Keyboard/KeyboardInput/keyboardAccessoryView.api.json

@@ -0,0 +1,57 @@
+{
+  "name": "KeyboardAccessoryView",
+  "category": "keyboard",
+  "description": "View that allows replacing the default keyboard with other components",
+  "example": "https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/nativeComponentScreens/keyboardAccessory/KeyboardAccessoryViewScreen.js",
+  "images": [
+    "https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/KeyboardAccessoryView/KeyboardAccessoryView.gif?raw=true"
+  ],
+  "props": [
+    {
+      "name": "renderContent",
+      "type": "() => React.ReactElement",
+      "description": "Content to be rendered above the keyboard"
+    },
+    {
+      "name": "kbInputRef",
+      "type": "any",
+      "description": "The reference to the actual text input (or the keyboard may not reset when instructed to, etc.).\niOS only.",
+      "required": true
+    },
+    {
+      "name": "kbComponent",
+      "type": "string",
+      "description": "The keyboard ID (the componentID sent to KeyboardRegistry)"
+    },
+    {"name": "kbInitialProps", "type": "any", "description": "The props that will be sent to the KeyboardComponent"},
+    {
+      "name": "onHeightChanged",
+      "type": "(height: number) => void",
+      "description": "A callback for when the height is changed"
+    },
+    {
+      "name": "onItemSelected",
+      "type": "() => void",
+      "description": "Callback that will be called when an item on the keyboard has been pressed."
+    },
+    {
+      "name": "onRequestShowKeyboard",
+      "type": "() => void",
+      "description": "Callback that will be called if KeyboardRegistry.requestShowKeyboard is called."
+    },
+    {
+      "name": "onKeyboardResigned",
+      "type": "() => void",
+      "description": "Callback that will be called once the keyboard has been closed"
+    }
+  ],
+  "snippet": [
+    "<KeyboardAccessoryView",
+    " renderContent={this.renderContent()}",
+    " kbInputRef={this.inputRef}",
+    " kbComponent={$1}",
+    " kbInitialProps={$2}",
+    " onHeightChanged={this.onHeightChanged()}",
+    " scrollBehavior={KeyboardAccessoryView.scrollBehaviors.NONE$3}",
+    "/>"
+  ]}

package/components/Keyboard/KeyboardInput/keyboardRegistry.api.json

@@ -0,0 +1,50 @@
+{
+  "name": "KeyboardRegistry",
+  "category": "keyboard",
+  "description": "used for registering keyboards and performing certain actions on the keyboards.",
+  "example": "https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/nativeComponentScreens/keyboardAccessory/demoKeyboards.js",
+  "props": [
+    {
+      "name": "registerKeyboard",
+      "type": "static function",
+      "description": "Register a new keyboard.\ncomponentID (string) - the ID of the keyboard.\ngenerator (function) - a function for the creation of the keyboard.\nparams (object) - to be returned when using other methods (i.e. getKeyboards and getAllKeyboards)."
+    },
+    {
+      "name": "getKeyboard",
+      "type": "static function",
+      "description": "Get a specific keyboard\ncomponentID (string) - the ID of the keyboard."
+    },
+    {
+      "name": "getKeyboards",
+      "type": "static function",
+      "description": "Get keyboards by IDs\ncomponentIDs (string[]) - the ID of the keyboard."
+    },
+    {"name": "getAllKeyboards", "type": "static function", "description": "Get all keyboards"},
+    {
+      "name": "addListener",
+      "type": "static function",
+      "description": "Add a listener for a callback.\nglobalID (string) - ID that includes the componentID and the event name\n                     (i.e. if componentID='kb1' globalID='kb1.onItemSelected')\ncallback (function) - the callback to be called when the said event happens"
+    },
+    {
+      "name": "notifyListeners",
+      "type": "static function",
+      "description": "Notify that an event has occurred.\nglobalID (string) - ID that includes the componentID and the event name\n                    (i.e. if componentID='kb1' globalID='kb1.onItemSelected')\nargs (object) - data to be sent to the listener."
+    },
+    {
+      "name": "removeListeners",
+      "type": "static function",
+      "description": "Remove a listener for a callback.\nglobalID (string) - ID that includes the componentID and the event name\n                    (i.e. if componentID='kb1' globalID='kb1.onItemSelected')"
+    },
+    {
+      "name": "onItemSelected",
+      "type": "static function",
+      "description": "Default event to be used for when an item on the keyboard has been pressed.\ncomponentID (string) - the ID of the keyboard.\nargs (object) - data to be sent to the listener."
+    },
+    {
+      "name": "requestShowKeyboard",
+      "type": "static function",
+      "description": "Request to show the keyboard\ncomponentID (string) - the ID of the keyboard."
+    }
+  ],
+  "snippet": ["KeyboardRegistry.registerKeyboard('keyboardName$1', () => KeyboardComponent$2)"]
+}

package/components/Keyboard/KeyboardInput/utils/{EventEmitterManager.js → EventEmitterManager.ts}

@@ -1,11 +1,12 @@
 import _ from 'lodash';
 
 export default class EventEmitterManager {
+  handlerCallbacks: {[key: string]: Function[]} = {};
   constructor() {
     this.handlerCallbacks = {};
   }
 
-  listenOn(eventName, handlerCallback) {
+  listenOn(eventName: string, handlerCallback: Function) {
     if (!this.handlerCallbacks[eventName]) {
       this.handlerCallbacks[eventName] = [];
     }
@@ -14,17 +15,17 @@ export default class EventEmitterManager {
     }
   }
 
-  emitEvent(eventName, params = {}) {
+  emitEvent(eventName: string, params = {}) {
     if (this.handlerCallbacks[eventName]) {
       this.handlerCallbacks[eventName].forEach(callback => callback(params));
     }
   }
 
-  removeListeners(eventName) {
+  removeListeners(eventName: string) {
     delete this.handlerCallbacks[eventName];
   }
 
-  removeListener(eventName, listener) {
+  removeListener(eventName: string, listener: Function) {
     const handlers = this.handlerCallbacks[eventName];
 
     if (handlers) {

package/components/Keyboard/KeyboardTracking/{KeyboardAwareInsetsView.js → KeyboardAwareInsetsView.tsx}

@@ -1,14 +1,14 @@
 import React from 'react';
 import {StyleSheet, Dimensions} from 'react-native';
-import KeyboardTrackingView from './KeyboardTrackingView';
+import KeyboardTrackingView, {KeyboardTrackingViewProps} from './KeyboardTrackingView';
 
 /**
  * @description: Used to add an inset when a keyboard is used and might hide part of the screen.
  *
- * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/InputsScreen.js
+ * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TextFieldScreen/InputsScreen.js
  * @notes: This view is useful only for iOS.
  */
-const KeyboardAwareInsetsView = props => (
+const KeyboardAwareInsetsView = (props: KeyboardTrackingViewProps) => (
   <KeyboardTrackingView {...props} pointerEvents={'none'} style={styles.insetsView} scrollToFocusedInput/>
 );
 
@@ -25,6 +25,5 @@ const styles = StyleSheet.create({
 });
 
 KeyboardAwareInsetsView.displayName = 'KeyboardAwareInsetsView';
-KeyboardAwareInsetsView.propTypes = KeyboardTrackingView.propTypes;
 
 export default KeyboardAwareInsetsView;

package/components/Keyboard/KeyboardTracking/{KeyboardTrackingView.android.js → KeyboardTrackingView/KeyboardTrackingView.android.tsx}

@@ -2,6 +2,7 @@ import React, {PureComponent} from 'react';
 import {View} from 'react-native';
 
 class KeyboardTrackingView extends PureComponent {
+  static displayName = 'IGNORE';
   render() {
     return <View {...this.props}/>;
   }

package/components/Keyboard/KeyboardTracking/{KeyboardTrackingView.ios.js → KeyboardTrackingView/KeyboardTrackingView.ios.tsx}

@@ -2,11 +2,11 @@
  * Created by artald on 15/05/2016.
  */
 
-import PropTypes from 'prop-types';
 import React, {PureComponent} from 'react';
 import ReactNative, {requireNativeComponent, NativeModules} from 'react-native';
+import {KeyboardTrackingViewProps} from './index';
 
-const NativeKeyboardTrackingView = requireNativeComponent('KeyboardTrackingViewTemp', null);
+const NativeKeyboardTrackingView = requireNativeComponent('KeyboardTrackingViewTemp');
 const KeyboardTrackingViewTempManager = NativeModules.KeyboardTrackingViewTempManager;
 
 /**
@@ -15,23 +15,17 @@ const KeyboardTrackingViewTempManager = NativeModules.KeyboardTrackingViewTempMa
  *
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/nativeComponentScreens/KeyboardTrackingViewScreen.js
  * @notes: This view is useful only for iOS.
+ * @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/KeyboardTrackingView/KeyboardTrackingView.gif?raw=true
  */
-class KeyboardTrackingView extends PureComponent {
+class KeyboardTrackingView extends PureComponent<KeyboardTrackingViewProps> {
   static displayName = 'KeyboardTrackingView';
 
-  static propTypes = {
-    /**
-     * Enables tracking of the keyboard when it's dismissed interactively (false by default).
-     * Why? When using an external keyboard (BT),
-     * you still get the keyboard events and the view just hovers when you focus the input.
-     * Also, if you're not using interactive style of dismissing the keyboard
-     * (or if you don't have an input inside this view) it doesn't make sense to track it anyway.
-     * (This is caused because of the usage of inputAccessory to be able to track the
-     * keyboard interactive change and it introduces this bug)
-     */
-    trackInteractive: PropTypes.bool
+  static defaultProps = {
+    useSafeArea: false
   };
 
+  ref?: any;
+
   render() {
     return <NativeKeyboardTrackingView {...this.props} ref={r => (this.ref = r)}/>;
   }

package/components/Keyboard/KeyboardTracking/KeyboardTrackingView/index.tsx

@@ -0,0 +1,96 @@
+import React, {forwardRef} from 'react';
+import {Platform, NativeModules, ViewStyle, ViewProps} from 'react-native';
+import {default as KeyboardTrackingViewIOS} from './KeyboardTrackingView.ios';
+import {default as KeyboardTrackingViewAndroid} from './KeyboardTrackingView.android';
+
+const isAndroid = Platform.OS === 'android';
+const SCROLL_BEHAVIORS = {
+  NONE: NativeModules.KeyboardTrackingViewTempManager?.KeyboardTrackingScrollBehaviorNone,
+  SCROLL_TO_BOTTOM_INVERTED_ONLY: 
+    NativeModules.KeyboardTrackingViewTempManager?.KeyboardTrackingScrollBehaviorScrollToBottomInvertedOnly,
+  FIXED_OFFSET: NativeModules.KeyboardTrackingViewTempManager?.KeyboardTrackingScrollBehaviorFixedOffset
+};
+
+export type KeyboardTrackingViewProps = ViewProps & {
+  /**
+   * Enables tracking of the keyboard when it's dismissed interactively (false by default).
+   * Why? When using an external keyboard (BT),
+   * you still get the keyboard events and the view just hovers when you focus the input.
+   * Also, if you're not using interactive style of dismissing the keyboard
+   * (or if you don't have an input inside this view) it doesn't make sense to track it anyway.
+   * (This is caused because of the usage of inputAccessory to be able to track the
+   * keyboard interactive change and it introduces this bug)
+   */
+  trackInteractive?: boolean;
+  /**
+   * iOS only.
+   * Show the keyboard on a negative scroll
+   * default: false
+   */
+  revealKeyboardInteractive?: boolean;
+  /**
+   * iOS only.
+   * Set to false to turn off inset management and manage it yourself
+   * default: true
+   */
+  manageScrollView?: boolean;
+  /**
+   * iOS only.
+   * Set to true manageScrollView is set to true and still does not work,
+   * it means that the ScrollView found is the wrong one and you'll have
+   * to have the KeyboardAccessoryView and the ScrollView as siblings
+   * and set this to true
+   *
+   * default: false
+   */
+  requiresSameParentToManageScrollView?: boolean;
+  /**
+   * iOS only.
+   * Allow hitting sub-views that are placed beyond the view bounds
+   *
+   * default: false
+   */
+  allowHitsOutsideBounds?: boolean;
+  scrollToFocusedInput?: boolean;
+  /**
+   * iOS only.
+   * The scrolling behavior (NONE | SCROLL_TO_BOTTOM_INVERTED_ONLY | FIXED_OFFSET)
+   */
+  scrollBehavior?: number;
+  /**
+   * iOS only.
+   * Add a SafeArea view beneath the KeyboardAccessoryView
+   * default: false
+   */
+  addBottomView?: boolean;
+  /**
+   * iOS only.
+   * The bottom view's color
+   * default: 'white'
+   */
+  bottomViewColor?: string;
+  /**
+   * Allow control safe area
+   */
+  useSafeArea?: boolean;
+  /**
+   * Whether or not to include bottom tab bar inset
+   */
+  usesBottomTabs?: boolean;
+  ref?: any;
+  style?: ViewStyle;
+  children?: React.ReactChild | React.ReactChild[];
+};
+
+const KeyboardTrackingView = forwardRef(({children, ...others}: KeyboardTrackingViewProps, ref: any) => {
+  const KeyboardTrackingViewContainer = isAndroid ? KeyboardTrackingViewAndroid : KeyboardTrackingViewIOS;
+  return (
+    <KeyboardTrackingViewContainer {...others} ref={ref}>
+      {children}
+    </KeyboardTrackingViewContainer>
+  );
+});
+
+export default KeyboardTrackingView as (typeof KeyboardTrackingView & {scrollBehaviors: typeof SCROLL_BEHAVIORS});
+// @ts-expect-error
+KeyboardTrackingView.scrollBehaviors = SCROLL_BEHAVIORS;

package/components/Keyboard/KeyboardTracking/KeyboardTrackingView/keyboardTrackingView.api.json

@@ -0,0 +1,95 @@
+{
+  "name": "KeyboardTrackingView",
+  "category": "keyboard",
+  "description": "A UI component that enables 'keyboard tracking' for this view and it's sub-views.\nWould typically be used when you have a TextField or TextInput inside this view.",
+  "note": "This view is useful only for iOS.",
+  "example": "https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/nativeComponentScreens/KeyboardTrackingViewScreen.js",
+  "images": [
+    "https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/KeyboardTrackingView/KeyboardTrackingView.gif?raw=true"
+  ],
+  "props": [
+    {
+      "name": "trackInteractive",
+      "type": "boolean",
+      "description": "Enables tracking of the keyboard when it's dismissed interactively (false by default).\nWhy? When using an external keyboard (BT),\nyou still get the keyboard events and the view just hovers when you focus the input.\nAlso, if you're not using interactive style of dismissing the keyboard\n(or if you don't have an input inside this view) it doesn't make sense to track it anyway.\n(This is caused because of the usage of inputAccessory to be able to track the keyboard interactive change and it introduces this bug)"
+    },
+    {
+      "name": "scrollToFocusedInput",
+      "type": "boolean",
+      "description": "Should the scrollView scroll to the focused input"
+    },
+    {
+      "name": "scrollBehavior",
+      "type": "number",
+      "description": "The scrolling behavior (use KeyboardTrackingView.scrollBehaviors.NONE | SCROLL_TO_BOTTOM_INVERTED_ONLY | FIXED_OFFSET)",
+      "note": "iOS only"
+    },
+    {
+      "name": "revealKeyboardInteractive",
+      "type": "boolean",
+      "description": "Show the keyboard on a negative scroll\niOS only.",
+      "note": "iOS only",
+      "default": "false"
+    },
+    {
+      "name": "manageScrollView",
+      "type": "boolean",
+      "description": "Set to false to turn off inset management and manage it yourself\niOS only.",
+      "note": "iOS only",
+      "default": "true"
+    },
+    {
+      "name": "requiresSameParentToManageScrollView",
+      "type": "boolean",
+      "description": "Set to true manageScrollView is set to true and still does not work,\nit means that the ScrollView found is the wrong one and you'll have\nto have the KeyboardAccessoryView and the ScrollView as siblings\nand set this to true\niOS only.",
+      "note": "iOS only",
+      "default": "false"
+    },
+    {
+      "name": "allowHitsOutsideBounds",
+      "type": "boolean",
+      "description": "Allow hitting sub-views that are placed beyond the view bounds\niOS only.",
+      "note": "iOS only",
+      "default": "false"
+    },
+    {
+      "name": "addBottomView",
+      "type": "boolean",
+      "description": "Add a view beneath the KeyboardAccessoryView\niOS only.",
+      "note": "iOS only",
+      "default": "false"
+    },
+    {
+      "name": "bottomViewColor", 
+      "type": "string", 
+      "description": "The bottom view's color\niOS only.",       
+      "note": "iOS only",
+      "default": "white"
+    },
+    {
+      "name": "useSafeArea",
+      "type": "boolean",
+      "description": "Whether or not to handle SafeArea\niOS only.",
+      "note": "iOS only",
+      "default": "true"
+    },
+    {
+      "name": "usesBottomTabs",
+      "type": "boolean",
+      "description": "Whether or not to include bottom tab bar inset\niOS only.",
+      "note": "iOS only",
+      "default": "false"
+    },
+    {"name": "ref", "type": "any", "description": ""},
+    {"name": "style", "type": "ViewStyle", "description": ""}
+  ],
+  "snippet": [
+    "<KeyboardTrackingView",
+    " style={$1}",
+    " trackInteractive",
+    " useSafeArea",
+    ">",
+    " $2",
+    "</KeyboardTrackingView>"
+  ]
+}

package/components/Keyboard/KeyboardTracking/keyboardAwareInsetsView.api.json

@@ -0,0 +1,14 @@
+{
+  "name": "KeyboardAwareInsetsView",
+  "category": "keyboard",
+  "description": "Used to add an inset when a keyboard is used and might hide part of the screen.",
+  "note": "This view is useful only for iOS.",
+  "extends": ["keyboard/KeyboardTrackingView"],
+  "example": "https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/incubatorScreens/IncubatorTextFieldScreen.tsx",
+  "snippet": ["<ScrollView>",
+    "  <TextField/>",
+    "  <TextField/>",
+    "  <KeyboardAwareInsetsView/>",
+    "<ScrollView>"    
+  ]
+}

package/components/Keyboard/index.ts

@@ -0,0 +1,15 @@
+import KeyboardTrackingView, {KeyboardTrackingViewProps} from './KeyboardTracking/KeyboardTrackingView';
+import KeyboardAwareInsetsView from './KeyboardTracking/KeyboardAwareInsetsView';
+import KeyboardRegistry from './KeyboardInput/KeyboardRegistry';
+import KeyboardAccessoryView, {KeyboardAccessoryViewProps} from './KeyboardInput/KeyboardAccessoryView';
+import KeyboardUtils from './KeyboardInput/utils/KeyboardUtils';
+
+export {KeyboardTrackingViewProps, KeyboardAccessoryViewProps};
+
+export default {
+  KeyboardTrackingView,
+  KeyboardAwareInsetsView,
+  KeyboardRegistry,
+  KeyboardAccessoryView,
+  KeyboardUtils
+};

package/components/SafeArea/{SafeAreaInsetsManager.js → SafeAreaInsetsManager.ts}

@@ -3,16 +3,19 @@
 import {NativeModules, NativeEventEmitter} from 'react-native';
 import _ from 'lodash';
 
-let SafeAreaInsetsCache = null;
+type SafeAreaInsetsType = { top: number; left: number; bottom: number; right: number; } | null 
+
+let SafeAreaInsetsCache: SafeAreaInsetsType = null;
 
 const NativeSafeAreaManager = NativeModules.SafeAreaManager;
 
 class SafeAreaInsetsManager {
-  constructor() {
-    this._defaultInsets = {top: 0, left: 0, bottom: 0, right: 0};
-    this._safeAreaInsets = this._defaultInsets;
-    this._safeAreaChangedDelegates = [];
 
+  _defaultInsets: SafeAreaInsetsType = {top: 0, left: 0, bottom: 0, right: 0};
+  _safeAreaInsets: SafeAreaInsetsType = {top: 0, left: 0, bottom: 0, right: 0};
+  _safeAreaChangedDelegates: Array<any> = [];
+
+  constructor() {
     this.addSafeAreaChangedListener();
   }
 
@@ -46,11 +49,11 @@ class SafeAreaInsetsManager {
     return this._safeAreaInsets;
   }
 
-  addSafeAreaChangedDelegate(delegate) {
+  addSafeAreaChangedDelegate(delegate: any) {
     this._safeAreaChangedDelegates.push(delegate);
   }
 
-  removeSafeAreaChangedDelegate(delegateToRemove) {
+  removeSafeAreaChangedDelegate(delegateToRemove: any) {
     _.remove(this._safeAreaChangedDelegates, (currentDelegate) => {
       return currentDelegate === delegateToRemove;
     });

package/components/SafeArea/SafeAreaSpacerView.tsx

@@ -0,0 +1,19 @@
+import React from 'react';
+import {View, requireNativeComponent, ViewStyle, Platform} from 'react-native';
+
+const NativeSafeAreaSpacerView = requireNativeComponent('SafeAreaSpacerView');
+const isIOS = Platform.OS === 'ios';
+
+export type SafeAreaSpacerViewProps = {
+  style?: ViewStyle;
+};
+
+const SafeAreaSpacerView = ({style}: SafeAreaSpacerViewProps) => {
+  return (
+    // @ts-ignore
+    isIOS ? <NativeSafeAreaSpacerView style={style}/> : <View style={style}/>
+  );
+};
+
+SafeAreaSpacerView.displayName = 'IGNORE';
+export default SafeAreaSpacerView;