Skip to content

Docs/fix broken urls #1427

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.

Sign up for GitHub

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 4 commits into from
Jul 26, 2021
Merged

Docs/fix broken urls #1427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c8de13f
Push Wizard missed generated types
ethanshar Jul 25, 2021
27c45d8
Fix broken links for docs
ethanshar Jul 25, 2021
a4a6884
Fix TagsInput broken link
ethanshar Jul 25, 2021
5136e73
Merge branch 'master' into docs/fixBrokenURLs
ethanshar Jul 26, 2021
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/connectionStatusBar/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ export { ConnectionStatusBarProps };
/**
* @description: Top bar to show a "no internet" connection status. Note: Run on real device for best results
* @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
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ConnectionStatusBarScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ConnectionStatusBarScreen.tsx
* @notes: The component requires installing the '@react-native-community/netinfo' native library
*/
declare class ConnectionStatusBar extends PureComponent<ConnectionStatusBarProps, ConnectionStatusBarState> {
Expand Down
2 changes: 1 addition & 1 deletion generatedTypes/components/featureHighlight/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ interface State {
* @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
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/FeatureHighlight/FeatureHighlight.gif?raw=true
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/FeatureHighlightScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/FeatureHighlightScreen.tsx
*/
declare class FeatureHighlight extends Component<FeatureHighlightProps, State> {
static displayName: string;
Expand Down
2 changes: 1 addition & 1 deletion generatedTypes/components/hint/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ interface HintState {
}
/**
* @description: Hint component for displaying a tooltip over wrapped component
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/HintsScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/HintsScreen.tsx
* @notes: You can either wrap a component or pass a specific targetFrame
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/Hint/Hint.gif?raw=true
*/
Expand Down
2 changes: 1 addition & 1 deletion generatedTypes/components/skeletonView/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ interface SkeletonState {
}
/**
* @description: Allows showing a temporary skeleton view while your real view is loading.
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/SkeletonViewScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/SkeletonViewScreen.tsx
* @image: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/Skeleton/Skeleton.gif?raw=true
* @notes: View requires installing the 'react-native-shimmer-placeholder' and 'react-native-linear-gradient' library
*/
Expand Down
1 change: 0 additions & 1 deletion generatedTypes/components/tabBar/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ interface State {
* @modifiers: alignment, flex, padding, margin, background, typography, color (list of supported modifiers)
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabBarScreen.tsx
* @extends: ScrollBar
* @extendsLink:https://github.com/wix/react-native-ui-lib/blob/master/src/components/scrollBar/index.js
* @notes: This is screen width component.
*/
declare class TabBar extends Component<TabBarProps, State> {
Expand Down
4 changes: 2 additions & 2 deletions markdowns/foundation/modifiers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,9 @@ Last type of modifiers are for styling your components
```


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



Check out [this example](./USAGE) where we use most of these props
Check out [this example](/getting-started/usage) where we use most of these props
2 changes: 1 addition & 1 deletion src/components/actionSheet/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ type ActionSheetProps = {
/**
* @description: Cross platform Action Sheet, with a support for native iOS solution
* @gif: https://media.giphy.com/media/l0HUpXOR6RqB2ct5S/giphy.gif
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ActionSheetScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ActionSheetScreen.tsx
*/
class ActionSheet extends Component<ActionSheetProps> {
static displayName = 'ActionSheet';
Expand Down
1 change: 0 additions & 1 deletion src/components/chipsInput/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ const GUTTER_SPACING = 8;
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/ChipsInput/ChipsInput.gif?raw=true
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ChipsInputScreen.js
* @extends: TextField
* @extendsLink: https://github.com/wix/react-native-ui-lib/blob/master/src/components/inputs/TextField.js
*/
class ChipsInput extends Component {
static displayName = 'ChipsInput';
Expand Down
2 changes: 1 addition & 1 deletion src/components/colorPicker/ColorPalette.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ const DEFAULT_NUMBER_OF_ROWS = 3;

/**
* @description: A color palette component
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ColorPickerScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ColorPickerScreen.tsx
* @notes: This is a screen width component
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/ColorPalette/ColorPalette.gif?raw=true
*/
Expand Down
2 changes: 1 addition & 1 deletion src/components/colorPicker/ColorPickerDialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ const KEYBOARD_HEIGHT = 216;
/**
* @description: A color picker dialog component
* @extends: Dialog
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ColorPickerScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ColorPickerScreen.tsx
*/
class ColorPickerDialog extends PureComponent<Props, State> {
static displayName = 'ColorPicker';
Expand Down
2 changes: 1 addition & 1 deletion src/components/colorPicker/ColorSwatch.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export const SWATCH_SIZE = DEFAULT_SIZE;

/**
* @description: A color swatch component
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ColorPickerScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ColorPickerScreen.tsx
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/ColorPalette/ColorPalette.gif?raw=true
*/
class ColorSwatch extends PureComponent<Props> {
Expand Down
2 changes: 1 addition & 1 deletion src/components/colorPicker/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ const ACCESSIBILITY_LABELS = {

/**
* @description: A color picker component
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ColorPickerScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ColorPickerScreen.tsx
* @notes: This is a screen width component
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/ColorPicker/ColorPicker.gif?raw=true
*/
Expand Down
2 changes: 1 addition & 1 deletion src/components/connectionStatusBar/Types.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const DEFAULT_PROPS = {
/**
* @description: Top bar to show a "no internet" connection status. Note: Run on real device for best results
* @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
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ConnectionStatusBarScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ConnectionStatusBarScreen.tsx
* @notes: The component requires installing the '@react-native-community/netinfo' native library
*/
// @ts-ignore
Expand Down
2 changes: 1 addition & 1 deletion src/components/connectionStatusBar/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export {ConnectionStatusBarProps};
/**
* @description: Top bar to show a "no internet" connection status. Note: Run on real device for best results
* @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
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ConnectionStatusBarScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ConnectionStatusBarScreen.tsx
* @notes: The component requires installing the '@react-native-community/netinfo' native library
*/
class ConnectionStatusBar extends PureComponent<ConnectionStatusBarProps, ConnectionStatusBarState> {
Expand Down
2 changes: 1 addition & 1 deletion src/components/featureHighlight/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ interface State {
* @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
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/FeatureHighlight/FeatureHighlight.gif?raw=true
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/FeatureHighlightScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/FeatureHighlightScreen.tsx
*/
/*eslint-enable*/
class FeatureHighlight extends Component<FeatureHighlightProps, State> {
Expand Down
2 changes: 0 additions & 2 deletions src/components/floatingButton/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@ const gradientImage = () => require('./gradient.png');
* @description: Hovering button with gradient background
* @modifiers: margin, background, color
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/FloatingButtonScreen.tsx
* @extends: Button
* @extendsLink: https://github.com/wix/react-native-ui-lib/blob/master/src/components/button/index.js
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/FloatingButton/FloatingButton.gif?raw=true
*/
class FloatingButton extends PureComponent<FloatingButtonProps> {
Expand Down
2 changes: 1 addition & 1 deletion src/components/hint/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ interface HintState {

/**
* @description: Hint component for displaying a tooltip over wrapped component
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/HintsScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/HintsScreen.tsx
* @notes: You can either wrap a component or pass a specific targetFrame
* @gif: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/Hint/Hint.gif?raw=true
*/
Expand Down
1 change: 0 additions & 1 deletion src/components/progressBar/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import {Colors} from '../../style';
* @gif:https://media.giphy.com/media/3o752o08oY0oCvOxR6/giphy.gif
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ProgressBarScreen.js
* @extends: AnimatedScanner
* @extendsLink: https://wix-private.github.io/wix-react-native-ui-lib/docs/public/AnimatedScanner/
*/
export default class ProgressBar extends BaseComponent {
static displayName = 'ProgressBar';
Expand Down
2 changes: 1 addition & 1 deletion src/components/skeletonView/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ interface SkeletonState {

/**
* @description: Allows showing a temporary skeleton view while your real view is loading.
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/SkeletonViewScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/SkeletonViewScreen.tsx
* @image: https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/Skeleton/Skeleton.gif?raw=true
* @notes: View requires installing the 'react-native-shimmer-placeholder' and 'react-native-linear-gradient' library
*/
Expand Down
2 changes: 1 addition & 1 deletion src/components/stackAggregator/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ type State = {
/**
* @description: Stack aggregator component
* @modifiers: margin, padding
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/StackAggregatorScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/StackAggregatorScreen.tsx
*/
class StackAggregator extends PureComponent<StackAggregatorProps, State> {
static displayName = 'StackAggregator';
Expand Down
1 change: 0 additions & 1 deletion src/components/tabBar/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ interface State {
* @modifiers: alignment, flex, padding, margin, background, typography, color (list of supported modifiers)
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TabBarScreen.tsx
* @extends: ScrollBar
* @extendsLink:https://github.com/wix/react-native-ui-lib/blob/master/src/components/scrollBar/index.js
* @notes: This is screen width component.
*/
class TabBar extends Component<TabBarProps, State> {
Expand Down
1 change: 0 additions & 1 deletion src/components/tagsInput/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ const GUTTER_SPACING = 8;
* @gif: https://camo.githubusercontent.com/9c2671024f60566b980638ea01b517f6fb509d0b/68747470733a2f2f6d656469612e67697068792e636f6d2f6d656469612f336f45686e374a79685431566658746963452f67697068792e676966
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ChipsInputScreen.js
* @extends: TextField
* @extendsLink: https://github.com/wix/react-native-ui-lib/blob/master/src/components/inputs/TextField.js
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see you've removed some links instead of replacing them, why?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cause our docs internally knows to refer to other components by their name.
In this case, TagsInput is based on our TextField component, so the name is enough.
The TextField component will have an external link (@extendsLink) that directs to RN's TextInput component

*/
export default class TagsInput extends BaseComponent {
static displayName = 'TagsInput';
Expand Down
2 changes: 1 addition & 1 deletion src/components/wizard/WizardStep.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ interface Props extends WizardStepProps, Omit<WizardProps, 'onActiveIndexChanged
* @description: WizardStep Component: a wizard presents a series of steps in prescribed order
* that the user needs to complete in order to accomplish a goal (e.g. purchase a product).
*
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/WizardScreen.js
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/WizardScreen.tsx
* @notes: Use Wizard with nested Wizard.Step(s) to achieve the desired result.
*/
class WizardStep extends Component<Props> {
Expand Down