refactor(docs): drawer/icon/select/spinner/checkbox/layout documentat…

…ion refactor
akveo · Aug 30, 2019 · 44ea5c3 · 44ea5c3
1 parent c45b273
commit 44ea5c3
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 14 deletions.
diff --git a/src/framework/ui/checkbox/checkbox.component.tsx b/src/framework/ui/checkbox/checkbox.component.tsx
@@ -146,7 +146,7 @@ export type CheckBoxElement = React.ReactElement<CheckBoxProps>;
  *
  * ```
  * import React from 'react';
- * import { CheckBox } from '@kitten/ui';
+ * import { CheckBox } from 'react-native-ui-kitten';
  * import { View } from 'react-native';
  *
  * interface State {

diff --git a/src/framework/ui/drawer/drawer.component.tsx b/src/framework/ui/drawer/drawer.component.tsx
@@ -22,7 +22,7 @@ export type DrawerProps = StyledComponentProps & ComponentProps & MenuProps;
 export type DrawerElement = React.ReactElement<DrawerProps>;
 
 /**
- * Styled Navigation Drawer component. The principle of rendering a Drawer is the same as a rendering a List.
+ * Styled `Navigation Drawer` component. The principle of rendering a `Drawer` is the same as a rendering a List.
  *
  * @extends React.Component
  *

diff --git a/src/framework/ui/icon/icon.component.tsx b/src/framework/ui/icon/icon.component.tsx
@@ -24,7 +24,7 @@ export type IconProps<T = {}> = ComponentProps & T;
 export type IconElement<T> = React.ReactElement<T>;
 
 /**
- * Icon component with animation support. Allows to render any ReactElement registered for a specific name.
+ * `Icon` component with animation support. Allows to render any ReactElement registered for a specific name.
  * Starting from UI Kitten 4.2, there is `@ui-kitten/eva-icons` module
  * that renders any icon from eva-icons package in `svg` format.
  *
@@ -52,8 +52,8 @@ export type IconElement<T> = React.ReactElement<T>;
  *       <ApplicationProvider
  *         mapping={mapping}
  *         theme={lightTheme}>
- *         <Application/>
  *         <IconRegistry icons={EvaIconsPack}/>
+ *         <Application/>
  *       </ApplicationProvider>
  *     );
  *   }

diff --git a/src/framework/ui/layout/layout.component.tsx b/src/framework/ui/layout/layout.component.tsx
@@ -49,7 +49,7 @@ export type LayoutElement = React.ReactElement<LayoutProps>;
  * import {
  *   Layout,
  *   Text,
- * } from '@kitten/ui';
+ * } from 'react-native-ui-kitten';
  *
  * export class LayoutShowcase extends React.Component {
  *
@@ -78,7 +78,7 @@ export type LayoutElement = React.ReactElement<LayoutProps>;
  * import {
  *   Layout,
  *   Text,
- * } from '@kitten/ui';
+ * } from 'react-native-ui-kitten';
  *
  * export class LayoutShowcase extends React.Component {
  *

diff --git a/src/framework/ui/select/select.component.tsx b/src/framework/ui/select/select.component.tsx
@@ -85,7 +85,7 @@ interface State {
 }
 
 /**
- * Styled Select (Select) component.
+ * Styled `Select` component.
  *
  * @extends React.Component
  *
@@ -137,7 +137,7 @@ interface State {
  *   Select,
  *   SelectOptionType,
  *   SelectOption,
- * } from '@kitten/ui';
+ * } from 'react-native-ui-kitten';
  *
  * interface State {
  *   selectedOption: SelectOption;
@@ -183,7 +183,7 @@ interface State {
  *   Select,
  *   SelectOptionType,
  *   SelectOption,
- * } from '@kitten/ui';
+ * } from 'react-native-ui-kitten';
  *
  * interface State {
  *   selectedOption: SelectOption;
@@ -230,7 +230,7 @@ interface State {
  *   Select,
  *   SelectOptionType,
  *   SelectOption,
- * } from '@kitten/ui';
+ * } from 'react-native-ui-kitten';
  *
  * interface State {
  *   selectedOption: SelectOption;
@@ -282,8 +282,8 @@ interface State {
  *   Select,
  *   SelectOptionType,
  *   SelectOption,
- * } from '@kitten/ui';
- * import { StyleType } from '@kitten/theme';
+ *   StyleType
+ * } from 'react-native-ui-kitten';
  *
  * interface State {
  *   selectedOption: SelectOption;
@@ -342,7 +342,7 @@ interface State {
  *   Select,
  *   SelectOptionType,
  *   SelectOption,
- * } from '@kitten/ui';
+ * } from 'react-native-ui-kitten';
  *
  * interface State {
  *   selectedOption: SelectOption;

diff --git a/src/framework/ui/spinner/spinner.component.tsx b/src/framework/ui/spinner/spinner.component.tsx
@@ -33,7 +33,7 @@ export type SpinnerProps = StyledComponentProps & ComponentProps;
 export type SpinnerElement = React.ReactElement<SpinnerProps>;
 
 /**
- * Styled Spinner component. Designed to be used as ActivityIndicator component
+ * Styled `Spinner` component. Designed to be used as `ActivityIndicator` component
  *
  * @extends React.Component
  *