Fix/docs extends link (#1237)

mendyEdri · web-flow · commit 5af4d6533109 · 2021-03-24T06:51:29.000+02:00
* fix docs extends link logic

* fix extends link name + added example for Text
diff --git a/generatedTypes/components/avatar/index.d.ts b/generatedTypes/components/avatar/index.d.ts
@@ -113,7 +113,7 @@ export declare type AvatarPropTypes = AvatarProps;
  * @description: Avatar component for displaying user profile images
  * @extends: TouchableOpacity
  * @extendsnotes: (when passing onPress)
- * @extendslink: docs/TouchableOpacity
+ * @extendsLink: docs/TouchableOpacity
  * @image: https://user-images.githubusercontent.com/33805983/34480603-197d7f64-efb6-11e7-9feb-db8ba756f055.png
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/AvatarsScreen.tsx
  */
diff --git a/generatedTypes/components/badge/index.d.ts b/generatedTypes/components/badge/index.d.ts
@@ -84,7 +84,7 @@ export declare type BadgeProps = ViewProps & TouchableOpacityProps & {
 /**
  * @description: Round colored badge, typically used to show a number
  * @extends: Animatable.View
- * @extendslink: https://github.com/oblador/react-native-animatable
+ * @extendsLink: https://github.com/oblador/react-native-animatable
  * @image: https://user-images.githubusercontent.com/33805983/34480753-df7a868a-efb6-11e7-9072-80f5c110a4f3.png
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/BadgesScreen.tsx
  */
diff --git a/generatedTypes/components/image/index.d.ts b/generatedTypes/components/image/index.d.ts
@@ -57,7 +57,7 @@ declare type State = {
 /**
  * @description: Image wrapper with extra functionality like source transform and assets support
  * @extends: Image
- * @extendslink: https://facebook.github.io/react-native/docs/image.html
+ * @extendsLink: https://facebook.github.io/react-native/docs/image.html
  */
 declare class Image extends PureComponent<Props, State> {
     static displayName: string;
diff --git a/generatedTypes/components/modal/index.d.ts b/generatedTypes/components/modal/index.d.ts
@@ -32,7 +32,7 @@ export interface ModalProps extends RNModalProps {
 /**
  * @description: Component that present content on top of the invoking screen
  * @extends: Modal
- * @extendslink: https://facebook.github.io/react-native/docs/modal.html
+ * @extendsLink: https://facebook.github.io/react-native/docs/modal.html
  * @gif: https://media.giphy.com/media/3oFzmfSX8KgvctI4Ks/giphy.gif
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ModalScreen.tsx
  */
diff --git a/generatedTypes/components/text/index.d.ts b/generatedTypes/components/text/index.d.ts
@@ -33,7 +33,7 @@ declare type PropsTypes = BaseComponentInjectedProps & ForwardRefInjectedProps &
 /**
  * @description: A wrapper for Text component with extra functionality like modifiers support
  * @extends: Text
- * @extendslink: https://facebook.github.io/react-native/docs/text.html
+ * @extendsLink: https://facebook.github.io/react-native/docs/text.html
  * @modifiers: margins, color, typography
  */
 declare class Text extends PureComponent<PropsTypes> {
diff --git a/src/components/avatar/index.tsx b/src/components/avatar/index.tsx
@@ -144,7 +144,7 @@ export type AvatarPropTypes = AvatarProps; //TODO: remove after ComponentPropTyp
  * @description: Avatar component for displaying user profile images
  * @extends: TouchableOpacity
  * @extendsnotes: (when passing onPress)
- * @extendslink: docs/TouchableOpacity
+ * @extendsLink: docs/TouchableOpacity
  * @image: https://user-images.githubusercontent.com/33805983/34480603-197d7f64-efb6-11e7-9feb-db8ba756f055.png
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/AvatarsScreen.tsx
  */
diff --git a/src/components/badge/index.tsx b/src/components/badge/index.tsx
@@ -109,7 +109,7 @@ export type BadgeProps = ViewProps &
 /**
  * @description: Round colored badge, typically used to show a number
  * @extends: Animatable.View
- * @extendslink: https://github.com/oblador/react-native-animatable
+ * @extendsLink: https://github.com/oblador/react-native-animatable
  * @image: https://user-images.githubusercontent.com/33805983/34480753-df7a868a-efb6-11e7-9072-80f5c110a4f3.png
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/BadgesScreen.tsx
  */
diff --git a/src/components/button/ButtonTypes.tsx b/src/components/button/ButtonTypes.tsx
@@ -158,7 +158,7 @@ export const DEFAULT_PROPS = {
 /**
  * @description: Basic button component
  * @extends: TouchableOpacity
- * @extendslink: docs/TouchableOpacity
+ * @extendsLink: docs/TouchableOpacity
  * @modifiers: margin, background
  * @gif: https://media.giphy.com/media/xULW8j5WzsuPytqklq/giphy.gif
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ButtonsScreen.tsx
diff --git a/src/components/card/index.tsx b/src/components/card/index.tsx
@@ -107,7 +107,7 @@ type State = {
  * @description: Card component
  * @extends: TouchableOpacity
  * @extendsnotes: (Touchable when passing onPress)
- * @extendslink: docs/TouchableOpacity
+ * @extendsLink: docs/TouchableOpacity
  * @modifiers: margin, padding
  * @gif: https://media.giphy.com/media/l0HU9SKWmv0VTOYMM/giphy.gif
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/CardsScreen.tsx
diff --git a/src/components/checkbox/index.tsx b/src/components/checkbox/index.tsx
@@ -89,7 +89,7 @@ interface CheckboxState {
 /**
  * @description: Checkbox component for toggling boolean value related to some context
  * @extends: TouchableOpacity
- * @extendslink: docs/TouchableOpacity
+ * @extendsLink: docs/TouchableOpacity
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/CheckboxScreen.tsx
  */
 class Checkbox extends Component<CheckboxProps, CheckboxState> {
diff --git a/src/components/chip/index.tsx b/src/components/chip/index.tsx
@@ -118,7 +118,7 @@ export type ChipPropTypes = ChipProps; //TODO: remove after ComponentPropTypes d
 /**
  * @description: Chip component
  * @extends: TouchableOpacity
- * @extendslink: docs/TouchableOpacity
+ * @extendsLink: docs/TouchableOpacity
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ChipScreen.tsx
  */
 const Chip = ({
diff --git a/src/components/featureHighlight/index.js b/src/components/featureHighlight/index.js
@@ -30,7 +30,7 @@ const contentViewHeight = Constants.isAndroid ? 268 : 282;
  * @important: FeatureHighlight uses a native library. You MUST add and link the native library to both iOS and Android projects. For instruction please see
  * @importantLink: https://facebook.github.io/react-native/docs/linking-libraries-ios.html
  * @extends: HighlighterOverlayView
- * @extendslink: docs/HighlighterOverlayView
+ * @extendsLink: docs/HighlighterOverlayView
  * @gif: https://media.giphy.com/media/3ohs4D5irZm5GojsDS/giphy.gif, https://media.giphy.com/media/3oxQNaDQckPZI78rWo/giphy.gif
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/FeatureHighlightScreen.js
  */
diff --git a/src/components/image/index.tsx b/src/components/image/index.tsx
@@ -76,7 +76,7 @@ type State = {
 /**
  * @description: Image wrapper with extra functionality like source transform and assets support
  * @extends: Image
- * @extendslink: https://facebook.github.io/react-native/docs/image.html
+ * @extendsLink: https://facebook.github.io/react-native/docs/image.html
  */
 class Image extends PureComponent<Props, State> {
   static displayName = 'Image';
diff --git a/src/components/listItem/index.js b/src/components/listItem/index.js
@@ -10,7 +10,7 @@ import ListItemPart from './ListItemPart';
 /**
  * @description: List item component to render inside a List component
  * @extends: TouchableOpacity
- * @extendslink: docs/TouchableOpacity
+ * @extendsLink: docs/TouchableOpacity
  * @gif: https://media.giphy.com/media/l1IBjHowyPcOTWAY8/giphy.gif
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/BasicListScreen.js
  */
diff --git a/src/components/modal/index.tsx b/src/components/modal/index.tsx
@@ -41,7 +41,7 @@ export interface ModalProps extends RNModalProps {
 /**
  * @description: Component that present content on top of the invoking screen
  * @extends: Modal
- * @extendslink: https://facebook.github.io/react-native/docs/modal.html
+ * @extendsLink: https://facebook.github.io/react-native/docs/modal.html
  * @gif: https://media.giphy.com/media/3oFzmfSX8KgvctI4Ks/giphy.gif
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ModalScreen.tsx
  */
diff --git a/src/components/picker/PickerItem.js b/src/components/picker/PickerItem.js
@@ -16,7 +16,7 @@ import PickerContext from './PickerContext';
 /**
  * @description: Picker.Item, for configuring the Picker's selectable options
  * @extends: TouchableOpacity
- * @extendslink: docs/TouchableOpacity
+ * @extendsLink: docs/TouchableOpacity
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/PickerScreen.js
  */
 const PickerItem = props => {
diff --git a/src/components/text/index.tsx b/src/components/text/index.tsx
@@ -47,8 +47,9 @@ type PropsTypes = BaseComponentInjectedProps & ForwardRefInjectedProps & TextPro
 /**
  * @description: A wrapper for Text component with extra functionality like modifiers support
  * @extends: Text
- * @extendslink: https://facebook.github.io/react-native/docs/text.html
+ * @extendsLink: https://facebook.github.io/react-native/docs/text.html
  * @modifiers: margins, color, typography
+ * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TextScreen.js
  */
 class Text extends PureComponent<PropsTypes> {
   static displayName = 'Text';
diff --git a/src/components/textArea/index.js b/src/components/textArea/index.js
@@ -6,7 +6,7 @@ import BaseInput from '../baseInput';
  * @description: a wrapper for Text Field component to create enclosed text area
  * @modifiers: Typography
  * @extends: TextField
- * @extendslink: https://github.com/wix/react-native-ui-lib/blob/master/src/components/textField/index.js
+ * @extendsLink: https://github.com/wix/react-native-ui-lib/blob/master/src/components/textField/index.js
  * @gif: https://media.giphy.com/media/3oFzmoU8TdfHeYZNZu/giphy.gif
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TextFieldScreen/InputsScreen.js
  */
diff --git a/src/components/textField/index.js b/src/components/textField/index.js
@@ -47,7 +47,7 @@ const FLOATING_PLACEHOLDER_SCALE = 0.875;
  * @description: A wrapper for TextInput component with extra functionality like floating placeholder and validations (This is an uncontrolled component)
  * @modifiers: Typography
  * @extends: TextInput
- * @extendslink: https://facebook.github.io/react-native/docs/textinput
+ * @extendsLink: https://facebook.github.io/react-native/docs/textinput
  * @gif: https://media.giphy.com/media/xULW8su8Cs5Z9Fq4PS/giphy.gif, https://media.giphy.com/media/3ohc1dhDcLS9FvWLJu/giphy.gif, https://media.giphy.com/media/oNUSOxnHdMP5ZnKYsh/giphy.gif
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TextFieldScreen/BasicTextFieldScreen.js
  */
diff --git a/src/components/touchableOpacity/index.tsx b/src/components/touchableOpacity/index.tsx
@@ -55,7 +55,7 @@ type Props = BaseComponentInjectedProps &
  * @description: A wrapper for TouchableOpacity component. Support onPress, throttling and activeBackgroundColor
  * @extends: TouchableOpacity
  * @modifiers: margins, paddings, alignments, background, borderRadius
- * @extendslink: https://facebook.github.io/react-native/docs/touchableopacity.html
+ * @extendsLink: https://facebook.github.io/react-native/docs/touchableopacity.html
  * @gif: https://media.giphy.com/media/xULW8AMIgw7l31zjm8/giphy.gif
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/src/components/touchableOpacity/index.tsx
  */
diff --git a/src/components/view/index.tsx b/src/components/view/index.tsx
@@ -57,7 +57,7 @@ interface ViewState {
 /**
  * @description: An enhanced View component
  * @extends: View
- * @extendslink: https://facebook.github.io/react-native/docs/view.html
+ * @extendsLink: https://facebook.github.io/react-native/docs/view.html
  * @modifiers: margins, paddings, alignments, background, borderRadius
  */
 class View extends PureComponent<PropsTypes, ViewState> {
diff --git a/src/incubator/TextField/index.tsx b/src/incubator/TextField/index.tsx
@@ -106,7 +106,7 @@ interface StaticMembers {
 /**
  * @description: A controlled, customizable TextField with validation support
  * @extends: TextInput
- * @extendslink: https://reactnative.dev/docs/textinput
+ * @extendsLink: https://reactnative.dev/docs/textinput
  * @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/incubatorScreens/IncubatorTextFieldScreen.tsx
  */
 const TextField = (props: InternalTextFieldProps) => {
diff --git a/uilib-docs/src/templates/component.js b/uilib-docs/src/templates/component.js
@@ -50,7 +50,7 @@ export default class ComponentTemplate extends Component {
 
       return (
         <span className="inline" key={component}>
-          {!extendedComponent && componentInfo.extendsLink ? (
+          {extendedComponent && componentInfo.extendsLink ? (
             <a href={componentInfo.extendsLink} rel="noopener noreferrer" target="_blank">
               {text}
             </a>
