Skip to content

Commit 5af4d65

Browse files
authored
Fix/docs extends link (#1237)
* fix docs extends link logic * fix extends link name + added example for Text
1 parent f3bdb18 commit 5af4d65

File tree

23 files changed

+24
-23
lines changed

23 files changed

+24
-23
lines changed

generatedTypes/components/avatar/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ export declare type AvatarPropTypes = AvatarProps;
113113
* @description: Avatar component for displaying user profile images
114114
* @extends: TouchableOpacity
115115
* @extendsnotes: (when passing onPress)
116-
* @extendslink: docs/TouchableOpacity
116+
* @extendsLink: docs/TouchableOpacity
117117
* @image: https://user-images.githubusercontent.com/33805983/34480603-197d7f64-efb6-11e7-9feb-db8ba756f055.png
118118
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/AvatarsScreen.tsx
119119
*/

generatedTypes/components/badge/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ export declare type BadgeProps = ViewProps & TouchableOpacityProps & {
8484
/**
8585
* @description: Round colored badge, typically used to show a number
8686
* @extends: Animatable.View
87-
* @extendslink: https://github.com/oblador/react-native-animatable
87+
* @extendsLink: https://github.com/oblador/react-native-animatable
8888
* @image: https://user-images.githubusercontent.com/33805983/34480753-df7a868a-efb6-11e7-9072-80f5c110a4f3.png
8989
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/BadgesScreen.tsx
9090
*/

generatedTypes/components/image/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ declare type State = {
5757
/**
5858
* @description: Image wrapper with extra functionality like source transform and assets support
5959
* @extends: Image
60-
* @extendslink: https://facebook.github.io/react-native/docs/image.html
60+
* @extendsLink: https://facebook.github.io/react-native/docs/image.html
6161
*/
6262
declare class Image extends PureComponent<Props, State> {
6363
static displayName: string;

generatedTypes/components/modal/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface ModalProps extends RNModalProps {
3232
/**
3333
* @description: Component that present content on top of the invoking screen
3434
* @extends: Modal
35-
* @extendslink: https://facebook.github.io/react-native/docs/modal.html
35+
* @extendsLink: https://facebook.github.io/react-native/docs/modal.html
3636
* @gif: https://media.giphy.com/media/3oFzmfSX8KgvctI4Ks/giphy.gif
3737
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ModalScreen.tsx
3838
*/

generatedTypes/components/text/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ declare type PropsTypes = BaseComponentInjectedProps & ForwardRefInjectedProps &
3333
/**
3434
* @description: A wrapper for Text component with extra functionality like modifiers support
3535
* @extends: Text
36-
* @extendslink: https://facebook.github.io/react-native/docs/text.html
36+
* @extendsLink: https://facebook.github.io/react-native/docs/text.html
3737
* @modifiers: margins, color, typography
3838
*/
3939
declare class Text extends PureComponent<PropsTypes> {

src/components/avatar/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ export type AvatarPropTypes = AvatarProps; //TODO: remove after ComponentPropTyp
144144
* @description: Avatar component for displaying user profile images
145145
* @extends: TouchableOpacity
146146
* @extendsnotes: (when passing onPress)
147-
* @extendslink: docs/TouchableOpacity
147+
* @extendsLink: docs/TouchableOpacity
148148
* @image: https://user-images.githubusercontent.com/33805983/34480603-197d7f64-efb6-11e7-9feb-db8ba756f055.png
149149
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/AvatarsScreen.tsx
150150
*/

src/components/badge/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ export type BadgeProps = ViewProps &
109109
/**
110110
* @description: Round colored badge, typically used to show a number
111111
* @extends: Animatable.View
112-
* @extendslink: https://github.com/oblador/react-native-animatable
112+
* @extendsLink: https://github.com/oblador/react-native-animatable
113113
* @image: https://user-images.githubusercontent.com/33805983/34480753-df7a868a-efb6-11e7-9072-80f5c110a4f3.png
114114
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/BadgesScreen.tsx
115115
*/

src/components/button/ButtonTypes.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ export const DEFAULT_PROPS = {
158158
/**
159159
* @description: Basic button component
160160
* @extends: TouchableOpacity
161-
* @extendslink: docs/TouchableOpacity
161+
* @extendsLink: docs/TouchableOpacity
162162
* @modifiers: margin, background
163163
* @gif: https://media.giphy.com/media/xULW8j5WzsuPytqklq/giphy.gif
164164
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ButtonsScreen.tsx

src/components/card/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ type State = {
107107
* @description: Card component
108108
* @extends: TouchableOpacity
109109
* @extendsnotes: (Touchable when passing onPress)
110-
* @extendslink: docs/TouchableOpacity
110+
* @extendsLink: docs/TouchableOpacity
111111
* @modifiers: margin, padding
112112
* @gif: https://media.giphy.com/media/l0HU9SKWmv0VTOYMM/giphy.gif
113113
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/CardsScreen.tsx

src/components/checkbox/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ interface CheckboxState {
8989
/**
9090
* @description: Checkbox component for toggling boolean value related to some context
9191
* @extends: TouchableOpacity
92-
* @extendslink: docs/TouchableOpacity
92+
* @extendsLink: docs/TouchableOpacity
9393
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/CheckboxScreen.tsx
9494
*/
9595
class Checkbox extends Component<CheckboxProps, CheckboxState> {

src/components/chip/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ export type ChipPropTypes = ChipProps; //TODO: remove after ComponentPropTypes d
118118
/**
119119
* @description: Chip component
120120
* @extends: TouchableOpacity
121-
* @extendslink: docs/TouchableOpacity
121+
* @extendsLink: docs/TouchableOpacity
122122
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ChipScreen.tsx
123123
*/
124124
const Chip = ({

src/components/featureHighlight/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ const contentViewHeight = Constants.isAndroid ? 268 : 282;
3030
* @important: FeatureHighlight uses a native library. You MUST add and link the native library to both iOS and Android projects. For instruction please see
3131
* @importantLink: https://facebook.github.io/react-native/docs/linking-libraries-ios.html
3232
* @extends: HighlighterOverlayView
33-
* @extendslink: docs/HighlighterOverlayView
33+
* @extendsLink: docs/HighlighterOverlayView
3434
* @gif: https://media.giphy.com/media/3ohs4D5irZm5GojsDS/giphy.gif, https://media.giphy.com/media/3oxQNaDQckPZI78rWo/giphy.gif
3535
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/FeatureHighlightScreen.js
3636
*/

src/components/image/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ type State = {
7676
/**
7777
* @description: Image wrapper with extra functionality like source transform and assets support
7878
* @extends: Image
79-
* @extendslink: https://facebook.github.io/react-native/docs/image.html
79+
* @extendsLink: https://facebook.github.io/react-native/docs/image.html
8080
*/
8181
class Image extends PureComponent<Props, State> {
8282
static displayName = 'Image';

src/components/listItem/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import ListItemPart from './ListItemPart';
1010
/**
1111
* @description: List item component to render inside a List component
1212
* @extends: TouchableOpacity
13-
* @extendslink: docs/TouchableOpacity
13+
* @extendsLink: docs/TouchableOpacity
1414
* @gif: https://media.giphy.com/media/l1IBjHowyPcOTWAY8/giphy.gif
1515
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/BasicListScreen.js
1616
*/

src/components/modal/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export interface ModalProps extends RNModalProps {
4141
/**
4242
* @description: Component that present content on top of the invoking screen
4343
* @extends: Modal
44-
* @extendslink: https://facebook.github.io/react-native/docs/modal.html
44+
* @extendsLink: https://facebook.github.io/react-native/docs/modal.html
4545
* @gif: https://media.giphy.com/media/3oFzmfSX8KgvctI4Ks/giphy.gif
4646
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ModalScreen.tsx
4747
*/

src/components/picker/PickerItem.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import PickerContext from './PickerContext';
1616
/**
1717
* @description: Picker.Item, for configuring the Picker's selectable options
1818
* @extends: TouchableOpacity
19-
* @extendslink: docs/TouchableOpacity
19+
* @extendsLink: docs/TouchableOpacity
2020
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/PickerScreen.js
2121
*/
2222
const PickerItem = props => {

src/components/text/index.tsx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,9 @@ type PropsTypes = BaseComponentInjectedProps & ForwardRefInjectedProps & TextPro
4747
/**
4848
* @description: A wrapper for Text component with extra functionality like modifiers support
4949
* @extends: Text
50-
* @extendslink: https://facebook.github.io/react-native/docs/text.html
50+
* @extendsLink: https://facebook.github.io/react-native/docs/text.html
5151
* @modifiers: margins, color, typography
52+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TextScreen.js
5253
*/
5354
class Text extends PureComponent<PropsTypes> {
5455
static displayName = 'Text';

src/components/textArea/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import BaseInput from '../baseInput';
66
* @description: a wrapper for Text Field component to create enclosed text area
77
* @modifiers: Typography
88
* @extends: TextField
9-
* @extendslink: https://github.com/wix/react-native-ui-lib/blob/master/src/components/textField/index.js
9+
* @extendsLink: https://github.com/wix/react-native-ui-lib/blob/master/src/components/textField/index.js
1010
* @gif: https://media.giphy.com/media/3oFzmoU8TdfHeYZNZu/giphy.gif
1111
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TextFieldScreen/InputsScreen.js
1212
*/

src/components/textField/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ const FLOATING_PLACEHOLDER_SCALE = 0.875;
4747
* @description: A wrapper for TextInput component with extra functionality like floating placeholder and validations (This is an uncontrolled component)
4848
* @modifiers: Typography
4949
* @extends: TextInput
50-
* @extendslink: https://facebook.github.io/react-native/docs/textinput
50+
* @extendsLink: https://facebook.github.io/react-native/docs/textinput
5151
* @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
5252
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TextFieldScreen/BasicTextFieldScreen.js
5353
*/

src/components/touchableOpacity/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ type Props = BaseComponentInjectedProps &
5555
* @description: A wrapper for TouchableOpacity component. Support onPress, throttling and activeBackgroundColor
5656
* @extends: TouchableOpacity
5757
* @modifiers: margins, paddings, alignments, background, borderRadius
58-
* @extendslink: https://facebook.github.io/react-native/docs/touchableopacity.html
58+
* @extendsLink: https://facebook.github.io/react-native/docs/touchableopacity.html
5959
* @gif: https://media.giphy.com/media/xULW8AMIgw7l31zjm8/giphy.gif
6060
* @example: https://github.com/wix/react-native-ui-lib/blob/master/src/components/touchableOpacity/index.tsx
6161
*/

src/components/view/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ interface ViewState {
5757
/**
5858
* @description: An enhanced View component
5959
* @extends: View
60-
* @extendslink: https://facebook.github.io/react-native/docs/view.html
60+
* @extendsLink: https://facebook.github.io/react-native/docs/view.html
6161
* @modifiers: margins, paddings, alignments, background, borderRadius
6262
*/
6363
class View extends PureComponent<PropsTypes, ViewState> {

src/incubator/TextField/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ interface StaticMembers {
106106
/**
107107
* @description: A controlled, customizable TextField with validation support
108108
* @extends: TextInput
109-
* @extendslink: https://reactnative.dev/docs/textinput
109+
* @extendsLink: https://reactnative.dev/docs/textinput
110110
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/incubatorScreens/IncubatorTextFieldScreen.tsx
111111
*/
112112
const TextField = (props: InternalTextFieldProps) => {

uilib-docs/src/templates/component.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ export default class ComponentTemplate extends Component {
5050

5151
return (
5252
<span className="inline" key={component}>
53-
{!extendedComponent && componentInfo.extendsLink ? (
53+
{extendedComponent && componentInfo.extendsLink ? (
5454
<a href={componentInfo.extendsLink} rel="noopener noreferrer" target="_blank">
5555
{text}
5656
</a>

0 commit comments

Comments
 (0)