From 29d5465467fa53b37c0f408192006552d1a9c2bc Mon Sep 17 00:00:00 2001
From: Ceyhun Ozugur <ceyhunozugur@gmail.com>
Date: Mon, 3 Dec 2018 12:05:36 +0100
Subject: [PATCH] Add docs

---
 types/storybook__react-native/index.d.ts | 73 ++++++++++++++++++++++++
 1 file changed, 73 insertions(+)

diff --git a/types/storybook__react-native/index.d.ts b/types/storybook__react-native/index.d.ts
index 5c71878c0c..fc308fa69b 100644
--- a/types/storybook__react-native/index.d.ts
+++ b/types/storybook__react-native/index.d.ts
@@ -11,17 +11,90 @@
 import * as React from 'react';
 
 export interface StorybookUIOptions {
+    /**
+     * display navigator and addons on the device
+     *
+     * @default true
+     */
     onDeviceUI?: boolean;
+
+    /**
+     * allows to display stories without running storybook server. Should be used with onDeviceUI
+     *
+     * @default false
+     */
     disableWebsockets?: boolean;
+
+    /**
+     * use wss/https instead of ws/http
+     *
+     * @default false
+     */
     secured?: boolean;
+
+    /**
+     * host to use
+     *
+     * @default NativeModules.SourceCode.scriptURL
+     */
     host?: string;
+
+    /**
+     * port to use
+     *
+     * @default 7007
+     */
     port?: number;
+
+    /**
+     * additional query string to pass to websockets
+     *
+     * @default ""
+     */
     query?: string;
+
+    /**
+     * should the ui be closed initialy.
+     *
+     * @default false
+     */
     isUIHidden?: boolean;
+
+    /**
+     * which tab should be open. -1 Navigator, 0 Preview, 1 Addons
+     *
+     * @default 0
+     */
     tabOpen?: number;
+
+    /**
+     * initialize storybook with a specific story.
+     * In case a valid object is passed, it will take precedence over `shouldPersistSelection`.
+     * ex: `{ kind: 'Knobs', story: 'with knobs' }`
+     *
+     * @default null
+     */
     initialSelection?: object;
+
+    /**
+     * initialize storybook with the last selected story.
+     *
+     * @default true
+     */
     shouldPersistSelection?: boolean;
+
+    /**
+     * disable KeyboardAvoidingView wrapping Storybook's view
+     *
+     * @default false
+     */
     shouldDisableKeyboardAvoidingView?: boolean;
+
+    /**
+     * this will set the keyboardverticaloffset (https://facebook.github.io/react-native/docs/keyboardavoidingview#keyboardverticaloffset) value for KeyboardAvoidingView wrapping Storybook's view
+     *
+     * @default 0
+     */
     keyboardAvoidingViewVerticalOffset?: number;
 }