refactor(ui): bottom-navigation documentation update

akveo · Jul 23, 2019 · 144abb4 · 144abb4
1 parent 27eac63
commit 144abb4
Showing 1 changed file with 34 additions and 1 deletion.
diff --git a/src/framework/ui/bottomNavigation/bottomNavigation.component.tsx b/src/framework/ui/bottomNavigation/bottomNavigation.component.tsx
@@ -44,6 +44,9 @@ export type BottomNavigationProps = StyledComponentProps & ViewProps & Component
  *
  * @property {number} selectedIndex - Determines index of the selected tab.
  *
+ * @property {string} appearance - Determines the appearance of the component.
+ * Can be `default` | `noIndicator`.
+ *
  * @property {React.ReactElement<TabProps> | React.ReactElement<TabProps>[]} children -
  * Determines tabs of the Bottom Navigation.
  *
@@ -55,7 +58,7 @@ export type BottomNavigationProps = StyledComponentProps & ViewProps & Component
  *
  * @property StyledComponentProps
  *
- * @example Simple usage example
+ * @overview-example Simple usage example
  *
  * ```
  * import React from 'react';
@@ -85,6 +88,36 @@ export type BottomNavigationProps = StyledComponentProps & ViewProps & Component
  * }
  * ```
  *
+ * @overview-example Without indicator
+ *
+ * ```
+ * import React from 'react';
+ * import { BottomNavigation, BottomNavigationTab } from 'react-native-ui-kitten';
+ *
+ * export class BottomNavigationShowcase extends React.Component {
+ *
+ *   public state = {
+ *     selectedIndex: 0,
+ *   };
+ *
+ *   private onTabSelect = (selectedIndex: number) => {
+ *     this.setState({ selectedIndex });
+ *   };
+ *
+ *   public render(): React.ReactNode {
+ *     return (
+ *       <BottomNavigation
+ *          appearance='noIndicator'
+ *          selectedIndex={this.state.selectedIndex}
+ *          onSelect={this.onTabSelect}
+ *          <BottomNavigationTab title='Tab 1/>
+ *          <BottomNavigationTab title='Tab 2/>
+ *       </BottomNavigation>
+ *     );
+ *   }
+ * }
+ * ```
+ *
  * @example Inline styling example
  *
  * ```