Merge pull request #33 from aspect-apps/chore/docs-and-types

improving types and docs

Author: rodriigovieira

.DS_Store

@@ -64,13 +64,11 @@ RNNDrawer.showDrawer({
       style: { // Styles the drawer container, supports any react-native style
         backgroundColor: "red",
       },
-      parentComponentId: this.props.componentId, // Custom prop, will be available in your custom drawer component props
+      parentComponentId: props.componentId, // Custom prop, will be available in your custom drawer component props
     },
   }
 });
-```
 
-```js
 RNNDrawer.dismissDrawer();
 ````
 

README.md

@@ -4,14 +4,68 @@
  */
 import * as React from 'react';
 import { Layout } from 'react-native-navigation';
+
+type DirectionType = "left" | "right" | "top" | "bottom";
+
+declare interface RNNDrawerOptions {
+    /**
+     * Id of parent component of the drawer.
+     * This field is necessary in order to be able
+     * to push screens inside the drawer
+     */
+    parentComponentId: string;
+
+    /**
+     * Time in milliseconds to execute the drawer opening animation
+     */
+    animationOpenTime?: number;
+
+    /**
+     * Time in milliseconds to execute the drawer closing animation
+     */
+    animationCloseTime?: number;
+
+    /**
+     * Direction to open the collage,
+     * one of: ["left", "right", "top", "bottom"]
+     */
+    direction?: DirectionType;
+
+    /**
+     * Whether the drawer be dismissed when a click is registered outside
+     */
+    dismissWhenTouchOutside?: boolean;
+
+    /**
+     * Opacity of the screen outside the drawer
+     */
+    fadeOpacity?: number;
+
+    /**
+     * Width of drawer in relation to the screen (0 to 1)
+     */
+    drawerScreenWidth?: number;
+
+    /**
+     * Height of drawer in relation to the screen (0 to 1)
+     */
+    drawerScreenHeight?: number;
+}
+
 declare class RNNDrawer {
+    /**
+     * Generates the drawer component to
+     * be used with react-native-navigation
+     * 
+     * @param component
+     */
     static create(Component: React.ComponentType): any;
     /**
      * Shows a drawer component
      *
      * @param layout
      */
-    static showDrawer(layout: Layout): void;
+    static showDrawer(layout: Layout<RNNDrawerOptions>): void;
     /**
      * Dismiss the drawer component
      */