Add most of the docs

Author: M-i-k-e-l

lib/components/Keyboard/KeyboardInput/KeyboardAccessoryView.js

@@ -16,26 +16,80 @@ import KeyboardUtils from './utils/KeyboardUtils';
 const IsIOS = Platform.OS === 'ios';
 const IsAndroid = Platform.OS === 'android';
 
+/**
+ * @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/keyboardInput/KeyboardInputViewScreen.js
+ */
 class KeyboardAccessoryView extends Component {
   static propTypes = {
+    /**
+     * Content to be rendered above the keyboard
+     */
     renderContent: PropTypes.func,
+    /**
+     * A callback for when the height is changed
+     */
     onHeightChanged: PropTypes.func,
     /**
      * iOS only.
      * The reference to the actual text input (or the keyboard may not reset when instructed to, etc.).
      * This is required.
      */
     kbInputRef: PropTypes.object,
+    /**
+     * The keyboard ID (the componentID sent to KeyboardRegistry)
+     */
     kbComponent: PropTypes.string,
+    /**
+     * The props that will be sent to the KeyboardComponent
+     */
     kbInitialProps: PropTypes.object,
+    /**
+     * Callback that will be called when an item on the keyboard has been pressed.
+     */
     onItemSelected: PropTypes.func,
+    /**
+     * TODO: complete docs
+     */
     onRequestShowKeyboard: PropTypes.func,
+    /**
+     * Callback that will be called once the keyboard has been closed
+     */
     onKeyboardResigned: PropTypes.func,
+    /**
+     * iOS only.
+     * The scrolling behavior, use NativeModules.KeyboardTrackingViewManager.X where X is:
+     * KeyboardTrackingScrollBehaviorNone - 0,
+     * KeyboardTrackingScrollBehaviorScrollToBottomInvertedOnly - 1,
+     * KeyboardTrackingScrollBehaviorFixedOffset - 2
+     * 
+     * KeyboardTrackingScrollBehaviorFixedOffset is the default
+     */
     iOSScrollBehavior: PropTypes.number,
+    /**
+     * iOS only.
+     * TODO: complete docs
+     */
     revealKeyboardInteractive: PropTypes.bool,
+    /**
+     * iOS only.
+     * TODO: complete docs
+     */
     manageScrollView: PropTypes.bool,
+    /**
+     * iOS only.
+     * TODO: complete docs
+     */
     requiresSameParentToManageScrollView: PropTypes.bool,
+    /**
+     * iOS only.
+     * TODO: complete docs
+     */
     addBottomView: PropTypes.bool,
+    /**
+     * iOS only.
+     * TODO: complete docs
+     */
     allowHitsOutsideBounds: PropTypes.bool
   };
 

lib/components/Keyboard/KeyboardInput/KeyboardRegistry.js

@@ -15,10 +15,21 @@ 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
+ */
 export default class KeyboardRegistry {
+  static displayName = 'KeyboardRegistry';
   static registeredKeyboards = {};
   static eventEmitter = new EventEmitterManager();
 
+  /**
+   * Register a new keyboard.
+   * componentID (string) - the ID of the keyboard.
+   * 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 = {}) => {
     if (!_.isFunction(generator)) {
       console.error(`KeyboardRegistry.registerKeyboard: ${componentID} you must register a generator function`);
@@ -28,6 +39,10 @@ export default class KeyboardRegistry {
     AppRegistry.registerComponent(componentID, generator);
   };
 
+  /**
+   * Get a specific keyboard
+   * componentID (string) - the ID of the keyboard.
+   */
   static getKeyboard = componentID => {
     const res = KeyboardRegistry.registeredKeyboards[componentID];
     if (!res || !res.generator) {
@@ -37,37 +52,75 @@ export default class KeyboardRegistry {
     return res.generator();
   };
 
+  /**
+   * Get keyboards by IDs
+   * componentIDs (string[]) - the ID of the keyboard.
+   */
   static getKeyboards = (componentIDs = []) => {
     const validKeyboardIDs = _.intersection(componentIDs, Object.keys(KeyboardRegistry.registeredKeyboards));
     return getKeyboardsWithIDs(validKeyboardIDs);
   };
 
+  /**
+   * Get all keyboards
+   */
   static getAllKeyboards = () => {
     return getKeyboardsWithIDs(Object.keys(KeyboardRegistry.registeredKeyboards));
   };
 
+  /**
+   * Add a listener for a callback.
+   * globalID (string) - ID that includes the componentID and the event name
+   *                     (i.e. if componentID='kb1' globalID='kb1.onItemSelected')
+   * callback (function) - the callback to be called when the said event happens
+   */
   static addListener = (globalID, callback) => {
     KeyboardRegistry.eventEmitter.listenOn(globalID, callback);
   };
 
+  /**
+   * Notify that an event has occurred.
+   * globalID (string) - ID that includes the componentID and the event name
+   *                     (i.e. if componentID='kb1' globalID='kb1.onItemSelected')
+   * args (object) - data to be sent to the listener.
+   */
   static notifyListeners = (globalID, args) => {
     KeyboardRegistry.eventEmitter.emitEvent(globalID, args);
   };
 
+  /**
+   * Remove a listener for a callback.
+   * globalID (string) - ID that includes the componentID and the event name
+   *                     (i.e. if componentID='kb1' globalID='kb1.onItemSelected')
+   */
   static removeListeners = globalID => {
     KeyboardRegistry.eventEmitter.removeListeners(globalID);
   };
 
+  /**
+   * Default event to be used for when an item on the keyboard has been pressed.
+   * globalID (string) - ID that includes the componentID and the event name
+   *                     (i.e. if componentID='kb1' globalID='kb1.onItemSelected')
+   * args (object) - data to be sent to the listener.
+   */
   static onItemSelected = (globalID, args) => {
     KeyboardRegistry.notifyListeners(`${globalID}.onItemSelected`, args);
   };
 
+  /**
+   * TODO: complete docs
+   * globalID (string) - ID that includes the componentID and the event name
+   *                     (i.e. if componentID='kb1' globalID='kb1.onItemSelected')
+   */
   static requestShowKeyboard = globalID => {
     KeyboardRegistry.notifyListeners('onRequestShowKeyboard', {keyboardId: globalID});
   };
 
   /**
    * iOS only
+   * TODO: complete docs
+   * globalID (string) - ID that includes the componentID and the event name
+   *                     (i.e. if componentID='kb1' globalID='kb1.onItemSelected')
    */
   static toggleExpandedKeyboard = globalID => {
     KeyboardRegistry.notifyListeners('onToggleExpandedKeyboard', {keyboardId: globalID});

lib/components/Keyboard/KeyboardInput/utils/KeyboardUtils.js

@@ -1,7 +1,15 @@
 import {Keyboard} from 'react-native';
 import TextInputKeyboardManager from '../TextInputKeyboardManager';
 
+/**
+ * @description: util for managing the keyboard.
+ * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/nativeComponentScreens/keyboardInput/KeyboardInputViewScreen.js
+ */
 export default class KeyboardUtils {
+  static displayName = 'KeyboardUtils';
+  /**
+   * Used to dismiss (close) the keyboard.
+   */
   static dismiss = () => {
     Keyboard.dismiss();
     TextInputKeyboardManager.dismissKeyboard();