Docs3 (#2389)

* Rename TabBar options to BottomTabs

* Restructure docs

docs/_sidebar.md

@@ -9,3 +9,8 @@
  - [Container](/docs/Container)
  - [TopBar](/docs/TopBar)
  - [BottomTabs](/docs/BottomTabs)
+- Options
+ - [BottomTabs](/docs/options/NavigatorOptions)
+ - [BottomTabs](/docs/options/BottomTabs)
+ - [Button](/docs/options/Button)
+ - [BottomTabs](/docs/options/TopBar)

docs/docs/NavigationOptions.md

@@ -1,24 +0,0 @@
-<a name="exp_module_NavigationOptions--NavigationOptions"></a>
-
-## NavigationOptions ⏏
-NavigationOptions are used by containers to customize their behavior and style.
-
-
-* * *
-
-<a name="module_NavigationOptions--NavigationOptions..NavigationOptions"></a>
-
-### NavigationOptions~NavigationOptions : <code>Object</code>
-**Properties**
-
-| Name | Type |
-| --- | --- |
-| topBar | <code>TopBar</code> | 
-| bottomTabs | <code>TabBar</code> | 
-| orientation | <code>String</code> | 
-| rightButtons | <code>Button</code> | 
-| leftButtons | <code>Button</code> | 
-
-
-* * *
-

docs/docs/TabBar.md → docs/docs/options/BottomTabs.md

@@ -1,6 +1,6 @@
-<a name="TabBar"></a>
+<a name="BottomTabs"></a>
 
-## TabBar
+## BottomTabs
 **Properties**
 
 | Name | Type |

docs/docs/options/Button.md

@@ -0,0 +1,19 @@
+<a name="Button"></a>
+
+## Button
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| id | <code>String</code> | 
+| testID | <code>string</code> | 
+| title | <code>string</code> | 
+| buttonColor | <code>string</code> | 
+| showAsAction | <code>string</code> | 
+| buttonFontWeight | <code>int</code> | 
+| disableIconTint | <code>boolean</code> | 
+| disabled | <code>boolean</code> | 
+
+
+* * *
+

docs/docs/options/NavigationOptions.md

@@ -0,0 +1,16 @@
+<a name="NavigationOptions"></a>
+
+## NavigationOptions
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| topBar | <code>TopBar</code> | 
+| bottomTabs | <code>BottomTabs</code> | 
+| orientation | <code>String</code> | 
+| rightButtons | <code>Button</code> | 
+| leftButtons | <code>Button</code> | 
+
+
+* * *
+

docs/docs/options/TopBar.md

@@ -0,0 +1,20 @@
+<a name="TopBar"></a>
+
+## TopBar
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| title | <code>string</code> | 
+| backgroundColor | <code>color</code> | 
+| textColor | <code>color</code> | 
+| textFontSize | <code>number</code> | 
+| textFontFamily | <code>string</code> | 
+| hidden | <code>boolean</code> | 
+| animateHide | <code>boolean</code> | 
+| hideOnScroll | <code>boolean</code> | 
+| transparent | <code>boolean</code> | 
+
+
+* * *
+

lib/src/commands/OptionsProcessor.test.js

@@ -1,5 +1,5 @@
 const OptionsProcessor = require('./OptionsProcessor');
-const NavigationOptions = require('./../params/NavigationOptions');
+const NavigationOptions = require('./../params/options/NavigationOptions');
 
 describe('navigation options', () => {
   let navigationOptions;

lib/src/params/TabBar.js → lib/src/params/options/BottomTabs.js

@@ -1,6 +1,6 @@
 const { isEmpty } = require('lodash');
 
-class TabBar {
+class BottomTabs {
   /**
    * @property {string} [currentTabId]
    * @property {number} [currentTabIndex]
@@ -20,4 +20,4 @@ class TabBar {
   }
 }
 
-module.exports = TabBar;
+module.exports = BottomTabs;

lib/src/params/TabBar.test.js → lib/src/params/options/BottomTabs.test.js

@@ -1,6 +1,6 @@
-const TabBar = require('./TabBar');
+const BottomTabs = require('./BottomTabs');
 
-const TAB_BAR = {
+const BOTTOM_TABS = {
   currentTabId: 1,
   currentTabIndex: 2,
   tabBadge: 3,
@@ -8,9 +8,9 @@ const TAB_BAR = {
   animateHide: true
 };
 
-describe('TabBar', () => {
-  it('parses TabBar options', () => {
-    const uut = new TabBar(TAB_BAR);
+describe('BottomTabs', () => {
+  it('parses BottomTabs options', () => {
+    const uut = new BottomTabs(BOTTOM_TABS);
     expect(uut.currentTabId).toEqual(1);
     expect(uut.currentTabIndex).toEqual(2);
     expect(uut.tabBadge).toEqual(3);

lib/src/params/NavigationOptions.js → lib/src/params/options/NavigationOptions.js

@@ -1,28 +1,18 @@
 const TopBar = require('./TopBar');
-const TabBar = require('./TabBar');
+const BottomTabs = require('./BottomTabs');
 const Button = require('./Button');
 
- /**
- * A module for adding two values.
- * @module NavigationOptions
- */
-
- /**
-  * NavigationOptions are used by containers to customize their behavior and style.
-  * @alias module:NavigationOptions
-  */
 class NavigationOptions {
   /**
-   * @typedef {Object} NavigationOptions
    * @property {TopBar} topBar
-   * @property {TabBar} bottomTabs
+   * @property {BottomTabs} bottomTabs
    * @property {String} [orientation]
    * @property {Button} [rightButtons]
    * @property {Button} [leftButtons]
    */
   constructor(options) {
     this.topBar = options.topBar && new TopBar(options.topBar);
-    this.bottomTabs = options.bottomTabs && new TabBar(options.bottomTabs);
+    this.bottomTabs = options.bottomTabs && new BottomTabs(options.bottomTabs);
     this.orientation = options.orientation;
     this.rightButtons = options.rightButtons && options.rightButtons.map((button) => new Button(button));
     this.leftButtons = options.leftButtons && options.leftButtons.map((button) => new Button(button));

lib/src/params/NavigationOptions.test.js → lib/src/params/options/NavigationOptions.test.js

@@ -1,5 +1,5 @@
 const NavigationOptions = require('./NavigationOptions');
-const TabBar = require('./TabBar');
+const BottomTabs = require('./BottomTabs');
 const TopBar = require('./TopBar');
 
 const TAB_BAR = {};
@@ -31,7 +31,7 @@ const NAVIGATION_OPTIONS = {
 describe('NavigationOptions', () => {
   it('parses navigationOptions correctly', () => {
     const uut = new NavigationOptions(NAVIGATION_OPTIONS);
-    expect(uut.bottomTabs).toBeInstanceOf(TabBar);
+    expect(uut.bottomTabs).toBeInstanceOf(BottomTabs);
     expect(uut.topBar).toBeInstanceOf(TopBar);
     expect(uut.orientation).toEqual('portrait');
     expect(uut.rightButtons).toEqual(RIGHT_BUTTONS);

scripts/generate-js-doc.js

@@ -3,13 +3,14 @@ const fs = require('fs');
 const path = require('path');
 
 const paramsDir = './lib/src/params/';
-const outputDir = './docs/docs/';
+const optionsDir = './lib/src/params/options/';
+const OUTPUT_DIR = './docs/docs/';
 const partial = ['./docs/templates/scope.hbs', './docs/templates/docs.hbs'];
 
-const generateMarkdownForFile = (file) => {
+const generateMarkdownForFile = ({ file, outputDir }) => {
   const templateData = jsdoc2md.getTemplateDataSync({ files: file });
   const classNames = getClassesInFile(templateData);
-  classNames.forEach((className) => createDocFileForClass(className, templateData));
+  classNames.forEach((className) => createDocFileForClass(className, templateData, outputDir));
 };
 
 function getClassesInFile(templateData) {
@@ -22,7 +23,7 @@ function getClassesInFile(templateData) {
   return classNames;
 }
 
-function createDocFileForClass(className, templateData) {
+function createDocFileForClass(className, templateData, outputDir) {
   const template = `{{#class name="${className}"}}{{>docs}}{{/class}}`;
   const options = {
     data: templateData,
@@ -30,15 +31,28 @@ function createDocFileForClass(className, templateData) {
     separators: true,
     partial
   };
-  console.log(`rendering ${className}, template: ${template}`);
+  console.log(`rendering ${className}, template: ${template} ${outputDir}`);
   const output = jsdoc2md.renderSync(options);
   fs.writeFileSync(path.resolve(outputDir, `${className}.md`), output);
 }
 
 function inputFiles() {
   return [
-    './lib/src/Navigation.js',
-    ...fs.readdirSync(paramsDir).map((file) => paramsDir + file)
+    { file: './lib/src/Navigation.js', outputDir: OUTPUT_DIR },
+    ...fs.readdirSync(optionsDir).map((file) => {
+      return {
+        file: optionsDir + file,
+        outputDir: OUTPUT_DIR + 'options/'
+      };
+    }),
+    ...fs.readdirSync(paramsDir)
+        .filter((file) => fs.statSync(paramsDir + file).isFile())
+        .map((file) => {
+          return {
+            file: paramsDir + file,
+            outputDir: OUTPUT_DIR
+          };
+        })
   ];
 }