Skip to content

Commit 702d7a7

Browse files
authored
Docs/fix broken urls (#1427)
* Push Wizard missed generated types * Fix broken links for docs * Fix TagsInput broken link
1 parent 3ebe272 commit 702d7a7

File tree

23 files changed

+18
-25
lines changed

23 files changed

+18
-25
lines changed

generatedTypes/components/connectionStatusBar/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export { ConnectionStatusBarProps };
44
/**
55
* @description: Top bar to show a "no internet" connection status. Note: Run on real device for best results
66
* @image: https://user-images.githubusercontent.com/33805983/34683190-f3b1904c-f4a9-11e7-9d46-9a340bd35448.png, https://user-images.githubusercontent.com/33805983/34484206-edc6c6e4-efcb-11e7-88b2-cd394c19dd5e.png
7-
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ConnectionStatusBarScreen.js
7+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ConnectionStatusBarScreen.tsx
88
* @notes: The component requires installing the '@react-native-community/netinfo' native library
99
*/
1010
declare class ConnectionStatusBar extends PureComponent<ConnectionStatusBarProps, ConnectionStatusBarState> {

generatedTypes/components/featureHighlight/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ interface State {
109109
* @important: FeatureHighlight uses a native library. You MUST add and link the native library to both iOS and Android projects. For instruction please see
110110
* @importantLink: https://facebook.github.io/react-native/docs/linking-libraries-ios.html
111111
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/FeatureHighlight/FeatureHighlight.gif?raw=true
112-
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/FeatureHighlightScreen.js
112+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/FeatureHighlightScreen.tsx
113113
*/
114114
declare class FeatureHighlight extends Component<FeatureHighlightProps, State> {
115115
static displayName: string;

generatedTypes/components/hint/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ interface HintState {
119119
}
120120
/**
121121
* @description: Hint component for displaying a tooltip over wrapped component
122-
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/HintsScreen.js
122+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/HintsScreen.tsx
123123
* @notes: You can either wrap a component or pass a specific targetFrame
124124
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/Hint/Hint.gif?raw=true
125125
*/

generatedTypes/components/skeletonView/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ interface SkeletonState {
9292
}
9393
/**
9494
* @description: Allows showing a temporary skeleton view while your real view is loading.
95-
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/SkeletonViewScreen.js
95+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/SkeletonViewScreen.tsx
9696
* @image: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/Skeleton/Skeleton.gif?raw=true
9797
* @notes: View requires installing the 'react-native-shimmer-placeholder' and 'react-native-linear-gradient' library
9898
*/

generatedTypes/components/tabBar/index.d.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@ interface State {
5656
* @modifiers: alignment, flex, padding, margin, background, typography, color (list of supported modifiers)
5757
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabBarScreen.tsx
5858
* @extends: ScrollBar
59-
* @extendsLink:https://github.com/wix/react-native-ui-lib/blob/master/src/components/scrollBar/index.js
6059
* @notes: This is screen width component.
6160
*/
6261
declare class TabBar extends Component<TabBarProps, State> {

markdowns/foundation/modifiers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,9 @@ Last type of modifiers are for styling your components
111111
```
112112

113113

114-
! all styling modifiers are based on our [`Colors` & `Typography` presets](https://github.com/wix/react-native-ui-lib/wiki/STYLE). <br>
114+
! all styling modifiers are based on our [`Colors` & `Typography` presets](/foundation/style). <br>
115115
You can load your own presets and use them as modifiers.
116116

117117

118118

119-
Check out [this example](./USAGE) where we use most of these props
119+
Check out [this example](/getting-started/usage) where we use most of these props

src/components/actionSheet/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ type ActionSheetProps = {
9898
/**
9999
* @description: Cross platform Action Sheet, with a support for native iOS solution
100100
* @gif: https://media.giphy.com/media/l0HUpXOR6RqB2ct5S/giphy.gif
101-
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ActionSheetScreen.js
101+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ActionSheetScreen.tsx
102102
*/
103103
class ActionSheet extends Component<ActionSheetProps> {
104104
static displayName = 'ActionSheet';

src/components/chipsInput/index.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ const GUTTER_SPACING = 8;
2424
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/ChipsInput/ChipsInput.gif?raw=true
2525
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ChipsInputScreen.js
2626
* @extends: TextField
27-
* @extendsLink: https://github.com/wix/react-native-ui-lib/blob/master/src/components/inputs/TextField.js
2827
*/
2928
class ChipsInput extends Component {
3029
static displayName = 'ChipsInput';

src/components/colorPicker/ColorPalette.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ const DEFAULT_NUMBER_OF_ROWS = 3;
7373

7474
/**
7575
* @description: A color palette component
76-
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ColorPickerScreen.js
76+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ColorPickerScreen.tsx
7777
* @notes: This is a screen width component
7878
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/ColorPalette/ColorPalette.gif?raw=true
7979
*/

src/components/colorPicker/ColorPickerDialog.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ const KEYBOARD_HEIGHT = 216;
6868
/**
6969
* @description: A color picker dialog component
7070
* @extends: Dialog
71-
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ColorPickerScreen.js
71+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ColorPickerScreen.tsx
7272
*/
7373
class ColorPickerDialog extends PureComponent<Props, State> {
7474
static displayName = 'ColorPicker';

src/components/colorPicker/ColorSwatch.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export const SWATCH_SIZE = DEFAULT_SIZE;
4444

4545
/**
4646
* @description: A color swatch component
47-
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ColorPickerScreen.js
47+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ColorPickerScreen.tsx
4848
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/ColorPalette/ColorPalette.gif?raw=true
4949
*/
5050
class ColorSwatch extends PureComponent<Props> {

src/components/colorPicker/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ const ACCESSIBILITY_LABELS = {
5656

5757
/**
5858
* @description: A color picker component
59-
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ColorPickerScreen.js
59+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ColorPickerScreen.tsx
6060
* @notes: This is a screen width component
6161
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/ColorPicker/ColorPicker.gif?raw=true
6262
*/

src/components/connectionStatusBar/Types.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export const DEFAULT_PROPS = {
3535
/**
3636
* @description: Top bar to show a "no internet" connection status. Note: Run on real device for best results
3737
* @image: https://user-images.githubusercontent.com/33805983/34683190-f3b1904c-f4a9-11e7-9d46-9a340bd35448.png, https://user-images.githubusercontent.com/33805983/34484206-edc6c6e4-efcb-11e7-88b2-cd394c19dd5e.png
38-
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ConnectionStatusBarScreen.js
38+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ConnectionStatusBarScreen.tsx
3939
* @notes: The component requires installing the '@react-native-community/netinfo' native library
4040
*/
4141
// @ts-ignore

src/components/connectionStatusBar/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export {ConnectionStatusBarProps};
1313
/**
1414
* @description: Top bar to show a "no internet" connection status. Note: Run on real device for best results
1515
* @image: https://user-images.githubusercontent.com/33805983/34683190-f3b1904c-f4a9-11e7-9d46-9a340bd35448.png, https://user-images.githubusercontent.com/33805983/34484206-edc6c6e4-efcb-11e7-88b2-cd394c19dd5e.png
16-
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ConnectionStatusBarScreen.js
16+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ConnectionStatusBarScreen.tsx
1717
* @notes: The component requires installing the '@react-native-community/netinfo' native library
1818
*/
1919
class ConnectionStatusBar extends PureComponent<ConnectionStatusBarProps, ConnectionStatusBarState> {

src/components/featureHighlight/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ interface State {
146146
* @important: FeatureHighlight uses a native library. You MUST add and link the native library to both iOS and Android projects. For instruction please see
147147
* @importantLink: https://facebook.github.io/react-native/docs/linking-libraries-ios.html
148148
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/FeatureHighlight/FeatureHighlight.gif?raw=true
149-
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/FeatureHighlightScreen.js
149+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/FeatureHighlightScreen.tsx
150150
*/
151151
/*eslint-enable*/
152152
class FeatureHighlight extends Component<FeatureHighlightProps, State> {

src/components/floatingButton/index.tsx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,6 @@ const gradientImage = () => require('./gradient.png');
5151
* @description: Hovering button with gradient background
5252
* @modifiers: margin, background, color
5353
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/FloatingButtonScreen.tsx
54-
* @extends: Button
55-
* @extendsLink: https://github.com/wix/react-native-ui-lib/blob/master/src/components/button/index.js
5654
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/FloatingButton/FloatingButton.gif?raw=true
5755
*/
5856
class FloatingButton extends PureComponent<FloatingButtonProps> {

src/components/hint/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ interface HintState {
159159

160160
/**
161161
* @description: Hint component for displaying a tooltip over wrapped component
162-
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/HintsScreen.js
162+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/HintsScreen.tsx
163163
* @notes: You can either wrap a component or pass a specific targetFrame
164164
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/Hint/Hint.gif?raw=true
165165
*/

src/components/progressBar/index.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ import {Colors} from '../../style';
1111
* @gif:https://media.giphy.com/media/3o752o08oY0oCvOxR6/giphy.gif
1212
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ProgressBarScreen.js
1313
* @extends: AnimatedScanner
14-
* @extendsLink: https://wix-private.github.io/wix-react-native-ui-lib/docs/public/AnimatedScanner/
1514
*/
1615
export default class ProgressBar extends BaseComponent {
1716
static displayName = 'ProgressBar';

src/components/skeletonView/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ interface SkeletonState {
111111

112112
/**
113113
* @description: Allows showing a temporary skeleton view while your real view is loading.
114-
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/SkeletonViewScreen.js
114+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/SkeletonViewScreen.tsx
115115
* @image: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/Skeleton/Skeleton.gif?raw=true
116116
* @notes: View requires installing the 'react-native-shimmer-placeholder' and 'react-native-linear-gradient' library
117117
*/

src/components/stackAggregator/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ type State = {
6666
/**
6767
* @description: Stack aggregator component
6868
* @modifiers: margin, padding
69-
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/StackAggregatorScreen.js
69+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/StackAggregatorScreen.tsx
7070
*/
7171
class StackAggregator extends PureComponent<StackAggregatorProps, State> {
7272
static displayName = 'StackAggregator';

src/components/tabBar/index.tsx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,6 @@ interface State {
6969
* @modifiers: alignment, flex, padding, margin, background, typography, color (list of supported modifiers)
7070
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabBarScreen.tsx
7171
* @extends: ScrollBar
72-
* @extendsLink:https://github.com/wix/react-native-ui-lib/blob/master/src/components/scrollBar/index.js
7372
* @notes: This is screen width component.
7473
*/
7574
class TabBar extends Component<TabBarProps, State> {

src/components/tagsInput/index.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ const GUTTER_SPACING = 8;
2424
* @gif: https://camo.githubusercontent.com/9c2671024f60566b980638ea01b517f6fb509d0b/68747470733a2f2f6d656469612e67697068792e636f6d2f6d656469612f336f45686e374a79685431566658746963452f67697068792e676966
2525
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ChipsInputScreen.js
2626
* @extends: TextField
27-
* @extendsLink: https://github.com/wix/react-native-ui-lib/blob/master/src/components/inputs/TextField.js
2827
*/
2928
export default class TagsInput extends BaseComponent {
3029
static displayName = 'TagsInput';

src/components/wizard/WizardStep.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ interface Props extends WizardStepProps, Omit<WizardProps, 'onActiveIndexChanged
2323
* @description: WizardStep Component: a wizard presents a series of steps in prescribed order
2424
* that the user needs to complete in order to accomplish a goal (e.g. purchase a product).
2525
*
26-
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/WizardScreen.js
26+
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/WizardScreen.tsx
2727
* @notes: Use Wizard with nested Wizard.Step(s) to achieve the desired result.
2828
*/
2929
class WizardStep extends Component<Props> {

0 commit comments

Comments
 (0)