Breadcrumbs docs fixes

bcrumbs · May 6, 2018 · 5f2464d · 5f2464d
1 parent f0534e4
commit 5f2464d
Show file tree

Hide file tree

Showing 9 changed files with 66 additions and 57 deletions.
diff --git a/demo/routes/breadcrumbs/index.js b/demo/routes/breadcrumbs/index.js
@@ -3,6 +3,8 @@ import { RouteInfo, RouteProps } from '../../components/Route/RouteStructure';
 
 //eslint-disable-next-line
 import BreadcrumbsCode from '!raw-loader!../../../packages/reactackle-breadcrumbs/src/Breadcrumbs';
+//eslint-disable-next-line
+import BreadcrumbsItemCode from '!raw-loader!../../../packages/reactackle-breadcrumbs/src/BreadcrumbsItem/BreadcrumbsItem';
 
 const propTypes = RouteInfo.propTypes;
 const defaultProps = {
@@ -11,11 +13,17 @@ const defaultProps = {
   routeTitle: 'Breadcrumbs',
 };
 
-const itemProps = (
+const itemProps = [
   <RouteProps
     componentCode={BreadcrumbsCode}
-  />
-);
+    key='component-code'
+  />,
+  <RouteProps
+    componentCode={BreadcrumbsItemCode}
+    title="Item Props"
+    key='component-item-code'
+  />,
+];
 
 export const BreadcrumbsIndexRoute = props => (
   <div className="route-info">

diff --git a/demo/routes/customizing/customizing.js b/demo/routes/customizing/customizing.js
@@ -11,7 +11,7 @@ import {
 import {
   ArticleModule,
   ArticleHeader,
-} from '../../components/Article/Article';
+} from '../../components/Article';
 
 import { CodeBox } from '../../components/CodeBox/CodeBox';
 import Theming from './snippets/theming.snippet';

diff --git a/demo/routes/tabs/index.js b/demo/routes/tabs/index.js
@@ -4,7 +4,7 @@ import React from 'react';
 import {
   ArticleModule,
   ArticleHeader,
-} from '../../components/Article/Article';
+} from '../../components/Article';
 import {
   RouteInfo,
   RouteProps,

diff --git a/demo/routes/theme/index.js b/demo/routes/theme/index.js
@@ -8,7 +8,7 @@ import {
 import {
   ArticleModule,
   ArticleHeader,
-} from '../../components/Article/Article';
+} from '../../components/Article';
 
 import { CodeBox } from '../../components/CodeBox/CodeBox';
 import ThemeStructure from './snippets/theme-structure.snippet';

diff --git a/demo/routes/usage/usage.js b/demo/routes/usage/usage.js
@@ -10,7 +10,7 @@ import {
 import {
   ArticleModule,
   ArticleHeader,
-} from '../../components/Article/Article';
+} from '../../components/Article';
 
 import { CodeBox } from '../../components/CodeBox/CodeBox';
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/reactackle-breadcrumbs/src/Breadcrumbs.js b/packages/reactackle-breadcrumbs/src/Breadcrumbs.js
@@ -17,38 +17,38 @@ import {
 registerDefaultComponentTheme('breadcrumbs', componentTheme);
 
 const propTypes = {
-  /*
+  /**
    * Array of breadcrumbs items
    */
   items: PropTypes.arrayOf(BreadcrumbsItem).isRequired,
-  /*
+  /**
    * If true, breadcrumbs will become scrollable to fit wrapper width
    */
   overflow: PropTypes.bool,
-  /*
+  /**
    * Component to be used as a link in BreadcrumbItem
    */
   linkComponent: PropTypes.func,
-  /*
+  /**
    * Define component's color scheme
    */
   colorScheme: PropTypes.oneOf(['light', 'dark']),
-  /*
+  /**
    * Vertical align of items
    */
   alignItems: PropTypes.oneOf(['top', 'center', 'bottom']),
-  /*
+  /**
    * Type of separator between items
    */
   separatorType: PropTypes.oneOf(['text', 'icon']),
-  /*
+  /**
    * Define separator
    */
   separatorIcon: PropTypes.oneOfType([
     PropTypes.string,
     PropTypes.element,
   ]),
-  /*
+  /**
    * Function to be used on item's click
    */
   onItemClick: PropTypes.func,

diff --git a/packages/reactackle-breadcrumbs/src/BreadcrumbsItem/BreadcrumbsItem.js b/packages/reactackle-breadcrumbs/src/BreadcrumbsItem/BreadcrumbsItem.js
@@ -27,46 +27,46 @@ const MenuItemType =
   });
 
 const propTypes = {
-  /*
+  /**
    * Define component's color scheme
    */
   colorScheme: PropTypes.oneOf(['light', 'dark']),
-  /*
+  /**
    * Item index
    */
   index: PropTypes.number,
-  /*
+  /**
    * Adds home icon
    */
   home: PropTypes.bool,
-  /*
+  /**
    * Item's title
    */
   title: PropTypes.string,
-  /*
+  /**
    * Item's subtitle
    */
   subtitle: PropTypes.string,
-  /*
+  /**
    * Define separator
    */
   separatorIcon: PropTypes.oneOfType([
     PropTypes.string,
     PropTypes.element,
   ]),
-  /*
+  /**
    * Item's href
    */
   itemHref: PropTypes.string,
-  /*
+  /**
    * Active item isn't clickable and have special appearance
    */
   isActive: PropTypes.bool,
-  /*
+  /**
    * Component to be used as a link
    */
   linkComponent: PropTypes.func,
-  /*
+  /**
    * Content's vertical align
    */
   alignItems: PropTypes.oneOf(['top', 'center', 'bottom']),
@@ -76,7 +76,7 @@ const propTypes = {
     type: PropTypes.func,
     data: PropTypes.arrayOf(MenuItemType),
   })),
-  /*
+  /**
    * ariaCurrentValue value
    */
   ariaCurrentValue: PropTypes.string,

diff --git a/webpack.config.js b/webpack.config.js
@@ -75,6 +75,7 @@ const mainConfig = {
 
   devServer: {
     port: 8090,
+    host: '0.0.0.0',
     contentBase: 'dist/',
     publicPath: '/',
   },