Skip to content

Fix/docs extends link #1237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion generatedTypes/components/avatar/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion generatedTypes/components/badge/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion generatedTypes/components/image/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion generatedTypes/components/modal/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion generatedTypes/components/text/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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> {
Expand Down
2 changes: 1 addition & 1 deletion src/components/avatar/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion src/components/badge/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion src/components/button/ButtonTypes.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/components/card/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/components/checkbox/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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> {
Expand Down
2 changes: 1 addition & 1 deletion src/components/chip/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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 = ({
Expand Down
2 changes: 1 addition & 1 deletion src/components/featureHighlight/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion src/components/image/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down
2 changes: 1 addition & 1 deletion src/components/listItem/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion src/components/modal/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion src/components/picker/PickerItem.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 => {
Expand Down
3 changes: 2 additions & 1 deletion src/components/text/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down
2 changes: 1 addition & 1 deletion src/components/textArea/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion src/components/textField/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion src/components/touchableOpacity/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion src/components/view/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,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> {
Expand Down
2 changes: 1 addition & 1 deletion src/incubator/TextField/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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) => {
Expand Down
2 changes: 1 addition & 1 deletion uilib-docs/src/templates/component.js
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down